EntityPropertyMapper Class Reference

#include <entity_property_mapper.hh>

Public Member Functions
	EntityPropertyMapper (const String &prop_name, Prop::Level level=Prop::UNSPECIFIED)
Real	Get (const AtomHandle &atom) const
Real	Get (const AtomHandle &atom, Real default_value) const
Real	Get (const AtomView &atom) const
Real	Get (const AtomView &atom, Real default_value) const
Real	Get (const ResidueHandle &atom) const
Real	Get (const ResidueHandle &atom, Real default_value) const
Real	Get (const ResidueView &atom) const
Real	Get (const ResidueView &atom, Real default_value) const
Real	Get (const ChainHandle &atom) const
Real	Get (const ChainHandle &atom, Real default_value) const
Real	Get (const ChainView &atom) const
Real	Get (const ChainView &atom, Real default_value) const

---

Detailed Description

Definition at line 35 of file entity_property_mapper.hh.

---

Constructor & Destructor Documentation

EntityPropertyMapper	(	const String &	prop_name,
		Prop::Level	level = Prop::UNSPECIFIED
	)

construct new property mapper for the property of the given name

Parameters:

	prop_name	is the name of the property. The name may either be the the name of a built-in property or refer to a generic property.
	level	hints at the hierarchy level that stores the property. If the property is one of the built-in properties of atoms, residues or chains, this parameter has no effect.

---

Member Function Documentation

Real Get	(	const ChainView &	atom,
		Real	default_value
	)			const

get float property, returning default if the property does not exist

Real Get

(

const ChainView &

atom

)

const

get float property throwing an exception when the value does not exist

Only float and int properties are considered. Properties from residues and chains may be used as well.

Real Get	(	const ChainHandle &	atom,
		Real	default_value
	)			const

get float property, returning default if the property does not exist

Real Get

(

const ChainHandle &

atom

)

const

get float property throwing an exception when the value does not exist

Only float and int properties are considered. Properties from residues and chains may be used as well.

Real Get	(	const ResidueView &	atom,
		Real	default_value
	)			const

get float property, returning default if the property does not exist

Real Get

(

const ResidueView &

atom

)

const

get float property throwing an exception when the value does not exist

Only float and int properties are considered. Properties from residues and chains may be used as well.

Real Get	(	const ResidueHandle &	atom,
		Real	default_value
	)			const

get float property, returning default if the property does not exist

Real Get

(

const ResidueHandle &

atom

)

const

get float property throwing an exception when the value does not exist

Only float and int properties are considered. Properties from residues and chains may be used as well.

Real Get	(	const AtomView &	atom,
		Real	default_value
	)			const

get float property, returning default if the property does not exist

Real Get

(

const AtomView &

atom

)

const

get float property throwing an exception when the value does not exist

Only float and int properties are considered. Properties from residues and chains may be used as well.

Real Get	(	const AtomHandle &	atom,
		Real	default_value
	)			const

get float property, returning default if the property does not exist

Real Get

(

const AtomHandle &

atom

)

const

get float property throwing an exception when the value does not exist

Only float and int properties are considered. Properties from residues and chains may be used as well.

---

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

• stage/include/ost/mol/entity_property_mapper.hh