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

#include <gromacs/analysisdata/dataframe.h>

Description

Value type for storing frame-level information for analysis data.

Default copy constructor and assignment operator are used and work as intended. Typically new objects of this type are only constructed internally by the library and in classes that are derived from AbstractAnalysisData.

Methods in this class do not throw, but may contain asserts for incorrect usage.

Note that it is not possible to change the contents of an initialized object, except by assigning a new object to replace it completely.

Public Member Functions

 AnalysisDataFrameHeader ()
 Constructs an invalid frame header. More...
 
 AnalysisDataFrameHeader (int index, real x, real dx)
 Constructs a frame header from given values. More...
 
bool isValid () const
 Returns whether the frame header corresponds to a valid frame. More...
 
int index () const
 Returns zero-based index of the frame. More...
 
real x () const
 Returns the x coordinate for the frame. More...
 
real dx () const
 Returns error in the x coordinate for the frame (if applicable). More...
 

Constructor & Destructor Documentation

gmx::AnalysisDataFrameHeader::AnalysisDataFrameHeader ( )

Constructs an invalid frame header.

Return values of other methods than isValid() are unspecified for the constructed object.

gmx::AnalysisDataFrameHeader::AnalysisDataFrameHeader ( int  index,
real  x,
real  dx 
)

Constructs a frame header from given values.

Parameters
[in]indexIndex of the frame. Must be >= 0.
[in]xx coordinate for the frame.
[in]dxError estimate for x.

Member Function Documentation

real gmx::AnalysisDataFrameHeader::dx ( ) const
inline

Returns error in the x coordinate for the frame (if applicable).

All data do not provide error estimates. Typically returns zero in those cases.

Should not be called for invalid frames.

int gmx::AnalysisDataFrameHeader::index ( ) const
inline

Returns zero-based index of the frame.

The return value is >= 0 for valid frames. Should not be called for invalid frames.

bool gmx::AnalysisDataFrameHeader::isValid ( ) const
inline

Returns whether the frame header corresponds to a valid frame.

If returns false, return values of other methods are not specified.

real gmx::AnalysisDataFrameHeader::x ( ) const
inline

Returns the x coordinate for the frame.

Should not be called for invalid frames.


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