ProtoMol - an object-oriented component based framework for Molecular Dynamics simulations.
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

ProtoMol::Makeable Class Reference

#include <Makeable.h>

Inheritance diagram for ProtoMol::Makeable:

ProtoMol::Force ProtoMol::GenericTopology ProtoMol::Integrator ProtoMol::Output ProtoMol::CompareForce ProtoMol::ExtendedForce ProtoMol::MetaForce ProtoMol::MollyForce ProtoMol::SystemForce ProtoMol::TimeForce ProtoMol::SemiGenericTopology< TBoundaryConditions > ProtoMol::NonStandardIntegrator ProtoMol::StandardIntegrator ProtoMol::OutputDCDTrajectory ProtoMol::OutputFile ProtoMol::OutputFinalPDBPos ProtoMol::OutputFinalPSF ProtoMol::OutputFinalXSC ProtoMol::OutputFinalXYZBinPos ProtoMol::OutputFinalXYZBinVel ProtoMol::OutputFinalXYZPos ProtoMol::OutputFinalXYZVel ProtoMol::OutputPDBFramePos ProtoMol::OutputScreen ProtoMol::OutputXYZTrajectoryForce ProtoMol::OutputXYZTrajectoryPos ProtoMol::OutputXYZTrajectoryVel List of all members.

Public Member Functions

virtual ~Makeable ()
virtual void getParameters (std::vector< Parameter > &parameters) const=0
virtual unsigned int getParameterSize () const=0
std::vector< Parameter > getParameters () const
virtual MakeableDefinition getDefinition () const
std::string getId () const
std::string getAlias () const
std::string setAlias (const std::string &id)
virtual std::string getIdNoAlias () const=0
virtual std::string getScope () const=0
virtual std::string getText () const
bool checkParameters (std::string &errMsg, const std::vector< Value > &values) const
bool checkParameters (const std::vector< Value > &values) const
bool checkParameterTypes (const std::vector< Value > &values) const
virtual bool adjustWithDefaultParameters (std::vector< Value > &values, const Configuration *) const

Static Public Member Functions

template<typename T> T * copy (T *obj)

Protected Member Functions

template<typename T> T * adjustAlias (T *obj) const

Private Attributes

std::string myAlias

Detailed Description

Base class of all object, which can be create dynamically based on a prototype, normally used together with a Factory.

Constructor & Destructor Documentation

virtual ProtoMol::Makeable::~Makeable (   )  [inline, virtual]
 

Member Function Documentation

template<typename T>
T* ProtoMol::Makeable::adjustAlias (  T *  obj  )  const [inline, protected]
 

virtual bool ProtoMol::Makeable::adjustWithDefaultParameters (  std::vector< Value > &  values,
const Configuration * 
)  const [inline, virtual]
 

Reimplemented in ProtoMol::OutputDCDTrajectory, ProtoMol::OutputDihedrals, ProtoMol::OutputFile, ProtoMol::OutputPaulTrap, ProtoMol::OutputPDBFramePos, ProtoMol::OutputScreen, ProtoMol::OutputXYZTrajectoryForce, ProtoMol::OutputXYZTrajectoryPos, and ProtoMol::OutputXYZTrajectoryVel.

bool ProtoMol::Makeable::checkParameters (  const std::vector< Value > &  values  )  const
 

bool ProtoMol::Makeable::checkParameters (  std::string &  errMsg,
const std::vector< Value > &  values
)  const
 

bool ProtoMol::Makeable::checkParameterTypes (  const std::vector< Value > &  values  )  const
 

template<typename T>
T* ProtoMol::Makeable::copy (  T *  obj  )  [inline, static]
 

string ProtoMol::Makeable::getAlias (   )  const
 

MakeableDefinition ProtoMol::Makeable::getDefinition (   )  const [virtual]
 

string ProtoMol::Makeable::getId (   )  const
 

virtual std::string ProtoMol::Makeable::getIdNoAlias (   )  const [pure virtual]
 

