OpenBabel::OBTorsionData

OBTorsionData Class Reference

Used to hold torsions as generic data for OBMol. More...

#include <openbabel/generic.h>

Inheritance diagram for OBTorsionData:

Inheritance graph
[legend]
List of all members.

Public Member Functions

OBTorsionData & operator= (const OBTorsionData &)
virtual OBGenericData * Clone (OBBase *) const
void Clear ()
std::vector< OBTorsion > GetData () const
unsigned int GetSize () const
void SetData (OBTorsion &torsion)
bool FillTorsionArray (std::vector< std::vector< unsigned int > > &torsions)
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 Member Functions

 OBTorsionData ()
 OBTorsionData (const OBTorsionData &)

Protected Attributes

std::vector< OBTorsion > _torsions
std::string _attr
unsigned int _type
DataOrigin _source

Friends

class OBMol

Detailed Description

Used to hold torsions as generic data for OBMol.

Filled by OBMol::FindTorsions()

Constructor & Destructor Documentation

OBTorsionData (  )  [protected]

OBTorsionData ( const OBTorsionData &   )  [protected]

Member Function Documentation

OBTorsionData & operator= ( const OBTorsionData &   ) 

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

Todo:
Needs to be updated to rebase atom pointers (or use indexes)

Reimplemented from OBGenericData.

void Clear (  ) 

std::vector<OBTorsion> GetData (  )  const [inline]

Gets a vector of the OBTorsion objects

Returns:
the vector of torsions

unsigned int GetSize (  )  const [inline]

Gets the number of torsion structs

Returns:
integer count of the number of torsions

void SetData ( OBTorsion &  torsion  ) 

bool FillTorsionArray ( std::vector< std::vector< unsigned int > > &  torsions  ) 

Fills a vector with the indices of the atoms in torsions (ordered abcd).

Parameters:
torsions reference to the vector of abcd atom sets
Returns:
boolean success

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]

Friends And Related Function Documentation

friend class OBMol [friend]

Member Data Documentation

std::vector<OBTorsion> _torsions [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: