CDPL::Grid Namespace Reference

Contains classes and functions related to grid based data representation and processing. More...

Namespaces
	AttributedGridProperty
	Provides keys for built-in Grid::AttributedGrid properties.
	AttributedGridPropertyDefault
	Provides default values for built-in Grid::AttributedGrid properties.
	ControlParameter
	Provides keys for built-in control-parameters.
	ControlParameterDefault
	Provides default values for built-in control-parameters.
	DataFormat
	Provides preinitialized Base::DataFormat objects for all supported data formats.

Classes
class	RegularGrid
	Implementation of the Grid::SpatialGrid interface for regular spatial grids. More...
class	RegularGridSet
	Data structure for the storage of Grid::RegularGrid objects. More...
class	AttributedGrid
	Abstract base class for grid types that also carry generic key/value properties. More...
class	CDFDRegularGridReader
	Reader for regular spatial grid data in the native I/O format of the CDPL. More...
class	CDFDRegularGridSetReader
	Reader for regular spatial grid set data in the native I/O format of the CDPL. More...
class	CDFDRegularGridSetWriter
	Writer for regular spatial grid set data in the native I/O format of the CDPL. More...
class	CDFDRegularGridWriter
	Writer for regular spatial grid data in the native I/O format of the CDPL. More...
class	CUBEDRegularGridReader
	Reader for regular spatial grid data in the Gaussian CUBE [CUBE] format. More...
class	CUBEDRegularGridWriter
	Writer for regular spatial grid data in the Gaussian CUBE [CUBE] format. More...
class	SpatialGrid
	Abstract base class for attributed grids whose elements have a defined 3D position in space. More...

Typedefs
typedef Util::DefaultDataInputHandler< CDFBZ2DRegularGridReader, DataFormat::CDF_BZ2 >	CDFBZ2DRegularGridInputHandler
	Handler for the input of bzip2-compressed regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataOutputHandler< CDFBZ2DRegularGridWriter, DataFormat::CDF_BZ2 >	CDFBZ2DRegularGridOutputHandler
	Handler for the output of bzip2-compressed regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::CompressedDataReader< CDFDRegularGridReader, Util::BZip2IStream >	CDFBZ2DRegularGridReader
	Reader for bzip2-compressed regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataInputHandler< CDFBZ2DRegularGridSetReader, DataFormat::CDF_BZ2 >	CDFBZ2DRegularGridSetInputHandler
	Handler for the input of bzip2-compressed regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataOutputHandler< CDFBZ2DRegularGridSetWriter, DataFormat::CDF_BZ2 >	CDFBZ2DRegularGridSetOutputHandler
	Handler for the output of bzip2-compressed regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::CompressedDataReader< CDFDRegularGridSetReader, Util::BZip2IStream >	CDFBZ2DRegularGridSetReader
	Reader for bzip2-compressed regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::CompressedDataWriter< CDFDRegularGridSetWriter, Util::BZip2OStream >	CDFBZ2DRegularGridSetWriter
	Writer for bzip2-compressed regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::CompressedDataWriter< CDFDRegularGridWriter, Util::BZip2OStream >	CDFBZ2DRegularGridWriter
	Writer for bzip2-compressed regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataInputHandler< CDFDRegularGridReader, DataFormat::CDF >	CDFDRegularGridInputHandler
	Handler for the input of regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataOutputHandler< CDFDRegularGridWriter, DataFormat::CDF >	CDFDRegularGridOutputHandler
	Handler for the output of regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataInputHandler< CDFDRegularGridSetReader, DataFormat::CDF >	CDFDRegularGridSetInputHandler
	Handler for the input of regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataOutputHandler< CDFDRegularGridSetWriter, DataFormat::CDF >	CDFDRegularGridSetOutputHandler
	Handler for the output of regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataInputHandler< CDFGZDRegularGridReader, DataFormat::CDF_GZ >	CDFGZDRegularGridInputHandler
	Handler for the input of gzip-compressed regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataOutputHandler< CDFGZDRegularGridWriter, DataFormat::CDF_GZ >	CDFGZDRegularGridOutputHandler
	Handler for the output of gzip-compressed regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::CompressedDataReader< CDFDRegularGridReader, Util::GZipIStream >	CDFGZDRegularGridReader
	Reader for gzip-compressed regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataInputHandler< CDFGZDRegularGridSetReader, DataFormat::CDF_GZ >	CDFGZDRegularGridSetInputHandler
	Handler for the input of gzip-compressed regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataOutputHandler< CDFGZDRegularGridSetWriter, DataFormat::CDF_GZ >	CDFGZDRegularGridSetOutputHandler
	Handler for the output of gzip-compressed regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::CompressedDataReader< CDFDRegularGridSetReader, Util::GZipIStream >	CDFGZDRegularGridSetReader
	Reader for gzip-compressed regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::CompressedDataWriter< CDFDRegularGridSetWriter, Util::GZipOStream >	CDFGZDRegularGridSetWriter
	Writer for gzip-compressed regular spatial grid set data in the native I/O format of the CDPL. More...
typedef Util::CompressedDataWriter< CDFDRegularGridWriter, Util::GZipOStream >	CDFGZDRegularGridWriter
	Writer for gzip-compressed regular spatial grid data in the native I/O format of the CDPL. More...
typedef Util::DefaultDataInputHandler< CUBEDRegularGridReader, DataFormat::CUBE >	CUBEDRegularGridInputHandler
	Handler for the input of regular spatial grid data in the Gaussian CUBE [CUBE] format. More...
typedef Util::DefaultDataOutputHandler< CUBEDRegularGridWriter, DataFormat::CUBE >	CUBEDRegularGridOutputHandler
	Handler for the output of regular spatial grid data in the Gaussian CUBE [CUBE] format. More...
typedef Util::MultiFormatDataReader< DRegularGrid >	DRegularGridReader
	Reader for regular spatial grid data of type Grid::DRegularGrid in any supported format. More...
typedef Util::MultiFormatDataReader< DRegularGridSet >	DRegularGridSetReader
	Reader for regular spatial grid set data of type Grid::DRegularGridSet in any supported format. More...
typedef Util::MultiFormatDataWriter< DRegularGridSet >	DRegularGridSetWriter
	Writer for regular spatial grid set data of type Grid::DRegularGridSet in any supported format. More...
typedef Util::MultiFormatDataWriter< DRegularGrid >	DRegularGridWriter
	Writer for grid data of type Grid::DRegularGrid in any supported format. More...
typedef RegularGrid< float >	FRegularGrid
	A regular spatial grid storing single-precision floating-point values. More...
typedef RegularGrid< double >	DRegularGrid
	A regular spatial grid storing double-precision floating-point values. More...
typedef RegularGridSet< double >	DRegularGridSet
	Convenience alias for the double-precision regular spatial grid sets. More...
typedef RegularGridSet< float >	FRegularGridSet
	Convenience alias for the single-precision regular spatial grid sets. More...
typedef SpatialGrid< float >	FSpatialGrid
	Convenience alias for the single-precision spatial-grid abstract base. More...
typedef SpatialGrid< double >	DSpatialGrid
	Convenience alias for the double-precision spatial-grid abstract base. More...

Functions
CDPL_GRID_API const std::string &	getName (const AttributedGrid &grid)
	Returns the value of the Grid::AttributedGridProperty::NAME property of the attributed grid grid. More...
CDPL_GRID_API void	setName (AttributedGrid &grid, const std::string &name)
	Sets the value of the Grid::AttributedGridProperty::NAME property of the attributed grid grid to name. More...
CDPL_GRID_API void	clearName (AttributedGrid &grid)
	Clears the value of the Grid::AttributedGridProperty::NAME property of the attributed grid grid. More...
