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

Public Member Functions

None __init__ (str name)
 Initializes the Item instance. More...
 
None __init__ (Item item)
 Initializes a copy of the Item instance item. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Item assign (Item item)
 Replaces the current state of self with a copy of the state of the Item instance item. More...
 
None swap (Item cat)
 
None clear ()
 
str getName ()
 
int getNumValues ()
 
str getValue (int index)
 
None setValue (int index, str value)
 
None addValue (str value)
 
None removeValue (int index)
 
int __len__ ()
 
str __getitem__ (int index)
 
None __delitem__ (int index)
 
None __setitem__ (int index, str value)
 

Properties

 objectID = property(getObjectID)
 
 numValues = property(getNumValues)
 
 name = property(getName)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Biomol.MMCIFData.Item.__init__ ( str  name)

Initializes the Item instance.

Parameters
name

◆ __init__() [2/2]

None CDPL.Biomol.MMCIFData.Item.__init__ ( Item  item)

Initializes a copy of the Item instance item.

Parameters
itemThe Item instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Biomol.MMCIFData.Item.getObjectID ( )

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

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

◆ assign()

Item CDPL.Biomol.MMCIFData.Item.assign ( Item  item)

Replaces the current state of self with a copy of the state of the Item instance item.

Parameters
itemThe Item instance to copy.
Returns
self

◆ swap()

None CDPL.Biomol.MMCIFData.Item.swap ( Item  cat)
Parameters
cat

◆ getName()

str CDPL.Biomol.MMCIFData.Item.getName ( )
Parameters
arg1
Returns

◆ getNumValues()

int CDPL.Biomol.MMCIFData.Item.getNumValues ( )
Returns

◆ getValue()

str CDPL.Biomol.MMCIFData.Item.getValue ( int  index)
Parameters
index
Returns

◆ setValue()

None CDPL.Biomol.MMCIFData.Item.setValue ( int  index,
str  value 
)
Parameters
index
value

◆ addValue()

None CDPL.Biomol.MMCIFData.Item.addValue ( str  value)
Parameters
value

◆ removeValue()

None CDPL.Biomol.MMCIFData.Item.removeValue ( int  index)
Parameters
index

◆ __len__()

int CDPL.Biomol.MMCIFData.Item.__len__ ( )
Returns

◆ __getitem__()

str CDPL.Biomol.MMCIFData.Item.__getitem__ ( int  index)
Parameters
index
Returns

◆ __delitem__()

None CDPL.Biomol.MMCIFData.Item.__delitem__ ( int  index)
Parameters
index

◆ __setitem__()

None CDPL.Biomol.MMCIFData.Item.__setitem__ ( int  index,
str  value 
)
Parameters
index
value