Overture: DisplayParameters Class Reference

Overture Version 25

#include <DisplayParameters.h>

Public Types
enum	DisplayOption { intFormat, floatFormat, doubleFormat, labelAllIndicies, labelNoIndicies, labelIndex, forwardOrdering, backwardOrdering, strideForAllIndicies, indexStride }

Public Member Functions
	DisplayParameters ()

	~DisplayParameters ()

int	set (FILE *file)

int	set (const DisplayOption &displayOption)

int	set (const DisplayOption &displayOption, const int &value)

int	set (const DisplayOption &displayOption, const aString &value)

int	set (const DisplayOption &displayOption, const int &index, const int &value)

Protected Attributes
FILE *	file

aString	iFormat

aString	fFormat

aString	dFormat

int	indexLabel [MAX_ARRAY_DIMENSION]

bool	ordering

int	stride [MAX_ARRAY_DIMENSION]

Friends
class	intGridCollectionFunction

class	floatGridCollectionFunction

class	doubleGridCollectionFunction

int	display (const intArray &x, const char label, FILE file, const char format_, const DisplayParameters displayParameters, const Index *Iv)

int	display (const floatArray &x, const char label, FILE file, const char format_, const DisplayParameters displayParameters, const Index *Iv)

int	display (const doubleArray &x, const char label, FILE file, const char format_, const DisplayParameters displayParameters, const Index *Iv)

int	displayMaskPrivate (const intArray &mask, const aString &label, FILE file, const DisplayParameters displayParameters, const Index *Iv)

Member Enumeration Documentation

enum DisplayParameters::DisplayOption

Enumerator
intFormat
floatFormat
doubleFormat
labelAllIndicies
labelNoIndicies
labelIndex
forwardOrdering
backwardOrdering
strideForAllIndicies
indexStride

Constructor & Destructor Documentation

DisplayParameters::DisplayParameters ( )

References assert, dFormat, fFormat, file, iFormat, indexLabel, ordering, and stride.

DisplayParameters::~DisplayParameters ( )

Member Function Documentation

int DisplayParameters::set ( FILE * file )

References file, and NULL.

Referenced by displayMaskPrivate(), fileOutput(), main(), FileOutput::save(), and FileOutput::update().

int DisplayParameters::set ( const DisplayOption & displayOption )

References backwardOrdering, forwardOrdering, indexLabel, labelAllIndicies, labelNoIndicies, and ordering.

int DisplayParameters::set	(	const DisplayOption &	displayOption,
		const int &	value
	)

References stride, and strideForAllIndicies.

int DisplayParameters::set	(	const DisplayOption &	displayOption,
		const aString &	value
	)

References dFormat, doubleFormat, fFormat, floatFormat, iFormat, and intFormat.

int DisplayParameters::set	(	const DisplayOption &	displayOption,
		const int &	index,
		const int &	value
	)

References indexLabel, indexStride, labelIndex, and stride.

Friends And Related Function Documentation

int display	(	const intArray &	x,
		const char *	label,
		FILE *	file,
		const char *	format_,
		const DisplayParameters *	displayParameters,
		const Index *	Iv
	)

friend

int display	(	const floatArray &	x,
		const char *	label,
		FILE *	file,
		const char *	format_,
		const DisplayParameters *	displayParameters,
		const Index *	Iv
	)

friend

int display	(	const doubleArray &	x,
		const char *	label,
		FILE *	file,
		const char *	format_,
		const DisplayParameters *	displayParameters,
		const Index *	Iv
	)

friend

int displayMaskPrivate	(	const intArray &	mask,
		const aString &	label,
		FILE *	file,
		const DisplayParameters *	displayParameters,
		const Index *	Iv
	)

friend

friend class doubleGridCollectionFunction

friend

friend class floatGridCollectionFunction

friend

friend class intGridCollectionFunction

friend

Member Data Documentation

aString DisplayParameters::dFormat

protected

Referenced by display(), DisplayParameters(), and set().

aString DisplayParameters::fFormat

protected

Referenced by display(), DisplayParameters(), and set().

FILE* DisplayParameters::file

protected

Referenced by display(), displayMaskPrivate(), DisplayParameters(), and set().

aString DisplayParameters::iFormat

protected

Referenced by display(), DisplayParameters(), and set().

int DisplayParameters::indexLabel[MAX_ARRAY_DIMENSION]

protected

Referenced by display(), displayMaskPrivate(), DisplayParameters(), and set().

bool DisplayParameters::ordering

protected

Referenced by display(), displayMaskPrivate(), DisplayParameters(), and set().

int DisplayParameters::stride[MAX_ARRAY_DIMENSION]

protected

Referenced by display(), DisplayParameters(), and set().

The documentation for this class was generated from the following files: