Gromacs  2016.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions
gmx::AnalysisDataModuleParallel Class Referenceabstract

#include <gromacs/analysisdata/datamodule.h>

+ Inheritance diagram for gmx::AnalysisDataModuleParallel:
+ Collaboration diagram for gmx::AnalysisDataModuleParallel:

Description

Convenience base class for parallel analysis data modules.

Implements the dataStarted() method such that initialization is always done in parallelDataStarted(). dataStarted() calls are forwarded to parallelDataStarted() using a dummy serial AnalysisDataParallelOptions.

Public Types

enum  Flag {
  efAllowMultipoint = 1<<0, efOnlyMultipoint = 1<<1, efAllowMulticolumn = 1<<2, efAllowMissing = 1<<3,
  efAllowMultipleDataSets = 1<<4
}
 Possible flags for flags(). More...
 

Public Member Functions

virtual int flags () const =0
 Returns properties supported by the module. More...
 
virtual bool parallelDataStarted (AbstractAnalysisData *data, const AnalysisDataParallelOptions &options)=0
 Called (once) for parallel data when the data has been set up. More...
 
virtual void frameStarted (const AnalysisDataFrameHeader &frame)=0
 Called at the start of each data frame. More...
 
virtual void pointsAdded (const AnalysisDataPointSetRef &points)=0
 Called one or more times during each data frame. More...
 
virtual void frameFinished (const AnalysisDataFrameHeader &header)=0
 Called when a data frame is finished. More...
 
virtual void frameFinishedSerial (int index)=0
 Called in sequential order for each frame after they are finished. More...
 
virtual void dataFinished ()=0
 Called (once) when no more data is available. More...
 

Member Enumeration Documentation

Possible flags for flags().

Enumerator
efAllowMultipoint 

The module can process multipoint data.

efOnlyMultipoint 

The module does not make sense for non-multipoint data.

efAllowMulticolumn 

The module can process data with more than one column.

efAllowMissing 

The module can process data with missing points.

efAllowMultipleDataSets 

The module can process data with multiple data sets.

Member Function Documentation

virtual void gmx::AnalysisDataModuleParallel::dataFinished ( )
pure virtual

Called (once) when no more data is available.

Exceptions
unspecifiedCan throw any exception required by the implementing class to report errors.

Implements gmx::IAnalysisDataModule.

Implemented in gmx::AnalysisDataWeightedHistogramModule, and gmx::AnalysisDataSimpleHistogramModule.

virtual int gmx::AnalysisDataModuleParallel::flags ( ) const
pure virtual

Returns properties supported by the module.

The return value of this method should not change after the module has been added to a data (this responsibility can, and in most cases must, be delegated to the user of the module).

The purpose of this method is to remove the need for common checks for data compatibility in the classes that implement the interface. Instead, AbstractAnalysisData performs these checks based on the flags provided.

Does not throw.

Implements gmx::IAnalysisDataModule.

Implemented in gmx::AnalysisDataWeightedHistogramModule, and gmx::AnalysisDataSimpleHistogramModule.

virtual void gmx::AnalysisDataModuleParallel::frameFinished ( const AnalysisDataFrameHeader header)
pure virtual

Called when a data frame is finished.

Parameters
[in]headerHeader information for the frame that is ending.
Exceptions
unspecifiedCan throw any exception required by the implementing class to report errors.

Implements gmx::IAnalysisDataModule.

Implemented in gmx::AnalysisDataWeightedHistogramModule, and gmx::AnalysisDataSimpleHistogramModule.

virtual void gmx::AnalysisDataModuleParallel::frameFinishedSerial ( int  frameIndex)
pure virtual

Called in sequential order for each frame after they are finished.

Parameters
[in]frameIndexIndex of the next finished frame.
Exceptions
unspecifiedCan throw any exception required by the implementing class to report errors.

This method is called after frameFinished(), but with an additional constraint that it is always called in serial and with an increasing frameIndex. Parallel data modules need this to serialize their data for downsteam serial modules; AnalysisDataModuleSerial provides an empty implementation, as there frameFinished() can be used for the same purpose.

Implements gmx::IAnalysisDataModule.

Implemented in gmx::AnalysisDataWeightedHistogramModule, and gmx::AnalysisDataSimpleHistogramModule.

virtual void gmx::AnalysisDataModuleParallel::frameStarted ( const AnalysisDataFrameHeader frame)
pure virtual

Called at the start of each data frame.

Parameters
[in]frameHeader information for the frame that is starting.
Exceptions
unspecifiedCan throw any exception required by the implementing class to report errors.

Implements gmx::IAnalysisDataModule.

Implemented in gmx::AnalysisDataWeightedHistogramModule, and gmx::AnalysisDataSimpleHistogramModule.

virtual bool gmx::AnalysisDataModuleParallel::parallelDataStarted ( AbstractAnalysisData data,
const AnalysisDataParallelOptions options 
)
pure virtual

Called (once) for parallel data when the data has been set up.

Parameters
[in]dataData object to which the module is added.
[in]optionsParallelization properties of the input data.
Returns
true if the module can process the input in non-sequential order.
Exceptions
APIErrorif the provided data is not compatible.
unspecifiedCan throw any exception required by the implementing class to report errors.

This method is called instead of dataStarted() if the input data has the capability to present data in non-sequential order. If the method returns true, then the module accepts this and frame notification methods may be called in that non-sequential order. If the method returns false, then the frame notification methods are called in sequential order, as if dataStarted() had been called.

See dataStarted() for general information on initializing the data. That applies to this method as well, with the exception that calling AbstractAnalysisData::requestStorage() is currently not very well supported (or rather, accessing the requested storage doesn't work).

Implements gmx::IAnalysisDataModule.

Implemented in gmx::AnalysisDataWeightedHistogramModule, and gmx::AnalysisDataSimpleHistogramModule.

virtual void gmx::AnalysisDataModuleParallel::pointsAdded ( const AnalysisDataPointSetRef points)
pure virtual

Called one or more times during each data frame.

Parameters
[in]pointsSet of points added (also provides access to frame-level data).
Exceptions
APIErrorif the provided data is not compatible.
unspecifiedCan throw any exception required by the implementing class to report errors.

Can be called once or multiple times for a frame. For all data objects currently implemented in the library (and all objects that will use AnalysisDataStorage for internal implementation), it is called exactly once for each frame if the data is not multipoint, but currently this restriction is not enforced.

Implements gmx::IAnalysisDataModule.

Implemented in gmx::AnalysisDataWeightedHistogramModule, and gmx::AnalysisDataSimpleHistogramModule.


The documentation for this class was generated from the following files: