HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PRM_Name Class Reference

#include <PRM_Name.h>

+ Inheritance diagram for PRM_Name:

Public Member Functions

 PRM_Name ()
 
 PRM_Name (const char *thetoken, 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 setTokenAndLabel (const char *token, const char *label)
 
void instance (const int *instance, int num)
 
void instance (const UT_IntArray &instance_num)
 
bool isValidChoice () const
 
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_String &token, const int *instance, int num)
 
static void instanceToken (UT_WorkBuffer &result, const UT_String &token, const UT_IntArray &instance_num)
 

Static Public Attributes

static const char *const mySeparator
 
static const unsigned theSentinelHash
 

Detailed Description

Constructor & Destructor Documentation

PRM_Name::PRM_Name ( )

NOTE: Need an explicit default constructor to work around internal compiler error in Visual Studio 2015 Update 3.

PRM_Name::PRM_Name ( const char *  thetoken,
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 45 of file PRM_Name.h.

unsigned PRM_Name::getHash ( ) const
inline

Definition at line 46 of file PRM_Name.h.

const char* PRM_Name::getLabel ( ) const
inline

Definition at line 41 of file PRM_Name.h.

int64 PRM_Name::getMemoryUsage ( bool  inclusive) const
inline

Definition at line 76 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 40 of file PRM_Name.h.

void PRM_Name::harden ( )
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_String token,
const int instance,
int  num 
)
static
static void PRM_Name::instanceToken ( UT_WorkBuffer result,
const UT_String token,
const UT_IntArray instance_num 
)
static
bool PRM_Name::isValidChoice ( ) const
inline

Definition at line 68 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.
void PRM_Name::setTokenAndLabel ( const char *  token,
const char *  label 
)
inline

Definition at line 51 of file PRM_Name.h.

Member Data Documentation

const char* const PRM_Name::mySeparator
static

Definition at line 84 of file PRM_Name.h.

const unsigned PRM_Name::theSentinelHash
static

Definition at line 86 of file PRM_Name.h.


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