v_sim.DataLoaderIter¶

Fields¶

None

Methods¶

class	`new` ()
	`addNode` (element)
	`allocate` (array)
	`ref` ()
	`unref` ()

Details¶

class v_sim.DataLoaderIter¶

Structure used to define v_sim.DataLoaderIter objects.

New in version 3.8.

classmethod new()¶

Returns:: a newly allocated v_sim.DataLoaderIter object. Use v_sim.DataLoaderIter.unref() when no longer needed.
Return type:: v_sim.DataLoaderIter

Creates a newly allocated iterator. This iterator can be used to accumulate nodes when parsing a file. When parsing is finished, use v_sim.DataLoaderIter.allocate() to allocate enough memory in a v_sim.NodeArray to store the parsed data.

New in version 3.8.

addNode(element)¶

Parameters:: element (v_sim.Element) – a v_sim.Element object.

Register an additional node of type element.

New in version 3.8.

allocate(array)¶

Parameters:: array (v_sim.NodeArray) – a v_sim.NodeArray object.
Returns:: the total number of nodes registered in self.
Return type:: int

Call v_sim.NodeArray.allocate() on array with the proper v_sim.Element list and number of nodes as registered in self.

New in version 3.8.

ref()¶

Returns:: a pointer on self.
Return type:: v_sim.DataLoaderIter

Increment the reference counter on self.

New in version 3.8.

unref()¶: Decrement the reference counter of self. When counter reaches 0, the memory occupied by self is freed.

New in version 3.8.