OpenBabel::OBSymmetryData

OBSymmetryData Class Reference

Used to hold the point-group and/or space-group symmetry. More...

#include <openbabel/generic.h>

Inheritance diagram for OBSymmetryData:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 OBSymmetryData ()
 OBSymmetryData (const OBSymmetryData &)
virtual OBGenericData * Clone (OBBase *) const
 ~OBSymmetryData ()
OBSymmetryData & operator= (const OBSymmetryData &)
void SetData (std::string pg, std::string sg="")
void SetPointGroup (std::string pg)
void SetSpaceGroup (std::string sg)
std::string GetPointGroup ()
std::string GetSpaceGroup ()
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::string _spaceGroup
std::string _pointGroup
std::string _attr
unsigned int _type
DataOrigin _source

Detailed Description

Used to hold the point-group and/or space-group symmetry.

Todo:
Add support for translation between symbol notations. Add symmetry perception routines.

Constructor & Destructor Documentation

OBSymmetryData (  ) 

OBSymmetryData ( const OBSymmetryData &   ) 

~OBSymmetryData (  )  [inline]

Member Function Documentation

virtual OBGenericData* Clone ( OBBase *   )  const [inline, virtual]

Reimplemented from OBGenericData.

OBSymmetryData & operator= ( const OBSymmetryData &   ) 

void SetData ( std::string  pg,
std::string  sg = "" 
) [inline]

void SetPointGroup ( std::string  pg  )  [inline]

void SetSpaceGroup ( std::string  sg  )  [inline]

std::string GetPointGroup (  )  [inline]

std::string GetSpaceGroup (  )  [inline]

void SetAttribute ( const std::string &  v  )  [inline, inherited]

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

void SetOrigin ( const DataOrigin  s  )  [inline, inherited]

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

virtual const std::string& GetAttribute (  )  const [inline, virtual, inherited]

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

unsigned int GetDataType (  )  const [inline, inherited]

Returns:
the data type for this object as defined in OBGenericDataType

virtual const std::string& GetValue (  )  const [inline, virtual, inherited]

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

Reimplemented in OBCommentData, OBPairData, and OBPairTemplate.

virtual DataOrigin GetOrigin (  )  const [inline, virtual, inherited]

Member Data Documentation

std::string _spaceGroup [protected]

std::string _pointGroup [protected]

std::string _attr [protected, inherited]

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

unsigned int _type [protected, inherited]

attribute type -- declared for each subclass

DataOrigin _source [protected, inherited]

source of data for accounting

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