Writer for grid data of type Grid.DRegularGrid in any supported format. More...

Inheritance diagram for CDPL.Grid.DRegularGridWriter:

Public Member Functions
None	__init__ (str file_name, OpenMode mode=Base.IOStream.OpenMode(60))
	Constructs a `MultiFormatDataWriter` that opens file_name and deduces the output format from its name. More...

None	__init__ (str file_name, str fmt_str, OpenMode mode=Base.IOStream.OpenMode(60))
	Constructs a `MultiFormatDataWriter` that opens file_name and uses the output handler matching the file-extension/format name fmt_str. More...

None	__init__ (str file_name, Base.DataFormat fmt, OpenMode mode=Base.IOStream.OpenMode(12))
	Constructs a `MultiFormatDataWriter` that opens file_name and uses the output handler matching the Base.DataFormat fmt. More...

None	__init__ (Base.IOStream ios, str fmt_str)
	Constructs a `MultiFormatDataWriter` that wraps ios and uses the output handler matching the file-extension/format name fmt_str. More...

None	__init__ (Base.IOStream ios, Base.DataFormat fmt)
	Constructs a `MultiFormatDataWriter` that wraps ios and uses the output handler matching the Base.DataFormat fmt. More...

Base.DataFormat	getDataFormat ()
	Returns the data format actually used by the wrapped output handler. More...

Public Member Functions inherited from CDPL.Grid.DRegularGridWriterBase
None	__init__ ()
	Contructs the `DRegularGridWriterBase` instance.

DRegularGridWriterBase	write (DRegularGrid grid)
	Writes the DRegularGrid object grid. More...

None	close ()
	Writes format dependent data (if required) to mark the end of output. More...

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

bool	__nonzero__ ()
	Returns a boolean indicating the error state of the writer. 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
	dataFormat = property(getDataFormat)

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

Writer for grid data of type Grid.DRegularGrid in any supported format.

Constructor & Destructor Documentation

◆ init() [1/5]

None CDPL.Grid.DRegularGridWriter.__init__	(	str	file_name,
		OpenMode	mode = `Base.IOStream.OpenMode(60)`
	)

Constructs a MultiFormatDataWriter that opens file_name and deduces the output format from its name.

Parameters

file_name	The output-file name.
mode	The open mode of the underlying file stream.

Exceptions

Base.IOError if no matching output handler was found.

◆ init() [2/5]

None CDPL.Grid.DRegularGridWriter.__init__	(	str	file_name,
		str	fmt_str,
		OpenMode	mode = `Base.IOStream.OpenMode(60)`
	)

Constructs a MultiFormatDataWriter that opens file_name and uses the output handler matching the file-extension/format name fmt_str.

Parameters

file_name	The output-file name.
fmt_str	A file-extension or format name resolvable via Base.DataIOManager.
mode	The open mode of the underlying file stream.

Exceptions

Base.IOError if no matching output handler was found.

◆ init() [3/5]

None CDPL.Grid.DRegularGridWriter.__init__	(	str	file_name,
		Base.DataFormat	fmt,
		OpenMode	mode = `Base.IOStream.OpenMode(12)`
	)

Constructs a MultiFormatDataWriter that opens file_name and uses the output handler matching the Base.DataFormat fmt.

Parameters

file_name	The output-file name.
fmt	The output format identifier.
mode	The open mode of the underlying file stream.

Exceptions

Base.IOError if no matching output handler was found.

◆ init() [4/5]

None CDPL.Grid.DRegularGridWriter.__init__	(	Base.IOStream	ios,
		str	fmt_str
	)

Constructs a MultiFormatDataWriter that wraps ios and uses the output handler matching the file-extension/format name fmt_str.

Parameters

ios	The output stream to wrap.
fmt_str	A file-extension or format name resolvable via Base.DataIOManager.

Exceptions

Base.IOError if no matching output handler was found.

◆ init() [5/5]

None CDPL.Grid.DRegularGridWriter.__init__	(	Base.IOStream	ios,
		Base.DataFormat	fmt
	)

Constructs a MultiFormatDataWriter that wraps ios and uses the output handler matching the Base.DataFormat fmt.

Parameters

ios	The output stream to wrap.
fmt	The output format identifier.

Exceptions

Base.IOError if no matching output handler was found.

Member Function Documentation

◆ getDataFormat()

Base.DataFormat CDPL.Grid.DRegularGridWriter.getDataFormat ( )

Returns the data format actually used by the wrapped output handler.

Returns: The resolved Base.DataFormat.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/5]

◆ __init__() [2/5]

◆ __init__() [3/5]

◆ __init__() [4/5]

◆ __init__() [5/5]

Member Function Documentation

◆ getDataFormat()

◆ init() [1/5]

◆ init() [2/5]

◆ init() [3/5]

◆ init() [4/5]

◆ init() [5/5]