ConstGenericPropContainer< H > Class Template Reference

#include <generic_property.hh>

Inherited by GenericPropContainer< AtomBase >, GenericPropContainer< BondHandle >, GenericPropContainer< ChainBase >, GenericPropContainer< EntityBase >, and GenericPropContainer< ResidueBase >.

Public Member Functions
bool	HasProp (const String &key) const
String	GetPropAsString (const String &key) const
String	GetStringProp (const String &key) const
Real	GetFloatProp (const String &key) const
int	GetIntProp (const String &key) const
bool	GetBoolProp (const String &key) const
String	GetStringProp (const String &key, const String &def) const
Real	GetFloatProp (const String &key, Real def) const
int	GetIntProp (const String &key, int def) const
bool	GetBoolProp (const String &key, bool def) const
std::map< String, GenericPropValue >	GetPropMap () const
Protected Member Functions
template<typename T >
T	gp_get (const String &key) const
template<typename T >
T	gp_get (const String &key, const T &def) const
GenericPropContainerImpl *	GetImpl ()
const GenericPropContainerImpl *	GetImpl () const

---

Detailed Description

template<typename H>
class ost::ConstGenericPropContainer< H >

Definition at line 132 of file generic_property.hh.

---

Member Function Documentation

bool GetBoolProp	(	const String &	key,
		bool	def
	)			const [inline]

returns boolean property, or the given default if it does not exist

Definition at line 254 of file generic_property.hh.

bool GetBoolProp

(

const String &

key

)

const [inline]

returns boolean property, raises an exception if it does not exist

Definition at line 217 of file generic_property.hh.

Real GetFloatProp	(	const String &	key,
		Real	def
	)			const [inline]

returns floating point property, or the given default if it does not exist

Definition at line 230 of file generic_property.hh.

Real GetFloatProp

(

const String &

key

)

const [inline]

returns floating point property, raises an exception if it does not exist

Definition at line 190 of file generic_property.hh.

const GenericPropContainerImpl* GetImpl

(

)

const [inline, protected]

Definition at line 158 of file generic_property.hh.

GenericPropContainerImpl* GetImpl

(

)

[inline, protected]

Definition at line 153 of file generic_property.hh.

int GetIntProp	(	const String &	key,
		int	def
	)			const [inline]

returns integer property, or the given default if it does not exist

Definition at line 248 of file generic_property.hh.

int GetIntProp

(

const String &

key

)

const [inline]

returns integer property, raises an exception if it does not exist

Definition at line 211 of file generic_property.hh.

String GetPropAsString

(

const String &

key

)

const [inline]

returns a String representation of stored value

returns the String representation of this property, or the empty String if the property addressed by key does not exist. Note that this is not the same as trying to get a generic float/int/bool property as a String type; the latter will result in a boost:get exception. Use this method to obtain a representation suitable for output.

Definition at line 175 of file generic_property.hh.

std::map<String,GenericPropValue> GetPropMap

(

)

const [inline]

Definition at line 259 of file generic_property.hh.

String GetStringProp	(	const String &	key,
		const String &	def
	)			const [inline]

returns String property, or the given default if it does not exist

Definition at line 223 of file generic_property.hh.

String GetStringProp

(

const String &

key

)

const [inline]

returns String property, raises an exception if it does not exist

Definition at line 183 of file generic_property.hh.

T gp_get	(	const String &	key,
		const T &	def
	)			const [inline, protected]

Definition at line 147 of file generic_property.hh.

T gp_get

(

const String &

key

)

const [inline, protected]

Definition at line 136 of file generic_property.hh.

bool HasProp

(

const String &

key

)

const [inline]

checks existence of property

Definition at line 164 of file generic_property.hh.

---

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

• stage/include/ost/generic_property.hh