Chemical Data Processing Library Python API - Version 1.2.0
Public Member Functions | Static Public Member Functions | Properties | List of all members
CDPL.ConfGen.FragmentLibrary Class Reference
+ Inheritance diagram for CDPL.ConfGen.FragmentLibrary:

Public Member Functions

None __init__ ()
 Initializes the FragmentLibrary instance.
 
None __init__ (FragmentLibrary lib)
 Initializes a copy of the FragmentLibrary instance lib. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
None addEntries (FragmentLibrary lib)
 
bool addEntry (FragmentLibraryEntry entry)
 
bool removeEntry (int hash_code)
 
FragmentLibraryEntry getEntry (int hash_code)
 
bool containsEntry (int hash_code)
 
None clear ()
 
int getNumEntries ()
 
list getEntries ()
 
None load (Base.IStream is)
 
None loadDefaults ()
 
None save (Base.OStream os)
 
FragmentLibrary assign (FragmentLibrary lib)
 Replaces the current state of self with a copy of the state of the FragmentLibrary instance lib. More...
 

Static Public Member Functions

None set (FragmentLibrary lib)
 
FragmentLibrary get ()
 

Properties

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

Constructor & Destructor Documentation

◆ __init__()

None CDPL.ConfGen.FragmentLibrary.__init__ ( FragmentLibrary  lib)

Initializes a copy of the FragmentLibrary instance lib.

Parameters
libThe FragmentLibrary instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.ConfGen.FragmentLibrary.getObjectID ( )

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

Different Python FragmentLibrary 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 FragmentLibrary 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.

◆ addEntries()

None CDPL.ConfGen.FragmentLibrary.addEntries ( FragmentLibrary  lib)
Parameters
lib

◆ addEntry()

bool CDPL.ConfGen.FragmentLibrary.addEntry ( FragmentLibraryEntry  entry)
Parameters
entry
Returns

◆ removeEntry()

bool CDPL.ConfGen.FragmentLibrary.removeEntry ( int  hash_code)
Parameters
hash_code
Returns

◆ getEntry()

FragmentLibraryEntry CDPL.ConfGen.FragmentLibrary.getEntry ( int  hash_code)
Parameters
hash_code
Returns

◆ containsEntry()

bool CDPL.ConfGen.FragmentLibrary.containsEntry ( int  hash_code)
Parameters
hash_code
Returns

◆ getNumEntries()

int CDPL.ConfGen.FragmentLibrary.getNumEntries ( )
Returns

◆ getEntries()

list CDPL.ConfGen.FragmentLibrary.getEntries ( )
Returns

◆ load()

None CDPL.ConfGen.FragmentLibrary.load ( Base.IStream  is)
Parameters
is

◆ save()

None CDPL.ConfGen.FragmentLibrary.save ( Base.OStream  os)
Parameters
os

◆ assign()

FragmentLibrary CDPL.ConfGen.FragmentLibrary.assign ( FragmentLibrary  lib)

Replaces the current state of self with a copy of the state of the FragmentLibrary instance lib.

Parameters
libThe FragmentLibrary instance to copy.
Returns
self

◆ set()

None CDPL.ConfGen.FragmentLibrary.set ( FragmentLibrary  lib)
static
Parameters
lib

◆ get()

FragmentLibrary CDPL.ConfGen.FragmentLibrary.get ( )
static
Parameters
<br>
Returns