CDPL_GRID_API bool	hasName (const AttributedGrid &grid)
	Tells whether the Grid::AttributedGridProperty::NAME property of the attributed grid grid is set. More...
CDPL_GRID_API const std::string &	getComment (const AttributedGrid &grid)
	Returns the value of the Grid::AttributedGridProperty::COMMENT property of the attributed grid grid. More...
CDPL_GRID_API void	setComment (AttributedGrid &grid, const std::string &comment)
	Sets the value of the Grid::AttributedGridProperty::COMMENT property of the attributed grid grid to comment. More...
CDPL_GRID_API void	clearComment (AttributedGrid &grid)
	Clears the value of the Grid::AttributedGridProperty::COMMENT property of the attributed grid grid. More...
CDPL_GRID_API bool	hasComment (const AttributedGrid &grid)
	Tells whether the Grid::AttributedGridProperty::COMMENT property of the attributed grid grid is set. More...
CDPL_GRID_API bool	getStrictErrorCheckingParameter (const Base::ControlParameterContainer &cntnr)
	Returns the value of the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter stored in cntnr. More...
CDPL_GRID_API void	setStrictErrorCheckingParameter (Base::ControlParameterContainer &cntnr, bool strict)
	Sets the value of the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr to strict. More...
CDPL_GRID_API bool	hasStrictErrorCheckingParameter (const Base::ControlParameterContainer &cntnr)
	Tells whether the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr is set. More...
CDPL_GRID_API void	clearStrictErrorCheckingParameter (Base::ControlParameterContainer &cntnr)
	Removes the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter from cntnr. More...
CDPL_GRID_API bool	getCDFOutputSinglePrecisionFloatsParameter (const Base::ControlParameterContainer &cntnr)
	Returns the value of the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter stored in cntnr. More...
CDPL_GRID_API void	setCDFOutputSinglePrecisionFloatsParameter (Base::ControlParameterContainer &cntnr, bool single_prec)
	Sets the value of the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntnr to single_prec. More...
CDPL_GRID_API bool	hasCDFOutputSinglePrecisionFloatsParameter (const Base::ControlParameterContainer &cntnr)
	Tells whether the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntnr is set. More...
CDPL_GRID_API void	clearCDFOutputSinglePrecisionFloatsParameter (Base::ControlParameterContainer &cntnr)
	Removes the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter from cntnr. More...
CDPL_GRID_API bool	getCUBECommentIsNameParameter (const Base::ControlParameterContainer &cntnr)
	Returns the value of the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter stored in cntnr. More...
CDPL_GRID_API void	setCUBECommentIsNameParameter (Base::ControlParameterContainer &cntnr, bool is_name)
	Sets the value of the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter of cntnr to is_name. More...
CDPL_GRID_API bool	hasCUBECommentIsNameParameter (const Base::ControlParameterContainer &cntnr)
	Tells whether the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter of cntnr is set. More...
CDPL_GRID_API void	clearCUBECommentIsNameParameter (Base::ControlParameterContainer &cntnr)
	Removes the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter from cntnr. More...
CDPL_GRID_API double	getCUBEInputDistanceScalingFactorParameter (const Base::ControlParameterContainer &cntnr)
	Returns the value of the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter stored in cntnr. More...
CDPL_GRID_API void	setCUBEInputDistanceScalingFactorParameter (Base::ControlParameterContainer &cntnr, double factor)
	Sets the value of the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter of cntnr to factor. More...
CDPL_GRID_API bool	hasCUBEInputDistanceScalingFactorParameter (const Base::ControlParameterContainer &cntnr)
	Tells whether the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter of cntnr is set. More...
CDPL_GRID_API void	clearCUBEInputDistanceScalingFactorParameter (Base::ControlParameterContainer &cntnr)
	Removes the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter from cntnr. More...
CDPL_GRID_API double	getCUBEOutputDistanceScalingFactorParameter (const Base::ControlParameterContainer &cntnr)
	Returns the value of the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter stored in cntnr. More...