Implemented in ProtoMol::AngleSystemForce< TBoundaryConditions >, ProtoMol::BondSystemForce< TBoundaryConditions >, ProtoMol::CompareForce, ProtoMol::DihedralSystemForce< TBoundaryConditions >, ProtoMol::ElectricFieldSystemForce< TBoundaryConditions, TSwitchingFunction, TConstraint >, ProtoMol::ExternalGravitationSystemForce, ProtoMol::ExternalMagneticFieldExtendedForce, ProtoMol::FrictionExtendedForce, ProtoMol::HarmDihedralSystemForce< TBoundaryConditions >, ProtoMol::ImproperSystemForce< TBoundaryConditions >, ProtoMol::MagneticDipoleMirrorSystemForce< TBoundaryConditions >, ProtoMol::NonbondedFullEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TSwitchingFunction >, ProtoMol::NonbondedFullSystemForce< TOneAtomPair >, ProtoMol::NonbondedMultiGridSystemForce< TBoundaryConditions, TCellManager, TInterpolation, TKernel, direct, correction, smooth >, ProtoMol::NonbondedPMEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TInterpolation, TSwitchingFunction >, ProtoMol::NonbondedSimpleFullSystemForce< TOneAtomPair >, ProtoMol::PaulTrapExtendedForce< TBoundaryConditions >, ProtoMol::SphericalSystemForce, ProtoMol::TimeForce, ProtoMol::WrapperMetaForce, ProtoMol::OutputDCDTrajectory, ProtoMol::OutputDiffusion, ProtoMol::OutputDihedrals, ProtoMol::OutputEnergies, ProtoMol::OutputFinalPDBPos, ProtoMol::OutputFinalXYZBinPos, ProtoMol::OutputFinalXYZBinVel, ProtoMol::OutputFinalXYZPos, ProtoMol::OutputFinalXYZVel, ProtoMol::OutputMomentum, ProtoMol::OutputPaulTrap, ProtoMol::OutputPDBFramePos, ProtoMol::OutputScreen, ProtoMol::OutputTemperatures, ProtoMol::OutputXYZTrajectoryForce, ProtoMol::OutputXYZTrajectoryPos, ProtoMol::OutputXYZTrajectoryVel, ProtoMol::HapticSystemForce, ProtoMol::BBKIntegrator, ProtoMol::BSplineMOLLYIntegrator, ProtoMol::DihedralHMCIntegrator, ProtoMol::DLMCIntegrator, ProtoMol::DMDLeapfrogIntegrator, ProtoMol::EquilibriumMOLLYIntegrator, ProtoMol::HMCIntegrator, ProtoMol::ImpulseIntegrator, ProtoMol::LangevinImpulseIntegrator, ProtoMol::LeapfrogIntegrator, ProtoMol::NoseNVTLeapfrogIntegrator, ProtoMol::NPTVerletIntegrator, ProtoMol::NVTVerletIntegrator, ProtoMol::PaulTrapIntegrator, ProtoMol::PLeapfrogIntegrator, ProtoMol::ShadowHMCIntegrator, ProtoMol::UmbrellaIntegrator, ProtoMol::Topology< TBoundaryConditions, TCellManager >, ProtoMol::iSGAngleSystemForce< TBoundaryConditions >, ProtoMol::iSGBondSystemForce< TBoundaryConditions >, ProtoMol::iSGDihedralSystemForce< TBoundaryConditions >, ProtoMol::iSGImproperSystemForce< TBoundaryConditions >, ProtoMol::iSGNonbondedFullEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TSwitchingFunction >, ProtoMol::iSGNonbondedPMEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TInterpolation, TSwitchingFunction >, ProtoMol::OutputFinalPSF, ProtoMol::OutputFinalXSC, ProtoMol::OutputISGProperties, ProtoMol::iSGIntegrator, ProtoMol::NonbondedCutoffForce< TCellManager, TOneAtomPair, MollyForce, NonbondedCutoffMollyForce< TCellManager, TOneAtomPair > >, and ProtoMol::NonbondedCutoffForce< TCellManager, TOneAtomPair, SystemForce, NonbondedCutoffSystemForce< TCellManager, TOneAtomPair > >.

vector< Parameter > ProtoMol::Makeable::getParameters (   )  const
 

retrieve all parameters

virtual void ProtoMol::Makeable::getParameters (  std::vector< Parameter > &  parameters  )  const [pure virtual]
 

retrieve all parameters

