OpenMD  2.5
Molecular Dynamics in the Open
OpenMD::Component Class Reference

#include <Component.hpp>

Inheritance diagram for OpenMD::Component:
OpenMD::DataHolder

Public Member Functions

 Component ()
 
virtual ~Component ()
 
virtual void validate ()
 
MoleculeStampgetMoleculeStamp ()
 
bool findMoleculeStamp (const std::map< std::string, MoleculeStamp *> &molStamps)
 
- Public Member Functions inherited from OpenMD::DataHolder
 DataHolder ()
 
virtual ~DataHolder ()
 
template<class T >
void assign (const std::string &keyword, T val)
 

Private Member Functions

 DeclareParameter (Type, std::string)
 
 DeclareParameter (NMol, int)
 
 DeclareParameter (Region, int)
 

Private Attributes

MoleculeStampmoleculeStamp_
 

Additional Inherited Members

- Protected Types inherited from OpenMD::DataHolder
typedef std::map< std::string, ParameterBase * > ParamMap
 
- Protected Attributes inherited from OpenMD::DataHolder
ParamMap parameters_
 
std::set< std::string > deprecatedKeywords_
 

Detailed Description

Definition at line 48 of file Component.hpp.

Constructor & Destructor Documentation

◆ Component()

OpenMD::Component::Component ( )

Definition at line 50 of file Component.cpp.

References DefineParameter.

◆ ~Component()

OpenMD::Component::~Component ( )
virtual

Definition at line 56 of file Component.cpp.

Member Function Documentation

◆ DeclareParameter() [1/3]

OpenMD::Component::DeclareParameter ( Type  ,
std::string   
)
private

◆ DeclareParameter() [2/3]

OpenMD::Component::DeclareParameter ( NMol  ,
int   
)
private

◆ DeclareParameter() [3/3]

OpenMD::Component::DeclareParameter ( Region  ,
int   
)
private

◆ findMoleculeStamp()

bool OpenMD::Component::findMoleculeStamp ( const std::map< std::string, MoleculeStamp *> &  molStamps)

Definition at line 65 of file Component.cpp.

References moleculeStamp_.

Referenced by getMoleculeStamp().

◆ getMoleculeStamp()

MoleculeStamp* OpenMD::Component::getMoleculeStamp ( )
inline

Definition at line 57 of file Component.hpp.

References findMoleculeStamp(), and moleculeStamp_.

◆ validate()

void OpenMD::Component::validate ( )
virtual

Reimplemented from OpenMD::DataHolder.

Definition at line 59 of file Component.cpp.

References CheckParameter, OpenMD::isNonNegative(), OpenMD::isNotEmpty(), and OpenMD::isPositive().

Member Data Documentation

◆ moleculeStamp_

MoleculeStamp* OpenMD::Component::moleculeStamp_
private

Definition at line 60 of file Component.hpp.

Referenced by findMoleculeStamp(), and getMoleculeStamp().


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