CDPL_GRID_API void	setCUBEOutputDistanceScalingFactorParameter (Base::ControlParameterContainer &cntnr, double factor)
	Sets the value of the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter of cntnr to factor. More...
CDPL_GRID_API bool	hasCUBEOutputDistanceScalingFactorParameter (const Base::ControlParameterContainer &cntnr)
	Tells whether the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter of cntnr is set. More...
CDPL_GRID_API void	clearCUBEOutputDistanceScalingFactorParameter (Base::ControlParameterContainer &cntnr)
	Removes the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter from cntnr. More...

Detailed Description

Contains classes and functions related to grid based data representation and processing.

Typedef Documentation

CDFBZ2DRegularGridInputHandler

typedef Util::DefaultDataInputHandler<CDFBZ2DRegularGridReader, DataFormat::CDF_BZ2> CDPL::Grid::CDFBZ2DRegularGridInputHandler

Handler for the input of bzip2-compressed regular spatial grid data in the native I/O format of the CDPL.

CDFBZ2DRegularGridOutputHandler

typedef Util::DefaultDataOutputHandler<CDFBZ2DRegularGridWriter, DataFormat::CDF_BZ2> CDPL::Grid::CDFBZ2DRegularGridOutputHandler

Handler for the output of bzip2-compressed regular spatial grid data in the native I/O format of the CDPL.

CDFBZ2DRegularGridReader

typedef Util::CompressedDataReader<CDFDRegularGridReader, Util::BZip2IStream> CDPL::Grid::CDFBZ2DRegularGridReader

Reader for bzip2-compressed regular spatial grid data in the native I/O format of the CDPL.

CDFBZ2DRegularGridSetInputHandler

typedef Util::DefaultDataInputHandler<CDFBZ2DRegularGridSetReader, DataFormat::CDF_BZ2> CDPL::Grid::CDFBZ2DRegularGridSetInputHandler

Handler for the input of bzip2-compressed regular spatial grid set data in the native I/O format of the CDPL.

CDFBZ2DRegularGridSetOutputHandler

typedef Util::DefaultDataOutputHandler<CDFBZ2DRegularGridSetWriter, DataFormat::CDF_BZ2> CDPL::Grid::CDFBZ2DRegularGridSetOutputHandler

Handler for the output of bzip2-compressed regular spatial grid set data in the native I/O format of the CDPL.

CDFBZ2DRegularGridSetReader

typedef Util::CompressedDataReader<CDFDRegularGridSetReader, Util::BZip2IStream> CDPL::Grid::CDFBZ2DRegularGridSetReader

Reader for bzip2-compressed regular spatial grid set data in the native I/O format of the CDPL.

CDFBZ2DRegularGridSetWriter

typedef Util::CompressedDataWriter<CDFDRegularGridSetWriter, Util::BZip2OStream> CDPL::Grid::CDFBZ2DRegularGridSetWriter

Writer for bzip2-compressed regular spatial grid set data in the native I/O format of the CDPL.

CDFBZ2DRegularGridWriter

typedef Util::CompressedDataWriter<CDFDRegularGridWriter, Util::BZip2OStream> CDPL::Grid::CDFBZ2DRegularGridWriter

Writer for bzip2-compressed regular spatial grid data in the native I/O format of the CDPL.

CDFDRegularGridInputHandler

typedef Util::DefaultDataInputHandler<CDFDRegularGridReader, DataFormat::CDF> CDPL::Grid::CDFDRegularGridInputHandler

Handler for the input of regular spatial grid data in the native I/O format of the CDPL.

CDFDRegularGridOutputHandler

typedef Util::DefaultDataOutputHandler<CDFDRegularGridWriter, DataFormat::CDF> CDPL::Grid::CDFDRegularGridOutputHandler

Handler for the output of regular spatial grid data in the native I/O format of the CDPL.

