sparksee.OIDList Class Reference

Sparksee object identifier list. More...

List of all members.

Public Member Functions

def add
 Adds a Sparksee object identifier at the end of the list.
def clear
 Clears the list.
def __iter__
 Gets a new TypeListIterator.
def set
 Sets a Sparksee object identifier at the specified position of the list.
def iterator
 Gets a new OIDListIterator.
def count
 Number of elements in the list.
def __init__
 Constructor.
def __init__
 Constructor.


Detailed Description

Sparksee object identifier list.

It stores a Sparksee object identifier list.

Use OIDListIterator to access all elements into this collection.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

def sparksee.OIDList.add (   self,
  attr 
)

Adds a Sparksee object identifier at the end of the list.

Parameters:
attr [in] Sparksee object identifier.

def sparksee.OIDList.__iter__ (   self  ) 

Gets a new TypeListIterator.

Returns:
TypeListIterator instance

def sparksee.OIDList.set (   self,
  pos,
  oid 
)

Sets a Sparksee object identifier at the specified position of the list.

Parameters:
pos [in] List position [0..Count()-1].
oid [in] Sparksee object identifier.

def sparksee.OIDList.iterator (   self  ) 

Gets a new OIDListIterator.

Returns:
OIDListIterator instance.

def sparksee.OIDList.count (   self  ) 

Number of elements in the list.

Returns:
Number of elements in the list.

def sparksee.OIDList.__init__ (   self,
  numInvalidOIDs 
)

Constructor.

This creates a list with N invalid oids.

Parameters:
numInvalidOIDs [in] The number of invalid oids added to the list.

def sparksee.OIDList.__init__ (   self  ) 

Constructor.

This creates an empty list.


Generated on Tue Jun 2 16:12:20 2015 for SparkseePython by  doxygen 1.5.6