OBRotorRules Class Reference

Database of default hybridization torsional rules and SMARTS-defined OBRotorRule objects. More...

#include <rotor.h>

Inheritance diagram for OBRotorRules:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 OBRotorRules ()
 ~OBRotorRules ()
void ParseLine (const char *)
 Specified by particular table classes (parses an individual data line).
unsigned int GetSize ()
 
Returns:
the number of rotor rules

void SetFilename (std::string &s)
 Set the filename to be used for the database. Default = torlib.txt.
void GetRotorIncrements (OBMol &, OBBond *, int[4], std::vector< double > &, double &delta)
void Quiet ()
void Init ()
 Read in the data file, falling back as needed.
void SetReadDirectory (char *dir)
 Set the directory before calling Init().
void SetEnvironmentVariable (char *var)
 Set the environment variable to use before calling Init().

Protected Attributes

bool _init
 whether the data been read already
const char * _dataptr
 default data table if file is unreadable
std::string _filename
 file to search for
std::string _dir
 data directory for file if _envvar fails
std::string _subdir
 subdirectory (if using environment variable)
std::string _envvar
 environment variable to check first

Detailed Description

Database of default hybridization torsional rules and SMARTS-defined OBRotorRule objects.


Constructor & Destructor Documentation

OBRotorRules (  ) 

~OBRotorRules (  ) 


Member Function Documentation

void ParseLine ( const char *  buffer  )  [virtual]

Specified by particular table classes (parses an individual data line).

Reimplemented from OBGlobalDataBase.

unsigned int GetSize (  )  [inline, virtual]

Returns:
the number of rotor rules

Reimplemented from OBGlobalDataBase.

void SetFilename ( std::string &  s  )  [inline]

Set the filename to be used for the database. Default = torlib.txt.

void GetRotorIncrements ( OBMol ,
OBBond ,
int  [4],
std::vector< double > &  ,
double &  delta 
)

void Quiet (  )  [inline]

void Init (  )  [inherited]

Read in the data file, falling back as needed.

void SetReadDirectory ( char *  dir  )  [inline, inherited]

Set the directory before calling Init().

void SetEnvironmentVariable ( char *  var  )  [inline, inherited]

Set the environment variable to use before calling Init().


Member Data Documentation

bool _init [protected, inherited]

whether the data been read already

const char* _dataptr [protected, inherited]

default data table if file is unreadable

std::string _filename [protected, inherited]

file to search for

std::string _dir [protected, inherited]

data directory for file if _envvar fails

std::string _subdir [protected, inherited]

subdirectory (if using environment variable)

std::string _envvar [protected, inherited]

environment variable to check first


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