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::Value::Holder< ValueTrait, Constraint > Class Template Reference

Inheritance diagram for ProtoMol::Value::Holder< ValueTrait, Constraint >:

ProtoMol::Value::PlaceHolder List of all members.

Public Member Functions

 Holder (const typename ValueTrait::RepType &v, bool def=true)
 Holder (const Holder &rhs)
virtual const std::type_info & type () const
virtual PlaceHolder * clone () const
virtual bool valid () const
virtual bool clear ()
virtual bool init ()
virtual unsigned int size () const
virtual void read (std::istream &is)
virtual ValueType::Enum getType () const
virtual ConstraintValueType::Enum getConstraintType () const
virtual const std::string & getTypeString () const
virtual const std::string & getConstraintTypeString () const
virtual bool get (std::string &v) const
virtual bool get (int &v) const
virtual bool get (unsigned int &v) const
virtual bool get (Real &v) const
virtual bool get (bool &v) const
virtual bool get (Vector3D &v) const
virtual bool get (std::vector< Real > &v) const
virtual bool set (const std::string &v)
virtual bool set (int v)
virtual bool set (unsigned int v)
virtual bool set (Real v)
virtual bool set (bool v)
virtual bool set (const Vector3D &v)
virtual bool set (const std::vector< Real > &v)
virtual bool set (const Value &val)

Private Attributes

ValueTrait::RepType holder
bool ok

Detailed Description

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
class ProtoMol::Value::Holder< ValueTrait, Constraint >

Implementation of the placerholder taking a type defined in ValueTrait and a constraint (Constraint)

Constructor & Destructor Documentation

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
ProtoMol::Value::Holder< ValueTrait, Constraint >::Holder (  const typename ValueTrait::RepType &  v,
bool  def = true
)  [inline]
 

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
ProtoMol::Value::Holder< ValueTrait, Constraint >::Holder (  const Holder< ValueTrait, Constraint > &  rhs  )  [inline]
 

Member Function Documentation

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::clear (   )  [inline, virtual]
 

Makes the value non-valid/cleared and returns previous state of valid.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual PlaceHolder* ProtoMol::Value::Holder< ValueTrait, Constraint >::clone (   )  const [inline, virtual]
 

Clones the value.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::get (  std::vector< Real > &  v  )  const [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::get (  Vector3D &  v  )  const [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::get (  bool &  v  )  const [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::get (  Real &  v  )  const [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::get (  unsigned int &  v  )  const [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::get (  int &  v  )  const [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::get (  std::string &  v  )  const [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual ConstraintValueType::Enum ProtoMol::Value::Holder< ValueTrait, Constraint >::getConstraintType (   )  const [inline, virtual]
 

Returns the type of the constraint.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual const std::string& ProtoMol::Value::Holder< ValueTrait, Constraint >::getConstraintTypeString (   )  const [inline, virtual]
 

Returns the type as a string.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual ValueType::Enum ProtoMol::Value::Holder< ValueTrait, Constraint >::getType (   )  const [inline, virtual]
 

Returns the type.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual const std::string& ProtoMol::Value::Holder< ValueTrait, Constraint >::getTypeString (   )  const [inline, virtual]
 

Return the type of the constraint as a string.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::init (   )  [inline, virtual]
 

Initialized the value with the default value of its representation type and applying its constraints.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual void ProtoMol::Value::Holder< ValueTrait, Constraint >::read (  std::istream &  is  )  [inline, virtual]
 

Reads the value from std::istream according its type.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::set (  const Value &  val  )  [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::set (  const std::vector< Real > &  v  )  [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::set (  const Vector3D &  v  )  [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::set (  bool  v  )  [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::set (  Real  v  )  [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::set (  unsigned int  v  )  [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::set (  int  v  )  [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::set (  const std::string &  v  )  [inline, virtual]
 

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual unsigned int ProtoMol::Value::Holder< ValueTrait, Constraint >::size (   )  const [inline, virtual]
 

Returns the number of elements, non-1 for string, Vector3D, vector.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual const std::type_info& ProtoMol::Value::Holder< ValueTrait, Constraint >::type (   )  const [inline, virtual]
 

Returns the std::type_info of the value.

Implements ProtoMol::Value::PlaceHolder.

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
virtual bool ProtoMol::Value::Holder< ValueTrait, Constraint >::valid (   )  const [inline, virtual]
 

True if the value is valid and has a type.

Implements ProtoMol::Value::PlaceHolder.

Member Data Documentation

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
ValueTrait::RepType ProtoMol::Value::Holder< ValueTrait, Constraint >::holder [private]
 

template<typename ValueTrait, typename Constraint = ConstraintValueType::NoConstraints>
bool ProtoMol::Value::Holder< ValueTrait, Constraint >::ok [private]
 

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