CDFDRegularGridSetInputHandler

typedef Util::DefaultDataInputHandler<CDFDRegularGridSetReader, DataFormat::CDF> CDPL::Grid::CDFDRegularGridSetInputHandler

Handler for the input of regular spatial grid set data in the native I/O format of the CDPL.

CDFDRegularGridSetOutputHandler

typedef Util::DefaultDataOutputHandler<CDFDRegularGridSetWriter, DataFormat::CDF> CDPL::Grid::CDFDRegularGridSetOutputHandler

Handler for the output of regular spatial grid set data in the native I/O format of the CDPL.

CDFGZDRegularGridInputHandler

typedef Util::DefaultDataInputHandler<CDFGZDRegularGridReader, DataFormat::CDF_GZ> CDPL::Grid::CDFGZDRegularGridInputHandler

Handler for the input of gzip-compressed regular spatial grid data in the native I/O format of the CDPL.

CDFGZDRegularGridOutputHandler

typedef Util::DefaultDataOutputHandler<CDFGZDRegularGridWriter, DataFormat::CDF_GZ> CDPL::Grid::CDFGZDRegularGridOutputHandler

Handler for the output of gzip-compressed regular spatial grid data in the native I/O format of the CDPL.

CDFGZDRegularGridReader

typedef Util::CompressedDataReader<CDFDRegularGridReader, Util::GZipIStream> CDPL::Grid::CDFGZDRegularGridReader

Reader for gzip-compressed regular spatial grid data in the native I/O format of the CDPL.

CDFGZDRegularGridSetInputHandler

typedef Util::DefaultDataInputHandler<CDFGZDRegularGridSetReader, DataFormat::CDF_GZ> CDPL::Grid::CDFGZDRegularGridSetInputHandler

Handler for the input of gzip-compressed regular spatial grid set data in the native I/O format of the CDPL.

CDFGZDRegularGridSetOutputHandler

typedef Util::DefaultDataOutputHandler<CDFGZDRegularGridSetWriter, DataFormat::CDF_GZ> CDPL::Grid::CDFGZDRegularGridSetOutputHandler

Handler for the output of gzip-compressed regular spatial grid set data in the native I/O format of the CDPL.

CDFGZDRegularGridSetReader

typedef Util::CompressedDataReader<CDFDRegularGridSetReader, Util::GZipIStream> CDPL::Grid::CDFGZDRegularGridSetReader

Reader for gzip-compressed regular spatial grid set data in the native I/O format of the CDPL.

CDFGZDRegularGridSetWriter

typedef Util::CompressedDataWriter<CDFDRegularGridSetWriter, Util::GZipOStream> CDPL::Grid::CDFGZDRegularGridSetWriter

Writer for gzip-compressed regular spatial grid set data in the native I/O format of the CDPL.

CDFGZDRegularGridWriter

typedef Util::CompressedDataWriter<CDFDRegularGridWriter, Util::GZipOStream> CDPL::Grid::CDFGZDRegularGridWriter

Writer for gzip-compressed regular spatial grid data in the native I/O format of the CDPL.

CUBEDRegularGridInputHandler

typedef Util::DefaultDataInputHandler<CUBEDRegularGridReader, DataFormat::CUBE> CDPL::Grid::CUBEDRegularGridInputHandler

Handler for the input of regular spatial grid data in the Gaussian CUBE [CUBE] format.

Since

1.4

CUBEDRegularGridOutputHandler

typedef Util::DefaultDataOutputHandler<CUBEDRegularGridWriter, DataFormat::CUBE> CDPL::Grid::CUBEDRegularGridOutputHandler

Handler for the output of regular spatial grid data in the Gaussian CUBE [CUBE] format.

Since

1.4

DRegularGridReader

typedef Util::MultiFormatDataReader<DRegularGrid> CDPL::Grid::DRegularGridReader

Reader for regular spatial grid data of type Grid::DRegularGrid in any supported format.

DRegularGridSetReader