Implemented in ProtoMol::AngleSystemForce< TBoundaryConditions >, ProtoMol::BondSystemForce< TBoundaryConditions >, ProtoMol::CompareForce, ProtoMol::DihedralSystemForce< TBoundaryConditions >, ProtoMol::ElectricFieldSystemForce< TBoundaryConditions, TSwitchingFunction, TConstraint >, ProtoMol::ExternalGravitationSystemForce, ProtoMol::ExternalMagneticFieldExtendedForce, ProtoMol::FrictionExtendedForce, ProtoMol::HarmDihedralSystemForce< TBoundaryConditions >, ProtoMol::ImproperSystemForce< TBoundaryConditions >, ProtoMol::MagneticDipoleMirrorSystemForce< TBoundaryConditions >, ProtoMol::NonbondedFullEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TSwitchingFunction >, ProtoMol::NonbondedFullSystemForce< TOneAtomPair >, ProtoMol::NonbondedMultiGridSystemForce< TBoundaryConditions, TCellManager, TInterpolation, TKernel, direct, correction, smooth >, ProtoMol::NonbondedPMEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TInterpolation, TSwitchingFunction >, ProtoMol::NonbondedSimpleFullSystemForce< TOneAtomPair >, ProtoMol::PaulTrapExtendedForce< TBoundaryConditions >, ProtoMol::SphericalSystemForce, ProtoMol::TimeForce, ProtoMol::WrapperMetaForce, ProtoMol::OutputDCDTrajectory, ProtoMol::OutputDihedrals, ProtoMol::OutputEnergies, ProtoMol::OutputFile, ProtoMol::OutputFinalPDBPos, ProtoMol::OutputFinalXYZBinPos, ProtoMol::OutputFinalXYZBinVel, ProtoMol::OutputFinalXYZPos, ProtoMol::OutputFinalXYZVel, ProtoMol::OutputPaulTrap, ProtoMol::OutputPDBFramePos, ProtoMol::OutputScreen, ProtoMol::OutputTemperatures, ProtoMol::OutputXYZTrajectoryForce, ProtoMol::OutputXYZTrajectoryPos, ProtoMol::OutputXYZTrajectoryVel, ProtoMol::HapticSystemForce, ProtoMol::BBKIntegrator, ProtoMol::BSplineMOLLYIntegrator, ProtoMol::DihedralHMCIntegrator, ProtoMol::DMDLeapfrogIntegrator, ProtoMol::LangevinImpulseIntegrator, ProtoMol::MCIntegrator, ProtoMol::MTSIntegrator, ProtoMol::NoseNVTLeapfrogIntegrator, ProtoMol::NPTVerletIntegrator, ProtoMol::NVTVerletIntegrator, ProtoMol::PaulTrapIntegrator, ProtoMol::ShadowHMCIntegrator, ProtoMol::STSIntegrator, ProtoMol::UmbrellaIntegrator, ProtoMol::Topology< TBoundaryConditions, TCellManager >, ProtoMol::iSGAngleSystemForce< TBoundaryConditions >, ProtoMol::iSGBondSystemForce< TBoundaryConditions >, ProtoMol::iSGDihedralSystemForce< TBoundaryConditions >, ProtoMol::iSGImproperSystemForce< TBoundaryConditions >, ProtoMol::iSGNonbondedFullEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TSwitchingFunction >, ProtoMol::iSGNonbondedPMEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TInterpolation, TSwitchingFunction >, ProtoMol::OutputFinalPSF, ProtoMol::OutputFinalXSC, ProtoMol::OutputISGProperties, ProtoMol::iSGIntegrator, ProtoMol::NonbondedCutoffForce< TCellManager, TOneAtomPair, MollyForce, NonbondedCutoffMollyForce< TCellManager, TOneAtomPair > >, and ProtoMol::NonbondedCutoffForce< TCellManager, TOneAtomPair, SystemForce, NonbondedCutoffSystemForce< TCellManager, TOneAtomPair > >.

virtual unsigned int ProtoMol::Makeable::getParameterSize (   )  const [pure virtual]
 

number of parameters

