Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

ForceFieldParameters Class Reference
[Force Field Parameters]

Force field parameter class. More...

#include <forceFieldParameters.h>

Inheritance diagram for ForceFieldParameters:

Parameters List of all members.

Public Member Functions

Constructors and destructor
 ForceFieldParameters ()
 Default constructor.
 ForceFieldParameters (const String &filename)
 Constructor.
 ForceFieldParameters (const ForceFieldParameters &force_field_parameter)
 Copy constructor.
virtual ~ForceFieldParameters () throw ()
 Destructor.
Assignment
virtual void clear () throw ()
 Clear method.
const ForceFieldParametersoperator= (const ForceFieldParameters &param)
 Assignment operator.
Accessors
AtomTypesgetAtomTypes ()
 Return a reference to the atom type parameter section.
virtual bool init ()
 Read the contents of the INI file and interpret them.
Predicates
virtual bool isValid () const
 Valididty predicate.
bool operator== (const ForceFieldParameters &param) const
 Equality operator.

Protected Attributes

AtomTypes atom_types_

Friends

class ForceField

Detailed Description

Force field parameter class.


Constructor & Destructor Documentation

ForceFieldParameters::ForceFieldParameters  ) 
 

Default constructor.

ForceFieldParameters::ForceFieldParameters const String filename  ) 
 

Constructor.

virtual ForceFieldParameters::~ForceFieldParameters  )  throw () [virtual]
 

Destructor.


Member Function Documentation

virtual bool ForceFieldParameters::init  )  [virtual]
 

Read the contents of the INI file and interpret them.

Reimplemented from Parameters.

virtual bool ForceFieldParameters::isValid  )  const [virtual]
 

Valididty predicate.

Return true if the force field parameters were correctly initialized, the internal INI file is valid and the internal atom types object is valid.

Returns:
bool - valid_ && parameter_file_.isValid() && atom_types_.isValid()

Reimplemented from Parameters.