tecplot::toolbox::AuxData Class Reference

#include <AuxData.h>

---

Detailed Description

The AuxData class may be used in place of TecUtilAuxData functions.

Public Member Functions
	AuxData (const AuxDataLocation_e auxDataLocation, const EntIndex_t zoneOrMapOrVariable=1)
	Create an AuxData object to manipulate AuxData.
virtual	~AuxData ()
virtual bool	isValid () const
	Determine if the AuxData object is valid.
virtual AuxData_pa	getRef () const
	The AuxData_pa reference associated with this item.
virtual bool	set (std::string name, const char *value, bool retain=true) const
	Set an AuxData name value pair in Tecplot.
virtual bool	set (std::string name, std::string value, bool retain=true) const
virtual bool	set (std::string name, LgIndex_t value, bool retain=true) const
	Set an AuxData name value pair in Tecplot.
virtual bool	set (std::string name, double value, bool retain=true) const
	Set an AuxData name value pair in Tecplot.
virtual bool	set (std::string name, bool value, bool retain=true) const
	Set an AuxData name value pair in Tecplot.
virtual bool	set (std::string name, const Set &value, bool retain=true) const
	Set an AuxData name value pair in Tecplot.
template<typename T>
bool	get (std::string name, T *value, bool *retain=NULL) const
	Get AuxData from Tecplot, by name.
virtual void	get (LgIndex_t index, std::string *value, std::string *name=NULL, bool *retain=NULL) const
	Get AuxData from Tecplot, by index.
virtual void	get (LgIndex_t index, LgIndex_t *value, std::string *name=NULL, bool *retain=NULL) const
	Get AuxData from Tecplot, by index.
virtual void	get (LgIndex_t index, double *value, std::string *name=NULL, bool *retain=NULL) const
	Get AuxData from Tecplot, by index.
virtual void	get (LgIndex_t index, bool *value, std::string *name=NULL, bool *retain=NULL) const
	Get AuxData from Tecplot, by index.
virtual void	get (LgIndex_t index, Set *value, std::string *name=NULL, bool *retain=NULL) const
	Get AuxData from Tecplot, by index.
virtual void	remove (LgIndex_t index) const
	Delete an AuxData item from Tecplot at a particular index.
virtual bool	remove (std::string name) const
	Delete an AuxData item from Tecplot with a particular name.
virtual bool	getIndex (std::string name, LgIndex_t *index) const
	Get the index from Tecplot of a named AuxData item.
virtual LgIndex_t	size () const
	Get the current number of auxiliary data items.
AuxDataLocation_e	getAuxDataLocation () const
	Get the auxiliary data location association.
EntIndex_t	getZoneOrMapOrVarIndex () const
	Get the zone, variable, line map, frame, or page association.

---

Constructor & Destructor Documentation

tecplot::toolbox::AuxData::AuxData	(	const AuxDataLocation_e	auxDataLocation,
		const EntIndex_t	zoneOrMapOrVariable = 1
	)

Create an AuxData object to manipulate AuxData.

Parameters:

	auxDataLocation	A valid AuxDataLocation_e must be passed.
	zoneOrMapOrVariable	The Zone, Map, or Variable number associated with the auxDataLocation. This parameter is required if auxDataLocation is one of: AuxDataLocation_Zone AuxDataLocation_Var AuxDataLocation_LineMap Note that this object maintains the same zone, map, variable number regardless of whether new zones/maps/variables are added or deleted. So let's look at the following situation: 1) You have a dataset with 3 zones. 2) You create an AuxData object - AuxData(AuxDataLocation_Zone, 2); 3) Zone 1 is deleted. The zone numbers are shifted so zone 2 becomes zone 1 and zone 3 becomes zone 2. 4) The AuxData object created in step 2 will continue to affect zone 2, which is what used to be zone 3.

See also:

AuxData::isValid

virtual tecplot::toolbox::AuxData::~AuxData

(

)

[virtual]

---

Member Function Documentation

virtual bool tecplot::toolbox::AuxData::isValid

(

)

const [virtual]

Determine if the AuxData object is valid.

An AuxData object may become invalid if the AuxDataLocation is Zone,LineMap, or Variable and the assigned Zone, LineMap, or Variable no longer exists. If the AuxDataLocation is DataSet, the object will be invalid for frames without a dataset.

Returns:

true if the object is valid, false otherwise.

virtual AuxData_pa tecplot::toolbox::AuxData::getRef

(

)

const [virtual]

The AuxData_pa reference associated with this item.

Returns:

Reference to the auxiliary data associated with this object.

virtual bool tecplot::toolbox::AuxData::set	(	std::string	name,
		const char *	value,
		bool	retain = true
	)			const [virtual]

