Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::anonymous_namespace{analysismodule.cpp}::TrajectoryAnalysisModuleDataBasic Class Reference
+ Inheritance diagram for gmx::anonymous_namespace{analysismodule.cpp}::TrajectoryAnalysisModuleDataBasic:
+ Collaboration diagram for gmx::anonymous_namespace{analysismodule.cpp}::TrajectoryAnalysisModuleDataBasic:

Description

Basic thread-local trajectory analysis data storage class.

Most simple tools should only require data handles and selections to be thread-local, so this class implements just that.

Public Member Functions

 TrajectoryAnalysisModuleDataBasic (TrajectoryAnalysisModule *module, const AnalysisDataParallelOptions &opt, const SelectionCollection &selections)
 Initializes thread-local storage for data handles and selections. More...
 
void finish () override
 Performs any finishing actions after all frames have been processed. More...
 
- Public Member Functions inherited from gmx::TrajectoryAnalysisModuleData
AnalysisDataHandle dataHandle (const AnalysisData &data)
 Returns a data handle for a given dataset. More...
 
Selection parallelSelection (const Selection &selection)
 Returns a selection that corresponds to the given selection. More...
 
SelectionList parallelSelections (const SelectionList &selections)
 Returns a set of selection that corresponds to the given selections. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gmx::TrajectoryAnalysisModuleData
 TrajectoryAnalysisModuleData (TrajectoryAnalysisModule *module, const AnalysisDataParallelOptions &opt, const SelectionCollection &selections)
 Initializes thread-local storage for data handles and selections. More...
 
void finishDataHandles ()
 Calls finishData() on all data handles. More...
 

Constructor & Destructor Documentation

gmx::anonymous_namespace{analysismodule.cpp}::TrajectoryAnalysisModuleDataBasic::TrajectoryAnalysisModuleDataBasic ( TrajectoryAnalysisModule module,
const AnalysisDataParallelOptions opt,
const SelectionCollection selections 
)

Initializes thread-local storage for data handles and selections.

Parameters
[in]moduleAnalysis module to use for data objects.
[in]optData parallelization options.
[in]selectionsThread-local selection collection.

Member Function Documentation

void gmx::anonymous_namespace{analysismodule.cpp}::TrajectoryAnalysisModuleDataBasic::finish ( )
overridevirtual

Performs any finishing actions after all frames have been processed.

Exceptions
unspecifiedImplementation may throw exceptions to indicate errors.

This function is called immediately before the destructor, after TrajectoryAnalysisModule::finishFrames(). Derived classes should implement any final operations that need to be done after successful analysis. All implementations should call finishDataHandles().

Implements gmx::TrajectoryAnalysisModuleData.


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