typedef Util::MultiFormatDataReader<DRegularGridSet> CDPL::Grid::DRegularGridSetReader

Reader for regular spatial grid set data of type Grid::DRegularGridSet in any supported format.

DRegularGridSetWriter

typedef Util::MultiFormatDataWriter<DRegularGridSet> CDPL::Grid::DRegularGridSetWriter

Writer for regular spatial grid set data of type Grid::DRegularGridSet in any supported format.

DRegularGridWriter

typedef Util::MultiFormatDataWriter<DRegularGrid> CDPL::Grid::DRegularGridWriter

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

FRegularGrid

typedef RegularGrid<float> CDPL::Grid::FRegularGrid

A regular spatial grid storing single-precision floating-point values.

DRegularGrid

typedef RegularGrid<double> CDPL::Grid::DRegularGrid

A regular spatial grid storing double-precision floating-point values.

DRegularGridSet

typedef RegularGridSet<double> CDPL::Grid::DRegularGridSet

Convenience alias for the double-precision regular spatial grid sets.

FRegularGridSet

typedef RegularGridSet<float> CDPL::Grid::FRegularGridSet

Convenience alias for the single-precision regular spatial grid sets.

FSpatialGrid

typedef SpatialGrid<float> CDPL::Grid::FSpatialGrid

Convenience alias for the single-precision spatial-grid abstract base.

DSpatialGrid

typedef SpatialGrid<double> CDPL::Grid::DSpatialGrid

Convenience alias for the double-precision spatial-grid abstract base.

Function Documentation

getName()

CDPL_GRID_API const std::string& CDPL::Grid::getName

(

const AttributedGrid &

grid

)

Returns the value of the Grid::AttributedGridProperty::NAME property of the attributed grid grid.

Parameters

grid	The attributed grid for which to return the property value.

Returns

A const reference to the name.

setName()

CDPL_GRID_API void CDPL::Grid::setName	(	AttributedGrid &	grid,
		const std::string &	name
	)

Sets the value of the Grid::AttributedGridProperty::NAME property of the attributed grid grid to name.

Parameters

grid	The attributed grid for which to set the property value.
name	The new name.

clearName()

CDPL_GRID_API void CDPL::Grid::clearName

(

AttributedGrid &

grid

)

Clears the value of the Grid::AttributedGridProperty::NAME property of the attributed grid grid.

Parameters

grid	The attributed grid for which to clear the property value.

hasName()

CDPL_GRID_API bool CDPL::Grid::hasName

(

const AttributedGrid &

grid

)

Tells whether the Grid::AttributedGridProperty::NAME property of the attributed grid grid is set.

Parameters

grid	The attributed grid for which to query the property value.

Returns

true if the name property is set, and false otherwise.

getComment()

CDPL_GRID_API const std::string& CDPL::Grid::getComment

(

const AttributedGrid &

grid

)

Returns the value of the Grid::AttributedGridProperty::COMMENT property of the attributed grid grid.

Parameters

grid	The attributed grid for which to return the property value.

Returns

A const reference to the comment.

Since

1.4

setComment()

CDPL_GRID_API void CDPL::Grid::setComment	(	AttributedGrid &	grid,
		const std::string &	comment
	)

Sets the value of the Grid::AttributedGridProperty::COMMENT property of the attributed grid grid to comment.

Parameters

grid	The attributed grid for which to set the property value.
comment	The new comment.

Since

1.4

clearComment()

CDPL_GRID_API void CDPL::Grid::clearComment

(

AttributedGrid &

grid

)

Clears the value of the Grid::AttributedGridProperty::COMMENT property of the attributed grid grid.

Parameters

grid	The attributed grid for which to clear the property value.

Since

1.4

hasComment()

CDPL_GRID_API bool CDPL::Grid::hasComment

(

const AttributedGrid &

grid

)

Tells whether the Grid::AttributedGridProperty::COMMENT property of the attributed grid grid is set.

Parameters

