CVEX_ValueList Class Reference

List of input or output values for a CVEX_Context. More...

#include <CVEX_ValueList.h>

List of all members.

Public Member Functions
	CVEX_ValueList ()
	~CVEX_ValueList ()
int	entries ()
	Returns the number of values in the list.
CVEX_Value *	getValue (int i)
	Get a value by index.
CVEX_Value *	getValue (const char *name, CVEX_Type type)
	Get a value by name (may return null if the parameter isn't defined).
bool	addValue (const char *name, CVEX_Type type, bool varying)
bool	addValue (const char *name, CVEX_Type type, void *data, int array_size)
bool	addValue (const char *name, UT_StringArray &strings)
Friends
class	CVEX_Context

---

Detailed Description

List of input or output values for a CVEX_Context.

This class maintains a list of the input and output parameters for a CVEX context.

Both input and output variables are associated with parameters on the VEX function being run. Output variables are those flagged with the export keyword.

Examples:

CVEX/cvexsample.C.

Definition at line 35 of file CVEX_ValueList.h.

---

Constructor & Destructor Documentation

CVEX_ValueList::CVEX_ValueList

(

)

CVEX_ValueList::~CVEX_ValueList

(

)

---

Member Function Documentation

bool CVEX_ValueList::addValue	(	const char *	name,
		UT_StringArray &	strings
	)

Add a string value (with data)

Note:

Users should call CVEX_Context::addInput()

bool CVEX_ValueList::addValue	(	const char *	name,
		CVEX_Type	type,
		void *	data,
		int	array_size
	)

Add a value by name, type and provide data.

Note:

Users should call CVEX_Context::addInput()

bool CVEX_ValueList::addValue	(	const char *	name,
		CVEX_Type	type,
		bool	varying
	)

Add a value by name type and varying flag. This fails if:

• There's already a symbol with the name
• The type is invalid

  Note:

  Users should call CVEX_Context::addInput()

int CVEX_ValueList::entries

(

)

[inline]

Returns the number of values in the list.

Examples:

CVEX/cvexsample.C.

Definition at line 41 of file CVEX_ValueList.h.

CVEX_Value* CVEX_ValueList::getValue	(	const char *	name,
		CVEX_Type	type
	)

Get a value by name (may return null if the parameter isn't defined).

CVEX_Value* CVEX_ValueList::getValue

(

int

i

)

[inline]

Get a value by index.

Examples:

CVEX/cvexsample.C.

Definition at line 44 of file CVEX_ValueList.h.

---

Friends And Related Function Documentation

friend class CVEX_Context [friend]

Definition at line 70 of file CVEX_ValueList.h.

---

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

• CVEX/CVEX_ValueList.h