OBFreeGrid Class Reference

#include <openbabel/generic.h>

Inheritance diagram for OBFreeGrid:

Public Member Functions
	OBFreeGrid ()
	~OBFreeGrid ()
int	NumPoints ()
void	AddPoint (double x, double y, double z, double V)
OBFreeGridPointIterator	BeginPoints ()
OBFreeGridPointIterator	EndPoints ()
OBFreeGridPoint *	BeginPoint (OBFreeGridPointIterator &i)
OBFreeGridPoint *	NextPoint (OBFreeGridPointIterator &i)
void	Clear ()
virtual OBGenericData *	Clone (OBBase *) const
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::vector< OBFreeGridPoint * >	_points
std::string	_attr
unsigned int	_type
DataOrigin	_source

Detailed Description

Handle double precision floating point data with coordinates not on a grid Can hold array of random coordinates and associated values.

Constructor & Destructor Documentation

OBFreeGrid()

OBFreeGrid ( )

inline

~OBFreeGrid()

~OBFreeGrid ( )

inline

Member Function Documentation

NumPoints()

int NumPoints ( )

inline

AddPoint()

void AddPoint ( double  x, double  y, double  z, double  V  )

inline

BeginPoints()

OBFreeGridPointIterator BeginPoints ( )

inline

EndPoints()

OBFreeGridPointIterator EndPoints ( )

inline

BeginPoint()

OBFreeGridPoint* BeginPoint ( OBFreeGridPointIterator &  i )

inline

NextPoint()

OBFreeGridPoint* NextPoint ( OBFreeGridPointIterator &  i )

inline

Clear()

void Clear

(

void

)

Clone()

virtual OBGenericData* Clone ( OBBase *  ) const

inlinevirtualinherited

Reimplemented in OBMatrixData, OBVectorData, OBRotationData, OBElectronicTransitionData, OBOrbitalData, OBDOSData, OBVibrationData, OBSerialNums, OBAngleData, OBTorsionData, OBSymmetryData, OBConformerData, OBUnitCell, OBCisTransStereo, OBRingData, OBVirtualBond, OBTetrahedralStereo, OBSquarePlanarStereo, OBSetData, OBNasaThermoData, OBPairTemplate< ValueT >, OBPairData, OBExternalBondData, AliasData, OBRotamerList, OBCommentData, and OBRateData.

Referenced by OBBase::CloneData(), OBAtom::Duplicate(), OBMoleculeFormat::MakeCombinedMolecule(), and OBMol::operator=().

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

_points

std::vector<OBFreeGridPoint*> _points

protected

coordinates with accompanying float values

_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