Implemented in ProtoMol::AngleSystemForce< TBoundaryConditions >, ProtoMol::BondSystemForce< TBoundaryConditions >, ProtoMol::CompareForce, ProtoMol::DihedralSystemForce< TBoundaryConditions >, ProtoMol::ElectricFieldSystemForce< TBoundaryConditions, TSwitchingFunction, TConstraint >, ProtoMol::ExternalGravitationSystemForce, ProtoMol::ExternalMagneticFieldExtendedForce, ProtoMol::FrictionExtendedForce, ProtoMol::HarmDihedralSystemForce< TBoundaryConditions >, ProtoMol::ImproperSystemForce< TBoundaryConditions >, ProtoMol::MagneticDipoleMirrorSystemForce< TBoundaryConditions >, ProtoMol::NonbondedFullEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TSwitchingFunction >, ProtoMol::NonbondedFullSystemForce< TOneAtomPair >, ProtoMol::NonbondedMultiGridSystemForce< TBoundaryConditions, TCellManager, TInterpolation, TKernel, direct, correction, smooth >, ProtoMol::NonbondedPMEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TInterpolation, TSwitchingFunction >, ProtoMol::NonbondedSimpleFullSystemForce< TOneAtomPair >, ProtoMol::PaulTrapExtendedForce< TBoundaryConditions >, ProtoMol::SphericalSystemForce, ProtoMol::TimeForce, ProtoMol::WrapperMetaForce, ProtoMol::OutputDCDTrajectory, ProtoMol::OutputDiffusion, ProtoMol::OutputDihedrals, ProtoMol::OutputEnergies, ProtoMol::OutputFinalPDBPos, ProtoMol::OutputFinalXYZBinPos, ProtoMol::OutputFinalXYZBinVel, ProtoMol::OutputFinalXYZPos, ProtoMol::OutputFinalXYZVel, ProtoMol::OutputMomentum, ProtoMol::OutputPaulTrap, ProtoMol::OutputPDBFramePos, ProtoMol::OutputScreen, ProtoMol::OutputTemperatures, ProtoMol::OutputXYZTrajectoryForce, ProtoMol::OutputXYZTrajectoryPos, ProtoMol::OutputXYZTrajectoryVel, ProtoMol::HapticSystemForce, ProtoMol::BBKIntegrator, ProtoMol::BSplineMOLLYIntegrator, ProtoMol::DihedralHMCIntegrator, ProtoMol::DLMCIntegrator, ProtoMol::DMDLeapfrogIntegrator, ProtoMol::HMCIntegrator, ProtoMol::LangevinImpulseIntegrator, ProtoMol::LeapfrogIntegrator, ProtoMol::MTSIntegrator, ProtoMol::NoseNVTLeapfrogIntegrator, ProtoMol::NPTVerletIntegrator, ProtoMol::NVTVerletIntegrator, ProtoMol::PaulTrapIntegrator, ProtoMol::PLeapfrogIntegrator, ProtoMol::ShadowHMCIntegrator, ProtoMol::UmbrellaIntegrator, ProtoMol::Topology< TBoundaryConditions, TCellManager >, ProtoMol::iSGAngleSystemForce< TBoundaryConditions >, ProtoMol::iSGBondSystemForce< TBoundaryConditions >, ProtoMol::iSGDihedralSystemForce< TBoundaryConditions >, ProtoMol::iSGImproperSystemForce< TBoundaryConditions >, ProtoMol::iSGNonbondedFullEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TSwitchingFunction >, ProtoMol::iSGNonbondedPMEwaldSystemForce< TBoundaryConditions, TCellManager, real, reciprocal, correction, TInterpolation, TSwitchingFunction >, ProtoMol::OutputFinalPSF, ProtoMol::OutputFinalXSC, ProtoMol::OutputISGProperties, ProtoMol::iSGIntegrator, ProtoMol::NonbondedCutoffForce< TCellManager, TOneAtomPair, MollyForce, NonbondedCutoffMollyForce< TCellManager, TOneAtomPair > >, and ProtoMol::NonbondedCutoffForce< TCellManager, TOneAtomPair, SystemForce, NonbondedCutoffSystemForce< TCellManager, TOneAtomPair > >.

virtual std::string ProtoMol::Makeable::getScope (   )  const [pure virtual]
 

Implemented in ProtoMol::Force, ProtoMol::Output, ProtoMol::Integrator, and ProtoMol::GenericTopology.

virtual std::string ProtoMol::Makeable::getText (   )  const [inline, virtual]
 

std::string ProtoMol::Makeable::setAlias (  const std::string &  id  ) 
 

Member Data Documentation

std::string ProtoMol::Makeable::myAlias [private]
 

The documentation for this class was generated from the following files: Last update: . GNU GENERAL PUBLIC LICENSE, copyrighted by the University of Notre Dame and the University of Bergen, Norway.