grid	The attributed grid for which to query the property value.

Returns

true if the comment property is set, and false otherwise.

Since

1.4

getStrictErrorCheckingParameter()

CDPL_GRID_API bool CDPL::Grid::getStrictErrorCheckingParameter

(

const Base::ControlParameterContainer &

cntnr

)

Returns the value of the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter stored in cntnr.

Parameters

cntnr

The control-parameter container.

Returns

true if strict error checking is enabled, and false otherwise.

setStrictErrorCheckingParameter()

CDPL_GRID_API void CDPL::Grid::setStrictErrorCheckingParameter	(	Base::ControlParameterContainer &	cntnr,
		bool	strict
	)

Sets the value of the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr to strict.

Parameters

cntnr	The control-parameter container.
strict	true to enable strict error checking, and false to disable it.

hasStrictErrorCheckingParameter()

CDPL_GRID_API bool CDPL::Grid::hasStrictErrorCheckingParameter

(

const Base::ControlParameterContainer &

cntnr

)

Tells whether the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter of cntnr is set.

Parameters

cntnr

The control-parameter container.

Returns

true if the parameter is set, and false otherwise.

clearStrictErrorCheckingParameter()

CDPL_GRID_API void CDPL::Grid::clearStrictErrorCheckingParameter

(

Base::ControlParameterContainer &

cntnr

)

Removes the Grid::ControlParameter::STRICT_ERROR_CHECKING parameter from cntnr.

Parameters

cntnr

The control-parameter container.

getCDFOutputSinglePrecisionFloatsParameter()

CDPL_GRID_API bool CDPL::Grid::getCDFOutputSinglePrecisionFloatsParameter

(

const Base::ControlParameterContainer &

cntnr

)

Returns the value of the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter stored in cntnr.

Parameters

cntnr

The control-parameter container.

Returns

true if CDF output uses single-precision floats, and false otherwise.

Since

1.2

setCDFOutputSinglePrecisionFloatsParameter()

CDPL_GRID_API void CDPL::Grid::setCDFOutputSinglePrecisionFloatsParameter	(	Base::ControlParameterContainer &	cntnr,
		bool	single_prec
	)

Sets the value of the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntnr to single_prec.

Parameters

cntnr	The control-parameter container.
single_prec	true to write single-precision floats, and false to write double-precision floats.

Since

1.2

hasCDFOutputSinglePrecisionFloatsParameter()

CDPL_GRID_API bool CDPL::Grid::hasCDFOutputSinglePrecisionFloatsParameter

(

const Base::ControlParameterContainer &

cntnr

)

Tells whether the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter of cntnr is set.

Parameters

cntnr

The control-parameter container.

Returns

true if the parameter is set, and false otherwise.

Since

1.2

clearCDFOutputSinglePrecisionFloatsParameter()

CDPL_GRID_API void CDPL::Grid::clearCDFOutputSinglePrecisionFloatsParameter

(

Base::ControlParameterContainer &

cntnr

)

Removes the Grid::ControlParameter::CDF_OUTPUT_SINGLE_PRECISION_FLOATS parameter from cntnr.

Parameters

cntnr

The control-parameter container.

Since

1.2

getCUBECommentIsNameParameter()

CDPL_GRID_API bool CDPL::Grid::getCUBECommentIsNameParameter

(

const Base::ControlParameterContainer &

cntnr

)

Returns the value of the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter stored in cntnr.

Parameters

cntnr

The control-parameter container.

Returns

true if the Gaussian CUBE comment line is interpreted as the grid name, and false otherwise.

Since

1.4

setCUBECommentIsNameParameter()

CDPL_GRID_API void CDPL::Grid::setCUBECommentIsNameParameter	(	Base::ControlParameterContainer &	cntnr,
		bool	is_name
	)

Sets the value of the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter of cntnr to is_name.

Parameters

cntnr	The control-parameter container.
is_name	true to interpret the Gaussian CUBE comment line as the grid name, and false to treat it as a regular comment.

