OBSerialNums Class Reference

#include <openbabel/generic.h>

Inheritance diagram for OBSerialNums:

Public Member Functions
	OBSerialNums ()
	OBSerialNums (const OBSerialNums &cp)
virtual OBGenericData *	Clone (OBBase *) const
std::map< int, OBAtom * > &	GetData ()
void	SetData (std::map< int, OBAtom *> &sm)
void	SetAttribute (const std::string &v)
void	SetOrigin (const DataOrigin s)
virtual const std::string &	GetAttribute () const
unsigned int	GetDataType () const
virtual const std::string &	GetValue () const
virtual DataOrigin	GetOrigin () const

Protected Attributes
std::map< int, OBAtom * >	_serialMap
std::string	_attr
unsigned int	_type
DataOrigin	_source

Detailed Description

Defines a map between serial numbers (e.g., in a PDB file) and OBAtom objects inside a molecule.

Constructor & Destructor Documentation

OBSerialNums() [1/2]

OBSerialNums ( )

inline

OBSerialNums() [2/2]

OBSerialNums ( const OBSerialNums &  cp )

inline

Member Function Documentation

Clone()

virtual OBGenericData* Clone ( OBBase *  ) const

inlinevirtual

Member variables contain OBAtom pointers, so copying only valid within same molecule, unless the code is modified, as in OBRotamerList

Reimplemented from OBGenericData.

GetData()

std::map<int,OBAtom*>& GetData ( )

inline

SetData()

void SetData ( std::map< int, OBAtom *> &  sm )

inline

SetAttribute()

void SetAttribute ( const std::string &  v )

inlineinherited

Set the attribute (key), which can be used to retrieve this data.

Referenced by OBGastChrg::AssignPartialCharges(), OpenBabel::ComparePairSecond(), OBMol::DoTransformations(), OBMol::FindLSSR(), OBMol::FindSSSR(), OBForceField::GetAtomTypes(), OBMol::GetFormula(), OBMol::GetLSSR(), OBForceField::GetPartialCharges(), OBMol::GetSSSR(), OBDescriptor::PredictAndSave(), and OBMol::SetFormula().

SetOrigin()

void SetOrigin ( const DataOrigin  s )

inlineinherited

Set the origin of this data, which can be used to filter the data.

Referenced by OBGastChrg::AssignPartialCharges(), OpenBabel::ComparePairSecond(), OBMol::DoTransformations(), OBMol::FindAngles(), OBMol::FindLSSR(), OBMol::FindSSSR(), OBMol::FindTorsions(), OBMol::GetFormula(), OBMol::GetLSSR(), OBMol::GetSSSR(), OBDescriptor::PredictAndSave(), and OBMol::SetFormula().

GetAttribute()

virtual const std::string& GetAttribute ( ) const

inlinevirtualinherited

Returns

The attribute (key), which can be used to retrieve this data

Referenced by OpenBabel::extract_thermochemistry(), and OBMoleculeFormat::MakeCombinedMolecule().

GetDataType()

unsigned int GetDataType ( ) const

inlineinherited

Returns

the data type for this object as defined in OBGenericDataType

GetValue()

virtual const std::string& GetValue ( ) const

inlinevirtualinherited

Base class returns a default value (the attribute type) but should never be called.

Reimplemented in OBPairData, and OBCommentData.

Referenced by OBDepict::AddAtomLabels(), OBDepict::DrawMolecule(), OBDescriptor::FilterCompare(), and OBDescriptor::GetValues().

GetOrigin()

virtual DataOrigin GetOrigin ( ) const

inlinevirtualinherited

Member Data Documentation

_serialMap

std::map<int, OBAtom*> _serialMap

protected

map between serial num

Referenced by OBSerialNums::OBSerialNums().

_attr

std::string _attr

protectedinherited

attribute tag (e.g., "UnitCell", "Comment" or "Author")

Referenced by OBRotamerList::Clone(), and OBNasaThermoData::OBNasaThermoData().

_type

unsigned int _type

protectedinherited

attribute type – declared for each subclass

Referenced by OBRotamerList::Clone(), and OBNasaThermoData::OBNasaThermoData().

_source

DataOrigin _source

protectedinherited

source of data for accounting

Referenced by OBConformerData::operator=(), OBSymmetryData::operator=(), OBTorsionData::operator=(), and OBAngleData::operator=().

---

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

• generic.h