OpenMD  2.5
Molecular Dynamics in the Open
ParameterBase Class Referenceabstract

#include <ParameterManager.hpp>

Inheritance diagram for ParameterBase:
Parameter< ParamType >

Public Member Functions

 ParameterBase ()
 
virtual ~ParameterBase ()
 
bool isOptional ()
 
void setOptional (bool optional)
 
bool hasDefaultValue ()
 
virtual bool isValid ()
 
const std::string & getKeyword ()
 
void setKeyword (const std::string &keyword)
 
bool empty ()
 
virtual bool setData (std::string)=0
 
virtual bool setData (int)=0
 
virtual bool setData (unsigned long int)=0
 
virtual bool setData (RealType)=0
 
virtual bool setData (std::pair< int, int >)=0
 
virtual bool setData (std::vector< RealType >)=0
 
virtual std::string getParamType ()=0
 

Protected Attributes

std::string keyword_
 
bool optional_
 
bool defaultValue_
 
bool empty_
 

Detailed Description

Definition at line 178 of file ParameterManager.hpp.

Constructor & Destructor Documentation

◆ ParameterBase()

ParameterBase::ParameterBase ( )
inline

Definition at line 180 of file ParameterManager.hpp.

◆ ~ParameterBase()

virtual ParameterBase::~ParameterBase ( )
inlinevirtual

Definition at line 181 of file ParameterManager.hpp.

Member Function Documentation

◆ empty()

bool ParameterBase::empty ( )
inline

Definition at line 188 of file ParameterManager.hpp.

◆ getKeyword()

const std::string& ParameterBase::getKeyword ( )
inline

Definition at line 186 of file ParameterManager.hpp.

◆ getParamType()

virtual std::string ParameterBase::getParamType ( )
pure virtual

Implemented in Parameter< ParamType >.

◆ hasDefaultValue()

bool ParameterBase::hasDefaultValue ( )
inline

Definition at line 184 of file ParameterManager.hpp.

◆ isOptional()

bool ParameterBase::isOptional ( )
inline

Definition at line 182 of file ParameterManager.hpp.

◆ isValid()

virtual bool ParameterBase::isValid ( )
inlinevirtual

Definition at line 185 of file ParameterManager.hpp.

◆ setData() [1/6]

virtual bool ParameterBase::setData ( std::string  )
pure virtual

Implemented in Parameter< ParamType >.

◆ setData() [2/6]

virtual bool ParameterBase::setData ( int  )
pure virtual

Implemented in Parameter< ParamType >.

◆ setData() [3/6]

virtual bool ParameterBase::setData ( unsigned long  int)
pure virtual

Implemented in Parameter< ParamType >.

◆ setData() [4/6]

virtual bool ParameterBase::setData ( RealType  )
pure virtual

Implemented in Parameter< ParamType >.

◆ setData() [5/6]

virtual bool ParameterBase::setData ( std::pair< int, int >  )
pure virtual

Implemented in Parameter< ParamType >.

◆ setData() [6/6]

virtual bool ParameterBase::setData ( std::vector< RealType >  )
pure virtual

Implemented in Parameter< ParamType >.

◆ setKeyword()

void ParameterBase::setKeyword ( const std::string &  keyword)
inline

Definition at line 187 of file ParameterManager.hpp.

◆ setOptional()

void ParameterBase::setOptional ( bool  optional)
inline

Definition at line 183 of file ParameterManager.hpp.

Member Data Documentation

◆ defaultValue_

bool ParameterBase::defaultValue_
protected

Definition at line 199 of file ParameterManager.hpp.

◆ empty_

bool ParameterBase::empty_
protected

Definition at line 200 of file ParameterManager.hpp.

◆ keyword_

std::string ParameterBase::keyword_
protected

Definition at line 197 of file ParameterManager.hpp.

◆ optional_

bool ParameterBase::optional_
protected

Definition at line 198 of file ParameterManager.hpp.


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