OBCommentData Class Reference

#include <openbabel/generic.h>

Inheritance diagram for OBCommentData:

Public Member Functions
	OBCommentData ()
	OBCommentData (const OBCommentData &)
virtual OBGenericData *	Clone (OBBase *) const
OBCommentData &	operator= (const OBCommentData &src)
void	SetData (const std::string &data)
void	SetData (const char *d)
const std::string &	GetData () const
virtual const std::string &	GetValue () const
void	SetAttribute (const std::string &v)
void	SetOrigin (const DataOrigin s)
virtual const std::string &	GetAttribute () const
unsigned int	GetDataType () const
virtual DataOrigin	GetOrigin () const

Protected Attributes
std::string	_data
std::string	_attr
unsigned int	_type
DataOrigin	_source

Detailed Description

Used to store a comment string (can be multiple lines long)

Constructor & Destructor Documentation

OBCommentData() [1/2]

OBCommentData

(

)

OBCommentData() [2/2]

OBCommentData

(

const OBCommentData &

src

)

Member Function Documentation

Clone()

virtual OBGenericData* Clone ( OBBase *  ) const

inlinevirtual

Reimplemented from OBGenericData.

operator=()

OBCommentData& operator=

(

const OBCommentData &

src

)

SetData() [1/2]

void SetData ( const std::string &  data )

inline

SetData() [2/2]

void SetData ( const char *  d )

inline

GetData()

const std::string& GetData ( ) const

inline

GetValue()

virtual const std::string& GetValue ( ) const

inlinevirtual

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

Reimplemented from OBGenericData.

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

GetOrigin()

virtual DataOrigin GetOrigin ( ) const

inlinevirtualinherited

Member Data Documentation

_data

std::string _data

protected

_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 files:

• generic.h
• generic.cpp