Set an AuxData name value pair in Tecplot.

Note:

Tecplot must be locked when using this method.

Parameters:

	name	Name of the AuxData. A valid name must start with an '_' or alpha character and may be followed by one or more '_', '.', alpha or digit characters.
	value	String value to set for the item
	retain	A flag specifying whether or not to retain this item on file export, such as to a Tecplot datafile.

Returns:

true if the value was set, false otherwise.

virtual bool tecplot::toolbox::AuxData::set	(	std::string	name,
		std::string	value,
		bool	retain = true
	)			const [inline, virtual]

virtual bool tecplot::toolbox::AuxData::set	(	std::string	name,
		LgIndex_t	value,
		bool	retain = true
	)			const [virtual]

Set an AuxData name value pair in Tecplot.

Note:

Tecplot must be locked when using this method.

Note:

AuxData can only handle strings, so the LgIndex_t value will be stored internally as a string.

Parameters:

	name	Name of the AuxData. A valid name must start with an '_' or alpha character and may be followed by one or more '_', '.', alpha or digit characters.
	value	LgIndex_t value to set for the item
	retain	A flag specifying whether or not to retain this item on file export, such as to a Tecplot datafile.

Returns:

true if the value was set, false otherwise.

virtual bool tecplot::toolbox::AuxData::set	(	std::string	name,
		double	value,
		bool	retain = true
	)			const [virtual]

Set an AuxData name value pair in Tecplot.

Note:

Tecplot must be locked when using this method.

Note:

AuxData can only handle strings, so the double value will be stored internally as a string. Some precision may be lost.

Parameters:

	name	Name of the AuxData. A valid name must start with an '_' or alpha character and may be followed by one or more '_', '.', alpha or digit characters.
	value	Double value to set for the item
	retain	A flag specifying whether or not to retain this item on file export, such as to a Tecplot datafile.

Returns:

true if the value was set, false otherwise.

virtual bool tecplot::toolbox::AuxData::set	(	std::string	name,
		bool	value,
		bool	retain = true
	)			const [virtual]

Set an AuxData name value pair in Tecplot.

Note:

Tecplot must be locked when using this method.

Note:

AuxData can only handle strings, so the bool value will be stored internally as a string. The string values used are "true" and "false".

Parameters:

	name	Name of the AuxData. A valid name must start with an '_' or alpha character and may be followed by one or more '_', '.', alpha or digit characters.
	value	LgIndex_t value to set for the item
	retain	A flag specifying whether or not to retain this item on file export, such as to a Tecplot datafile.

Returns:

true if the value was set, false otherwise.

virtual bool tecplot::toolbox::AuxData::set	(	std::string	name,
		const Set &	value,
		bool	retain = true
	)			const [virtual]

Set an AuxData name value pair in Tecplot.

Note:

Tecplot must be locked when using this method.

Note:

AuxData can only handle strings, so the Set value will be stored internally as a string. See Set::toString

Parameters:

	name	Name of the AuxData. A valid name must start with an '_' or alpha character and may be followed by one or more '_', '.', alpha or digit characters.
	value	LgIndex_t value to set for the item
	retain	A flag specifying whether or not to retain this item on file export, such as to a Tecplot datafile.

Returns:

true if the value was set, false otherwise.

template<typename T>

bool tecplot::toolbox::AuxData::get	(	std::string	name,
		T *	value,
		bool *	retain = NULL
	)			const [inline]

Get AuxData from Tecplot, by name.

Parameters:

	name	Name of the AuxData item you wish to get. Non case-sensitive.
	value	Pointer to one of the types supported by AuxData::getAt. These are: std::string*, double*, LgIndex_t*, bool*, Set*
	retain	A bool pointer to retrieve the retain value. You may pass NULL if you do not wish to receive this value.

Returns:

true if the item could be found, false otherwise.

virtual void tecplot::toolbox::AuxData::get	(	LgIndex_t	index,
		std::string *	value,
		std::string *	name = NULL,
		bool *	retain = NULL
	)			const [virtual]

Get AuxData from Tecplot, by index.

Parameters:

	index	Index of the AuxData item you wish to get. index must be greater than or equal to 1 and less than or equal to AuxData::size()
	value	A std::string pointer to receive a string representation of the value.
	name	A std::string pointer to retrieve AuxData name associated with the index. You may pass NULL if you do not wish to receive this value.
	retain	A bool pointer to retrieve the retain value. You may pass NULL if you do not wish to receive this value.

virtual void tecplot::toolbox::AuxData::get	(	LgIndex_t	index,
		LgIndex_t *	value,
		std::string *	name = NULL,
		bool *	retain = NULL
	)			const [virtual]

