40 lines
961 B
C
40 lines
961 B
C
|
/**
|
||
|
|
* \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_
|
||
|
|
|
||
|
|
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_ */
|