OpenStructure
Public Member Functions
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()

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

construct new property mapper for the property of the given name

Parameters
prop_nameis the name of the property. The name may either be the the name of a built-in property or refer to a generic property.
levelhints 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

◆ Get() [1/12]

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.

◆ Get() [2/12]

Real Get ( const AtomHandle atom,
Real  default_value 
) const

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

◆ Get() [3/12]

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.

◆ Get() [4/12]

Real Get ( const AtomView atom,
Real  default_value 
) const

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

◆ Get() [5/12]

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.

◆ Get() [6/12]

Real Get ( const ChainHandle atom,
Real  default_value 
) const

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

◆ Get() [7/12]

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.

◆ Get() [8/12]

Real Get ( const ChainView atom,
Real  default_value 
) const

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

◆ Get() [9/12]

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.

◆ Get() [10/12]

Real Get ( const ResidueHandle atom,
Real  default_value 
) const

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

◆ Get() [11/12]

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.

◆ Get() [12/12]

Real Get ( const ResidueView atom,
Real  default_value 
) const

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


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