Get AuxData from Tecplot, by index.

Parameters:

	index	Index of the AuxData item you wish to get. index must be greater than or equal to 1 and less than or equal to AuxData::size()
	value	A LgIndex_t pointer to receive the value. Note that AuxData is maintained as a string so the LgIndex_t value will be converted from a string.
	name	A std::string pointer to retrieve AuxData name associated with the index. You may pass NULL if you do not wish to receive this value. If the conversion is not successful value will be zero.
	retain	A bool pointer to retrieve the retain value. You may pass NULL if you do not wish to receive this value.

virtual void tecplot::toolbox::AuxData::get	(	LgIndex_t	index,
		double *	value,
		std::string *	name = NULL,
		bool *	retain = NULL
	)			const [virtual]

Get AuxData from Tecplot, by index.

Parameters:

	index	Index of the AuxData item you wish to get. index must be greater than or equal to 1 and less than or equal to AuxData::size()
	value	A double pointer to receive the value. Note that AuxData is maintained as a string so the double value will be converted from a string. If the conversion is not successful value will be zero.
	name	A std::string pointer to retrieve AuxData name associated with the index. You may pass NULL if you do not wish to receive this value.
	retain	A bool pointer to retrieve the retain value. You may pass NULL if you do not wish to receive this value.

virtual void tecplot::toolbox::AuxData::get	(	LgIndex_t	index,
		bool *	value,
		std::string *	name = NULL,
		bool *	retain = NULL
	)			const [virtual]

Get AuxData from Tecplot, by index.

Parameters:

	index	Index of the AuxData item you wish to get. index must be greater than or equal to 1 and less than or equal to AuxData::size()
	value	A bool pointer to receive the value. Note that AuxData is maintained as a string so the bool value will be converted from a string. If the string does not represent a boolean, value will default to false. Supported strings that represent a true result are (not case-sensitive): "TRUE", "T", "1", "ON", "YES"
	name	A std::string pointer to retrieve AuxData name associated with the index. You may pass NULL if you do not wish to receive this value.
	retain	A bool pointer to retrieve the retain value. You may pass NULL if you do not wish to receive this value.

virtual void tecplot::toolbox::AuxData::get	(	LgIndex_t	index,
		Set *	value,
		std::string *	name = NULL,
		bool *	retain = NULL
	)			const [virtual]

Get AuxData from Tecplot, by index.

Parameters:

	index	Index of the AuxData item you wish to get. index must be greater than or equal to 1 and less than or equal to AuxData::size()
	value	A Set pointer to receive the value. Note that AuxData is maintained as a string so the Set contents will be derived from a string. If the conversion is not successful Set will be empty.
	name	A std::string pointer to retrieve AuxData name associated with the index. You may pass NULL if you do not wish to receive this value.
	retain	A bool pointer to retrieve the retain value. You may pass NULL if you do not wish to receive this value.

virtual void tecplot::toolbox::AuxData::remove

(

LgIndex_t

index

)

const [virtual]

Delete an AuxData item from Tecplot at a particular index.

Note:

Tecplot must be locked when using this method.

Parameters:

index

Index of the item you wish to delete. Index must be greater than or equal to 1 and less than or equal to AuxData::size()

virtual bool tecplot::toolbox::AuxData::remove

(

std::string

name

)

const [virtual]

Delete an AuxData item from Tecplot with a particular name.

Note:

Tecplot must be locked when using this method.

Parameters:

name

Name of the item you wish to delete. Non case-sensitive. Name must be a valid string with non-zero length.

Returns:

Returns true if an item was deleted, false otherwise.

virtual bool tecplot::toolbox::AuxData::getIndex	(	std::string	name,
		LgIndex_t *	index
	)			const [virtual]

Get the index from Tecplot of a named AuxData item.

Parameters:

	name	Name of the item for which you wish to get the index. Non case-sensitive. Name must be a valid string with non-zero length.
	index	LgIndex_t pointer to receive the index value.

Returns:

Returns true if an item was deleted, false otherwise.

virtual LgIndex_t tecplot::toolbox::AuxData::size

(

)

const [virtual]

Get the current number of auxiliary data items.

Returns:

Number of items maintain by the auxiliary data.

AuxDataLocation_e tecplot::toolbox::AuxData::getAuxDataLocation

(

)

const [inline]

Get the auxiliary data location association.

Returns:

The location with which this object is associated.

EntIndex_t tecplot::toolbox::AuxData::getZoneOrMapOrVarIndex

(

)

const [inline]

Get the zone, variable, line map, frame, or page association.

Returns:

The 1-based index of the zone, variable, line map, frame, or page with which this object is associated.