PRM_Name Class Reference

#include <PRM_Name.h>

Inheritance diagram for PRM_Name:

List of all members.

Public Member Functions
	PRM_Name (const char *thetoken=0, const char *thelabel=0, int theflags=0)
virtual	~PRM_Name ()
const char *	getToken () const
const char *	getLabel () const
int	getExpressionFlag () const
unsigned	getHash () const
void	setToken (const char *s)
void	setLabel (const char *s)
void	harden ()
void	instance (const int *instance, int num)
void	instance (const UT_IntArray &instance_num)
bool	isValidChoice () const
Static Public Attributes
static const char *	mySeparator
static unsigned	theSentinelHash

---

Detailed Description

Examples:

CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, CHOP/CHOP_Stair.C, COP2/COP2_FullImageFilter.C, COP2/COP2_MultiInputWipe.C, COP2/COP2_PixelAdd.C, COP2/COP2_SampleFilter.C, COP2/COP2_SampleGenerator.C, DOP/DOP_GroupAndApply.C, euclid/SOP_Euclid.C, field3d/ROP_Field3D.C, OBJ/OBJ_Shake.C, OBJ/OBJ_WorldAlign.C, POP/POP_CircleForce.C, POP/POP_LocalForce.C, POP/POP_RadialBirth.C, POP/POP_SpotLight.C, ROP/ROP_DopField.C, ROP/ROP_Dumper.C, SIM/SIM_ElectricalProperties.C, SIM/SIM_ForceOrbit.C, SIM/SIM_GasAdd.C, SIM/SNOW_Solver.C, SOP/MSS_BrushHairLen.C, SOP/SOP_BrushHairLen.C, SOP/SOP_CopRaster.C, SOP/SOP_CopRaster.h, SOP/SOP_CustomBrush.C, SOP/SOP_DetailAttrib.C, SOP/SOP_Flatten.C, SOP/SOP_GroupRename.C, SOP/SOP_HDKObject.C, SOP/SOP_IKSample.C, SOP/SOP_PointWave.C, SOP/SOP_PrimVOP.C, SOP/SOP_SParticle.C, SOP/SOP_Star.C, SOP/SOP_Surface.C, SOP/SOP_TimeCompare.C, VOP/VOP_CustomContext.C, and VOP/VOP_Switch.C.

Definition at line 28 of file PRM_Name.h.

---

Constructor & Destructor Documentation

PRM_Name::PRM_Name	(	const char *	thetoken = 0,
		const char *	thelabel = 0,
		int	theflags = 0
	)

If thelabel is set to 0, then the thetoken is used as the label. Currently the flags parameter is only used for the parm expression flag. Set theflags to 1 to make the parm default to expression mode.

virtual PRM_Name::~PRM_Name

(

)

[virtual]

---

Member Function Documentation

int PRM_Name::getExpressionFlag

(

void

)

const [inline]

Definition at line 46 of file PRM_Name.h.

unsigned PRM_Name::getHash

(

)

const [inline]

Definition at line 47 of file PRM_Name.h.

const char* PRM_Name::getLabel

(

)

const [inline]

Definition at line 42 of file PRM_Name.h.

const char* PRM_Name::getToken

(

)

const [inline]

Examples:

CHOP/CHOP_Stair.C, and DOP/DOP_GroupAndApply.C.

Definition at line 41 of file PRM_Name.h.

void PRM_Name::harden

(

)

Examples:

OBJ/OBJ_WorldAlign.C.

void PRM_Name::instance

(

const UT_IntArray &

instance_num

)

void PRM_Name::instance	(	const int *	instance,
		int	num
	)

bool PRM_Name::isValidChoice

(

)

const [inline]

Definition at line 56 of file PRM_Name.h.

void PRM_Name::setLabel

(

const char *

s

)

Examples:

SOP/SOP_CopRaster.C.

void PRM_Name::setToken

(

const char *

s

)

Examples:

SOP/SOP_CopRaster.C.

---

Member Data Documentation

const char* PRM_Name::mySeparator [static]

Definition at line 64 of file PRM_Name.h.

unsigned PRM_Name::theSentinelHash [static]

Definition at line 66 of file PRM_Name.h.

---

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

• PRM/PRM_Name.h