Open Babel  3.0
Public Member Functions | Protected Attributes | List of all members
OBVectorData Class Reference

#include <openbabel/generic.h>

Inheritance diagram for OBVectorData:
OBGenericData

Public Member Functions

 OBVectorData ()
 
virtual ~OBVectorData ()
 
virtual OBGenericDataClone (OBBase *) const
 
void SetData (double x, double y, double z)
 
void SetData (vector3 data)
 
vector3 GetData () 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

vector3 _vec
 
std::string _attr
 
unsigned int _type
 
DataOrigin _source
 

Detailed Description

Used to hold a 3D vector item (e.g., a dipole moment)

Since
version 2.2

Constructor & Destructor Documentation

◆ OBVectorData()

OBVectorData ( )
inline

◆ ~OBVectorData()

virtual ~OBVectorData ( )
inlinevirtual

Member Function Documentation

◆ Clone()

virtual OBGenericData* Clone ( OBBase ) const
inlinevirtual

Reimplemented from OBGenericData.

◆ SetData() [1/2]

void SetData ( double  x,
double  y,
double  z 
)
inline

◆ SetData() [2/2]

void SetData ( vector3  data)
inline

◆ GetData()

vector3 GetData ( ) const
inline

◆ SetAttribute()

void SetAttribute ( const std::string &  v)
inlineinherited

◆ SetOrigin()

void SetOrigin ( const DataOrigin  s)
inlineinherited

◆ 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

◆ _vec

vector3 _vec
protected

3D vector to be stored

◆ _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

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