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

#include <PRM_Conditional.h>

+ Inheritance diagram for PRM_Conditional:

Public Member Functions

 PRM_Conditional (PRM_ConditionalType type=PRM_CONDTYPE_DISABLE)
 
 PRM_Conditional (const PRM_Conditional &other)
 
 PRM_Conditional (const char *conditional, PRM_ConditionalType type=PRM_CONDTYPE_DISABLE)
 
virtual ~PRM_Conditional ()
 
virtual int64 getMemoryUsage (bool inclusive) const
 
virtual PRM_ConditionalGroupType groupType () const
 
PRM_ConditionalType getType () const
 
const char * getName (bool label) const
 
PRM_ConditionalBaseinstance (const UT_IntArray &index_list) const
 
PRM_ConditionalgetConditional (PRM_ConditionalType type)
 
const PRM_ConditionalgetConditional (PRM_ConditionalType type) const
 
int entries () const
 
const PRM_ConditionalInfooperator() (int index) const
 
const PRM_Conditionaloperator= (const PRM_Conditional &src)
 
void clear ()
 
PRM_ConditionalInfocreateInfo ()
 
void getStringFromList (UT_StringHolder &str, const UT_StringArray *validparms=nullptr) const
 
void getStringFromList (UT_String &str) const
 
void getStringFromList (UT_String &str, const UT_StringArray &validparms) const
 
bool setListFromString (const char *conditional, UT_StringHolder &error)
 
bool eval (const PRM_Parm &prm, const PRM_ParmList &pl, const UT_StringArray *skip_parms) const
 
- Public Member Functions inherited from PRM_ConditionalBase
virtual ~PRM_ConditionalBase ()
 

Static Public Member Functions

static const char * getName (PRM_ConditionalType type, bool label)
 
static bool verifyConditionalString (const char *conditional, UT_StringHolder &error)
 
static bool getOperatorFromString (const char *testoperator, PRM_ConditionalOperator &op)
 
static bool isValidOperator (const char *testoperator)
 

Detailed Description

This class allow setting a single conditional type for a PRM_Template. If multiple conditional types are required, use PRM_ConditionalGroup.

Definition at line 145 of file PRM_Conditional.h.

Constructor & Destructor Documentation

PRM_Conditional::PRM_Conditional ( PRM_ConditionalType  type = PRM_CONDTYPE_DISABLE)
PRM_Conditional::PRM_Conditional ( const PRM_Conditional other)
PRM_Conditional::PRM_Conditional ( const char *  conditional,
PRM_ConditionalType  type = PRM_CONDTYPE_DISABLE 
)
explicit
virtual PRM_Conditional::~PRM_Conditional ( )
virtual

Member Function Documentation

void PRM_Conditional::clear ( )
PRM_ConditionalInfo* PRM_Conditional::createInfo ( )
int PRM_Conditional::entries ( ) const
bool PRM_Conditional::eval ( const PRM_Parm prm,
const PRM_ParmList pl,
const UT_StringArray skip_parms 
) const
PRM_Conditional* PRM_Conditional::getConditional ( PRM_ConditionalType  type)
virtual

Implements PRM_ConditionalBase.

const PRM_Conditional* PRM_Conditional::getConditional ( PRM_ConditionalType  type) const
virtual

Implements PRM_ConditionalBase.

virtual int64 PRM_Conditional::getMemoryUsage ( bool  inclusive) const
virtual

Implements PRM_ConditionalBase.

static const char* PRM_Conditional::getName ( PRM_ConditionalType  type,
bool  label 
)
static
const char* PRM_Conditional::getName ( bool  label) const
static bool PRM_Conditional::getOperatorFromString ( const char *  testoperator,
PRM_ConditionalOperator op 
)
static
void PRM_Conditional::getStringFromList ( UT_StringHolder str,
const UT_StringArray validparms = nullptr 
) const
void PRM_Conditional::getStringFromList ( UT_String str) const
void PRM_Conditional::getStringFromList ( UT_String str,
const UT_StringArray validparms 
) const
PRM_ConditionalType PRM_Conditional::getType ( void  ) const
inline

Definition at line 160 of file PRM_Conditional.h.

virtual PRM_ConditionalGroupType PRM_Conditional::groupType ( ) const
inlinevirtual

Implements PRM_ConditionalBase.

Definition at line 158 of file PRM_Conditional.h.

PRM_ConditionalBase* PRM_Conditional::instance ( const UT_IntArray index_list) const
virtual

Implements PRM_ConditionalBase.

static bool PRM_Conditional::isValidOperator ( const char *  testoperator)
static
const PRM_ConditionalInfo* PRM_Conditional::operator() ( int  index) const
const PRM_Conditional& PRM_Conditional::operator= ( const PRM_Conditional src)
bool PRM_Conditional::setListFromString ( const char *  conditional,
UT_StringHolder error 
)
static bool PRM_Conditional::verifyConditionalString ( const char *  conditional,
UT_StringHolder error 
)
static

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