fsfw/datapool/DataSetIF.h

43 lines
996 B
C
Raw Normal View History

/**
* \file DataSetIF.h
*
* \brief This file contains the small interface to access the DataSet class.
*
* \date 10/23/2012
*
* \author Bastian Baetz
*
*/
#ifndef DATASETIF_H_
#define DATASETIF_H_
#include <framework/osal/OSAL.h>
class PoolVariableIF;
/**
* \brief This class defines a small interface to register on a DataSet.
*
* \details Currently, the only purpose of this interface is to provide a method for locally
* checked-out variables to register on a data set. Still, it may become useful for
* other purposes as well.
*
* \ingroup data_pool
*/
class DataSetIF {
public:
/**
* \brief This is an empty virtual destructor, as it is proposed for C++ interfaces.
*/
virtual ~DataSetIF() {}
/**
* \brief This operation provides a method to register local data pool variables
* to register in a data set by passing itself to this DataSet operation.
*/
virtual void registerVariable( PoolVariableIF* variable ) = 0;
};
#endif /* DATASETIF_H_ */