Composite Base.DataReader that aggregates several underlying readers and presents their records as one contiguous record stream. More...

Inheritance diagram for CDPL.Grid.CompoundDRegularGridSetReader:

Public Member Functions
None	__init__ ()
	Constructs an empty `CompoundDataReader` instance.

int	getNumReaders ()
	Returns the number of underlying readers. More...

None	addReader (DRegularGridSetReaderBase reader)
	Appends reader to the list of underlying readers. More...

None	removeReader (int idx)
	Removes the reader at index idx from the list of underlying readers. More...

None	clear ()
	Removes all underlying readers.

DRegularGridSetReaderBase	getReader (int idx)
	Returns the underlying reader at index idx. More...

Public Member Functions inherited from CDPL.Grid.DRegularGridSetReaderBase
DRegularGridSetReaderBase	read (DRegularGridSet grid_set, bool overwrite=True)
	Reads the data record at the current record index and stores the read data in grid_set. More...

DRegularGridSetReaderBase	read (int idx, DRegularGridSet grid_set, bool overwrite=True)
	Reads the data record at index idx and stores the read data in grid_set. More...

DRegularGridSetReaderBase	skip ()
	Skips the data record at the current record index. More...

bool	hasMoreData ()
	Tells if there are any data records left to read. More...

int	getRecordIndex ()
	Returns the index of the current data record. More...

None	setRecordIndex (int idx)
	Sets the index of the current data record to idx. More...

int	getNumRecords ()
	Returns the total number of available data records. More...

None	close ()
	Performs a reader specific shutdown operation (if required). More...

bool	__nonzero__ ()
	Returns a boolean indicating the error state of the reader. More...

bool	__bool__ ()
	Returns a boolean indicating the error state of the reader. More...

Public Member Functions inherited from CDPL.Base.DataIOBase
int	registerIOCallback (VoidDataIOBaseFunctor func)
	Registers an I/O callback target function. More...

None	unregisterIOCallback (int id)
	Unregisters the I/O callback function specified by id. More...

None	invokeIOCallbacks (float progress)
	Invokes all registered I/O callback functions with the argument `self`. More...

None	clearIOCallbacks ()
	Clears all registered I/O callback functions.

Public Member Functions inherited from CDPL.Base.ControlParameterContainer
None	setParameter (LookupKey key, Any val)
	Sets the value of the control-parameter specified by key to val. More...

bool	removeParameter (LookupKey key)
	Removes the entry for the control-parameter specified by key. More...

Any	getParameter (LookupKey key, bool throw_=False, bool local=False)
	Returns the value of the control-parameter specified by key. More...

Any	getParameterOrDefault (LookupKey key, Any def_val, bool local=False)
	Returns the value of the control-parameter specified by key , or the default value def_val if an entry does not exist. More...

bool	isParameterSet (LookupKey key, bool local=False)
	Tells whether or not a value has been assigned to the control-parameter specified by key. More...

None	clearParameters ()
	Erases all container entries. More...

None	addParameters (ControlParameterContainer cntnr)
	Adds the control-parameter value entries of the `ControlParameterContainer` instance cntnr. More...

None	copyParameters (ControlParameterContainer cntnr)
	Replaces the current control-parameter entries by a copy of the entries in cntnr. More...

int	getNumParameters ()
	Returns the number of container entries. More...

int	registerParameterChangedCallback (VoidLookupKeyAnyFunctor func)
	Registers a callback target function that gets invoked when the value of a control-parameter has changed. More...

None	unregisterParameterChangedCallback (int id)
	Unregisters the callback specified by id. More...

int	registerParameterRemovedCallback (VoidLookupKeyFunctor func)
	Registers a callback target function that gets invoked when a control-parameter entry has been removed. More...

None	unregisterParameterRemovedCallback (int id)
	Unregisters the callback specified by id. More...

int	registerParentChangedCallback (VoidFunctor func)
	Registers a callback target function that gets invoked when the parent container has been changed or was detached. More...

None	unregisterParentChangedCallback (int id)
	Unregisters the callback specified by id. More...

ControlParameterContainer	getParent ()
	Returns the parent control-parameter container. More...

None	setParent (ControlParameterContainer cntnr)
	Sets or removes the parent control-parameter container used to resolve requests for missing entries. More...

list	getParameterKeys ()
	Returns a list containing the keys of the current control-parameter entries. More...

list	getParameterValues ()
	Returns a list containing the values of the current control-parameter entries. More...

list	getParameters ()
	Returns a reference to itself. More...

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

Any	__getitem__ (LookupKey key)
	Returns the value of the control-parameter specified by key. More...

None	__setitem__ (LookupKey key, Any val)
	Sets the value of the control-parameter specified by key to val. More...

bool	__delitem__ (LookupKey key)
	Removes the entry for the control-parameter specified by key. More...

bool	__contains__ (LookupKey key)
	Tells whether or not a value has been assigned to the control-parameter specified by key. More...

int	__len__ ()
	Returns the number of container entries. More...

Properties
	numReaders = property(getNumReaders)

Properties inherited from CDPL.Grid.DRegularGridSetReaderBase
	numRecords = property(getNumRecords)

Properties inherited from CDPL.Base.ControlParameterContainer
	objectID = property(getObjectID)

	parent = property(getParent, setParent)

	parameterKeys = property(getParameterKeys)

	parameterValues = property(getParameterValues)

	parameters = property(getParameters)

	numParameters = property(getNumParameters)

Detailed Description

Composite Base.DataReader that aggregates several underlying readers and presents their records as one contiguous record stream.

Member Function Documentation

◆ getNumReaders()

int CDPL.Grid.CompoundDRegularGridSetReader.getNumReaders ( )

Returns the number of underlying readers.

Returns: The reader count.

◆ addReader()

None CDPL.Grid.CompoundDRegularGridSetReader.addReader ( DRegularGridSetReaderBase reader )

Appends reader to the list of underlying readers.

Parameters

reader The reader to add.

◆ removeReader()

None CDPL.Grid.CompoundDRegularGridSetReader.removeReader ( int idx )

Removes the reader at index idx from the list of underlying readers.

Parameters

idx	The zero-based reader index.

Exceptions

Base.IndexError if idx is not in the range [0, getNumReaders()).

◆ getReader()

DRegularGridSetReaderBase CDPL.Grid.CompoundDRegularGridSetReader.getReader ( int idx )

Returns the underlying reader at index idx.

Parameters

idx	The zero-based reader index.

Returns: The reader shared reference.

Exceptions

Base.IndexError if idx is not in the range [0, getNumReaders()).

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ getNumReaders()

◆ addReader()

◆ removeReader()

◆ getReader()