#include <PRM_Name.h>

Inheritance diagram for PRM_Name:

Public Types
enum	PRM_NameCopy { COPY }

Public Member Functions
	PRM_Name ()
	Default PRM_Name constructor is a sentinel value. More...

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

	PRM_Name (PRM_NameCopy, const UT_StringHolder &thetoken, const UT_StringHolder &thelabel, int theflags=0)
	Constructor for doing deep copies of the strings. More...

bool	isSentinel () const
	Check if this is a sentinel. More...

void	setAsSentinel ()
	Set to a sentinel value. More...

void	setAsSeparator ()
	Set to a separator value. More...

const char *	getToken () const

const char *	getLabel () const

int	getExpressionFlag () const

unsigned	getHash () const

	operator const UT_StringRef & () const
	Use this for the common use of passing the token to a function. More...

const UT_StringRef &	getTokenRef () const
	Use this for hash tables, might be the sentinel value. More...

const UT_StringRef &	getLabelRef () const
	Get label UT_StringRef &, might be the sentinel value. More...

void	harden ()
	Do a deep copy of its internal references. More...

void	setToken (const char *s)
	Sets the token, doing a deep copy. More...

void	setLabel (const char *s)
	Sets the label, doing a deep copy. More...

void	setTokenAndLabel (const char token, const char label)
	Sets the token and label, doing deep copies. More...

void	setTokenAndLabelRef (const UT_StringRef &token, const UT_StringRef &label)
	Sets the token and label, doing shallow copies. More...

void	instance (const int *instance, int num)

void	instance (const UT_IntArray &instance_num)

bool	isValidChoice () const
	Returns if this a valid menu choice. More...

int64	getMemoryUsage (bool inclusive) const

Static Public Member Functions
static void	instanceToken (UT_String &token, const int *instance, int num)

static void	instanceToken (UT_String &token, const UT_IntArray &instance_num)

static void	instanceToken (UT_WorkBuffer &result, const UT_StringRef &token, const int *instance, int num)

static void	instanceToken (UT_WorkBuffer &result, const UT_StringRef &token, const UT_IntArray &instance_num)

Static Public Attributes
static const char *const	mySeparator

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, ROP/ROP_Dumper.C, SHOP/SHOP_Multi.C, SHOP/SHOP_POVMaterial.C, SIM/GAS_NetVDBSliceExchange.C, SIM/SIM_ElectricalProperties.C, SIM/SIM_ForceOrbit.C, SIM/SIM_GasAdd.C, SIM/SIM_RadialEmit.C, SIM/SNOW_Solver.C, SOP/MSS_BrushHairLen.C, SOP/SOP_ArrayAttrib.C, SOP/SOP_BouncyAgent.C, SOP/SOP_BrushHairLen.C, SOP/SOP_CopRaster.C, SOP/SOP_CopRaster.h, SOP/SOP_CustomBrush.C, SOP/SOP_DetailAttrib.C, SOP/SOP_DualStar.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_Surface.C, SOP/SOP_TimeCompare.C, VOP/VOP_CustomContext.C, and VOP/VOP_Switch.C.

Definition at line 24 of file PRM_Name.h.

Member Enumeration Documentation

enum PRM_Name::PRM_NameCopy

Enumerator
COPY

Definition at line 50 of file PRM_Name.h.

Constructor & Destructor Documentation

PRM_Name::PRM_Name ( )

inline

Default PRM_Name constructor is a sentinel value.

Definition at line 29 of file PRM_Name.h.

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

inlineexplicit

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.

Note: This constructor will only REFERENCE the given strings

Definition at line 41 of file PRM_Name.h.

PRM_Name::PRM_Name	(	PRM_NameCopy	,
		const UT_StringHolder &	thetoken,
		const UT_StringHolder &	thelabel,
		int	theflags = `0`
	)

inlineexplicit

Constructor for doing deep copies of the strings.

Definition at line 53 of file PRM_Name.h.

Member Function Documentation

int PRM_Name::getExpressionFlag ( ) const

inline

Definition at line 87 of file PRM_Name.h.

unsigned PRM_Name::getHash ( ) const

inline

Definition at line 88 of file PRM_Name.h.

const char* PRM_Name::getLabel ( ) const

inline

Definition at line 83 of file PRM_Name.h.

const UT_StringRef& PRM_Name::getLabelRef ( ) const

inline

Get label UT_StringRef &, might be the sentinel value.

Definition at line 97 of file PRM_Name.h.

int64 PRM_Name::getMemoryUsage ( bool inclusive ) const

inline

Definition at line 157 of file PRM_Name.h.

const char* PRM_Name::getToken ( ) const

inline

Examples:: CHOP/CHOP_Stair.C.

Definition at line 79 of file PRM_Name.h.

const UT_StringRef& PRM_Name::getTokenRef ( ) const

inline

Use this for hash tables, might be the sentinel value.

Definition at line 94 of file PRM_Name.h.

void PRM_Name::harden ( )

inline

Do a deep copy of its internal references.

Examples:: OBJ/OBJ_WorldAlign.C.

Definition at line 100 of file PRM_Name.h.

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

void PRM_Name::instance ( const UT_IntArray & instance_num )

static void PRM_Name::instanceToken	(	UT_String &	token,
		const int *	instance,
		int	num
	)

static

static void PRM_Name::instanceToken	(	UT_String &	token,
		const UT_IntArray &	instance_num
	)

static

static void PRM_Name::instanceToken	(	UT_WorkBuffer &	result,
		const UT_StringRef &	token,
		const int *	instance,
		int	num
	)

static

static void PRM_Name::instanceToken	(	UT_WorkBuffer &	result,
		const UT_StringRef &	token,
		const UT_IntArray &	instance_num
	)

static

bool PRM_Name::isSentinel ( ) const

inline

Check if this is a sentinel.

Definition at line 64 of file PRM_Name.h.

bool PRM_Name::isValidChoice ( ) const

inline

Returns if this a valid menu choice.

Definition at line 150 of file PRM_Name.h.

PRM_Name::operator const UT_StringRef & ( ) const

inline

Use this for the common use of passing the token to a function.

Definition at line 91 of file PRM_Name.h.

void PRM_Name::setAsSentinel ( )

inline

Set to a sentinel value.

Definition at line 70 of file PRM_Name.h.

void PRM_Name::setAsSeparator ( )

Set to a separator value.

void PRM_Name::setLabel ( const char * s )

inline

Sets the label, doing a deep copy.

Examples:: SOP/SOP_CopRaster.C.

Definition at line 114 of file PRM_Name.h.

void PRM_Name::setToken ( const char * s )

inline

Sets the token, doing a deep copy.

Examples:: SOP/SOP_CopRaster.C.

Definition at line 106 of file PRM_Name.h.

void PRM_Name::setTokenAndLabel	(	const char *	token,
		const char *	label
	)

inline

Sets the token and label, doing deep copies.

Definition at line 122 of file PRM_Name.h.

void PRM_Name::setTokenAndLabelRef	(	const UT_StringRef &	token,
		const UT_StringRef &	label
	)

inline

Sets the token and label, doing shallow copies.

Definition at line 128 of file PRM_Name.h.

Member Data Documentation

const char* const PRM_Name::mySeparator

static

Definition at line 165 of file PRM_Name.h.

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

PRM/PRM_Name.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation