sparksee.OIDList Class Reference

Sparksee object identifier list. More...

Public Member Functions
	clear (self)
	Clears the list.
	__init__ (self, num_invalid_oids)
	Constructor.
	__init__ (self)
	Constructor.
	__iter__ (self)
	Gets a new TypeListIterator.
	set (self, pos, oid)
	Sets a Sparksee object identifier at the specified position of the list.
	iterator (self)
	Gets a new OIDListIterator.
	add (self, attr)
	Adds a Sparksee object identifier at the end of the list.
	count (self)
	Number of elements in the list.

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

Constructor & Destructor Documentation

__init__() [1/2]

sparksee.OIDList.__init__	(		self,
			num_invalid_oids )

Constructor.

This creates a list with N invalid oids.

Parameters

num_invalid_oids

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

__init__() [2/2]

sparksee.OIDList.__init__

(

self

)

Constructor.

This creates an empty list.

Member Function Documentation

__iter__()

sparksee.OIDList.__iter__

(

self

)

Gets a new TypeListIterator.

Returns

TypeListIterator instance

add()

sparksee.OIDList.add	(		self,
			attr )

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

Parameters

attr	[in] Sparksee object identifier.

count()

sparksee.OIDList.count

(

self

)

Number of elements in the list.

Returns

Number of elements in the list.

iterator()

sparksee.OIDList.iterator

(

self

)

Gets a new OIDListIterator.

Returns

OIDListIterator instance.

set()

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.