Since

1.4

hasCUBECommentIsNameParameter()

CDPL_GRID_API bool CDPL::Grid::hasCUBECommentIsNameParameter

(

const Base::ControlParameterContainer &

cntnr

)

Tells whether the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter of cntnr is set.

Parameters

cntnr

The control-parameter container.

Returns

true if the parameter is set, and false otherwise.

Since

1.4

clearCUBECommentIsNameParameter()

CDPL_GRID_API void CDPL::Grid::clearCUBECommentIsNameParameter

(

Base::ControlParameterContainer &

cntnr

)

Removes the Grid::ControlParameter::CUBE_COMMENT_IS_NAME parameter from cntnr.

Parameters

cntnr

The control-parameter container.

Since

1.4

getCUBEInputDistanceScalingFactorParameter()

CDPL_GRID_API double CDPL::Grid::getCUBEInputDistanceScalingFactorParameter

(

const Base::ControlParameterContainer &

cntnr

)

Returns the value of the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter stored in cntnr.

Parameters

cntnr

The control-parameter container.

Returns

The input distance scaling factor.

Since

1.4

setCUBEInputDistanceScalingFactorParameter()

CDPL_GRID_API void CDPL::Grid::setCUBEInputDistanceScalingFactorParameter	(	Base::ControlParameterContainer &	cntnr,
		double	factor
	)

Sets the value of the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter of cntnr to factor.

Parameters

cntnr	The control-parameter container.
factor	The new input distance scaling.

Since

1.4

hasCUBEInputDistanceScalingFactorParameter()

CDPL_GRID_API bool CDPL::Grid::hasCUBEInputDistanceScalingFactorParameter

(

const Base::ControlParameterContainer &

cntnr

)

Tells whether the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter of cntnr is set.

Parameters

cntnr

The control-parameter container.

Returns

true if the parameter is set, and false otherwise.

Since

1.4

clearCUBEInputDistanceScalingFactorParameter()

CDPL_GRID_API void CDPL::Grid::clearCUBEInputDistanceScalingFactorParameter

(

Base::ControlParameterContainer &

cntnr

)

Removes the Grid::ControlParameter::CUBE_INPUT_DISTANCE_SCALING_FACTOR parameter from cntnr.

Parameters

cntnr

The control-parameter container.

Since

1.4

getCUBEOutputDistanceScalingFactorParameter()

CDPL_GRID_API double CDPL::Grid::getCUBEOutputDistanceScalingFactorParameter

(

const Base::ControlParameterContainer &

cntnr

)

Returns the value of the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter stored in cntnr.

Parameters

cntnr

The control-parameter container.

Returns

The output distance scaling factor.

Since

1.4

setCUBEOutputDistanceScalingFactorParameter()

CDPL_GRID_API void CDPL::Grid::setCUBEOutputDistanceScalingFactorParameter	(	Base::ControlParameterContainer &	cntnr,
		double	factor
	)

Sets the value of the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter of cntnr to factor.

Parameters

cntnr	The control-parameter container.
factor	The new output distance scaling factor.

Since

1.4

hasCUBEOutputDistanceScalingFactorParameter()

CDPL_GRID_API bool CDPL::Grid::hasCUBEOutputDistanceScalingFactorParameter

(

const Base::ControlParameterContainer &

cntnr

)

Tells whether the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter of cntnr is set.

Parameters

cntnr

The control-parameter container.

Returns

true if the parameter is set, and false otherwise.

Since

1.4

clearCUBEOutputDistanceScalingFactorParameter()

CDPL_GRID_API void CDPL::Grid::clearCUBEOutputDistanceScalingFactorParameter

(

Base::ControlParameterContainer &

cntnr

)

Removes the Grid::ControlParameter::CUBE_OUTPUT_DISTANCE_SCALING_FACTOR parameter from cntnr.

Parameters

cntnr

The control-parameter container.

Since

1.4