tecplot::toolbox::ArgList Class Reference

#include <ArgList.h>

---

Detailed Description

ArgList should be used with TecUtil functions that take the ArgList_pa type.

Public Member Functions
	ArgList ()
	Create an empty ArgList object.
virtual	~ArgList ()
virtual bool	appendArbParam (std::string name, ArbParam_t value)
	Append an ArbParam_t to an argument list.
virtual bool	appendArbParamPtr (std::string name, ArbParam_t *value)
	Append an ArbParam_t pointer to an argument list.
virtual bool	appendArray (std::string name, const void *data)
	Append an array to an argument list.
template<typename T>
bool	appendArray (std::string name, const T *data)
	Append an array to an argument list.
template<typename T>
bool	appendArray (std::string name, const std::vector< T > &data)
	Append a vector to an argument list.
virtual bool	appendDouble (std::string name, double value)
	Append a double to an argument list.
virtual bool	appendDoublePtr (std::string name, double *value)
	Append a double pointer to an argument list.
virtual bool	appendFunction (std::string name, const void *function)
	Append a function to an argument list.
virtual bool	appendInt (std::string name, LgIndex_t value)
	Append an integer value to an argument list.
virtual bool	appendSet (std::string name, const Set &set)
	Append a set to an argument list.
virtual bool	appendString (std::string name, std::string value)
	Append a string to an argument list.
virtual bool	appendStringList (std::string name, const StringList &stringList)
	Append a named string list to an argument list.
virtual void	clear ()
	Removes all entries in the argument list.
virtual ArgList_pa	getRef () const
	Get the ArgList_pa which is managed by this object.

---

Constructor & Destructor Documentation

tecplot::toolbox::ArgList::ArgList

(

)

Create an empty ArgList object.

Exceptions:

OutOfMemoryException

OutOfMemoryException is thrown if the ArgList could not be allocated.

virtual tecplot::toolbox::ArgList::~ArgList

(

)

[virtual]

---

Member Function Documentation

virtual bool tecplot::toolbox::ArgList::appendArbParam	(	std::string	name,
		ArbParam_t	value
	)			[virtual]

Append an ArbParam_t to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	value	ArbParam_t associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

Referenced by tecplot::toolbox::StyleValue::setFinalValue().

virtual bool tecplot::toolbox::ArgList::appendArbParamPtr	(	std::string	name,
		ArbParam_t *	value
	)			[virtual]

Append an ArbParam_t pointer to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	value	ArbParam_t pointer associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

Referenced by tecplot::toolbox::StyleValue::getFinalValue().

virtual bool tecplot::toolbox::ArgList::appendArray	(	std::string	name,
		const void *	data
	)			[virtual]

Append an array to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	data	Array of data associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

template<typename T>

bool tecplot::toolbox::ArgList::appendArray	(	std::string	name,
		const T *	data
	)			[inline]

Append an array to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	data	Array of data associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

References TecUtilArgListAppendArray(), and TRUE.

template<typename T>

bool tecplot::toolbox::ArgList::appendArray	(	std::string	name,
		const std::vector< T > &	data
	)			[inline]

Append a vector to an argument list.

Can be used in place of appendArray.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	data	Vector of data associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

References TecUtilArgListAppendArray(), and TRUE.

virtual bool tecplot::toolbox::ArgList::appendDouble	(	std::string	name,
		double	value
	)			[virtual]

Append a double to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	value	Value associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

Referenced by tecplot::toolbox::StyleValue::setFinalValue().

virtual bool tecplot::toolbox::ArgList::appendDoublePtr	(	std::string	name,
		double *	value
	)			[virtual]

Append a double pointer to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	value	Double pointer associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

virtual bool tecplot::toolbox::ArgList::appendFunction	(	std::string	name,
		const void *	function
	)			[virtual]

Append a function to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	function	Function pointer associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

virtual bool tecplot::toolbox::ArgList::appendInt	(	std::string	name,
		LgIndex_t	value
	)			[virtual]

Append an integer value to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	value	Value associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

virtual bool tecplot::toolbox::ArgList::appendSet	(	std::string	name,
		const Set &	set
	)			[virtual]

Append a set to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	set	Set associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

virtual bool tecplot::toolbox::ArgList::appendString	(	std::string	name,
		std::string	value
	)			[virtual]

Append a string to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	value	String value associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

virtual bool tecplot::toolbox::ArgList::appendStringList	(	std::string	name,
		const StringList &	stringList
	)			[virtual]

Append a named string list to an argument list.

Parameters:

	name	Parameter name. Use the SV_constants listed with the extended function.
	stringList	String List associated with the parameter name.

Returns:

Returns true if append is successful, false otherwise.

virtual void tecplot::toolbox::ArgList::clear

(

)

[virtual]

Removes all entries in the argument list.

Returns:

Returns a reference to the ArgList_pa type.

virtual ArgList_pa tecplot::toolbox::ArgList::getRef

(

)

const [virtual]

Get the ArgList_pa which is managed by this object.

The ArgList_pa type is used with many TecUtil functions. ArgList_pa must not be deallocated.

Returns:

Returns a reference to the ArgList_pa type.