Chemical Data Processing Library Python API - Version 1.1.1
Classes | Public Member Functions | Static Public Member Functions | Properties | List of all members
CDPL.ForceField.MMFF94BondStretchingParameterTable Class Reference
+ Inheritance diagram for CDPL.ForceField.MMFF94BondStretchingParameterTable:

Classes

class  Entry
 

Public Member Functions

None __init__ ()
 Initializes the MMFF94BondStretchingParameterTable instance.
 
None __init__ (MMFF94BondStretchingParameterTable table)
 Initializes a copy of the MMFF94BondStretchingParameterTable instance table. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
None addEntry (int bond_type_idx, int atom1_type, int atom2_type, float force_const, float ref_length)
 
bool removeEntry (int bond_type_idx, int atom1_type, int atom2_type)
 
Entry getEntry (int bond_type_idx, int atom1_type, int atom2_type)
 
None clear ()
 
int getNumEntries ()
 
list getEntries ()
 
None load (Base.IStream is)
 
None loadDefaults ()
 
MMFF94BondStretchingParameterTable assign (MMFF94BondStretchingParameterTable table)
 Replaces the current state of self with a copy of the state of the MMFF94BondStretchingParameterTable instance table. More...
 

Static Public Member Functions

None set (MMFF94BondStretchingParameterTable table)
 
MMFF94BondStretchingParameterTable get ()
 

Properties

 objectID = property(getObjectID)
 
 numEntries = property(getNumEntries)
 
 entries = property(getEntries)
 

Constructor & Destructor Documentation

◆ __init__()

None CDPL.ForceField.MMFF94BondStretchingParameterTable.__init__ ( MMFF94BondStretchingParameterTable  table)

Initializes a copy of the MMFF94BondStretchingParameterTable instance table.

Parameters
tableThe MMFF94BondStretchingParameterTable instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.ForceField.MMFF94BondStretchingParameterTable.getObjectID ( )

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python MMFF94BondStretchingParameterTable instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two MMFF94BondStretchingParameterTable instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns
The numeric ID of the internally referenced C++ class instance.

◆ addEntry()

None CDPL.ForceField.MMFF94BondStretchingParameterTable.addEntry ( int  bond_type_idx,
int  atom1_type,
int  atom2_type,
float  force_const,
float  ref_length 
)
Parameters
bond_type_idx
atom1_type
atom2_type
force_const
ref_length

◆ removeEntry()

bool CDPL.ForceField.MMFF94BondStretchingParameterTable.removeEntry ( int  bond_type_idx,
int  atom1_type,
int  atom2_type 
)
Parameters
bond_type_idx
atom1_type
atom2_type
Returns

◆ getEntry()

Entry CDPL.ForceField.MMFF94BondStretchingParameterTable.getEntry ( int  bond_type_idx,
int  atom1_type,
int  atom2_type 
)
Parameters
bond_type_idx
atom1_type
atom2_type
Returns

◆ getNumEntries()

int CDPL.ForceField.MMFF94BondStretchingParameterTable.getNumEntries ( )
Returns

◆ getEntries()

list CDPL.ForceField.MMFF94BondStretchingParameterTable.getEntries ( )
Returns

◆ load()

None CDPL.ForceField.MMFF94BondStretchingParameterTable.load ( Base.IStream  is)
Parameters
is

◆ assign()

MMFF94BondStretchingParameterTable CDPL.ForceField.MMFF94BondStretchingParameterTable.assign ( MMFF94BondStretchingParameterTable  table)

Replaces the current state of self with a copy of the state of the MMFF94BondStretchingParameterTable instance table.

Parameters
tableThe MMFF94BondStretchingParameterTable instance to copy.
Returns
self

◆ set()

None CDPL.ForceField.MMFF94BondStretchingParameterTable.set ( MMFF94BondStretchingParameterTable  table)
static
Parameters
table

◆ get()

MMFF94BondStretchingParameterTable CDPL.ForceField.MMFF94BondStretchingParameterTable.get ( )
static
Parameters
<br>
Returns