Values, Types and States

Description

Basic definitions for values and their types and state.

Most relevant is the CRcValueState class to access the present value and state of a resource. More details can be found in the C/C++ API documentation.

Collaboration diagram for Values, Types and States:

Classes
class	URcValue
class	CRcValueState

Functions
def	RcTypeGetName (t)
def	RcTypeGetFromName (name)
def	RcTypeGetBaseType (t)
def	RcTypeIsStringBased (t)
def	RcTypeIsUnitType (t)
def	RcTypeGetUnit (t)
def	RcTypeIsEnumType (t)
def	RcTypeGetEnumValues (t)
def	RcTypeGetEnumValue (t, idx, warn=True)
def	RcTypeGetEnumIdx (t, value, warn=True)

Function Documentation

RcTypeGetName()

def RcTypeGetName

(

t

)

RcTypeGetName(ERcType t) -> char const *

RcTypeGetFromName()

def RcTypeGetFromName

(

name

)

RcTypeGetFromName(char const * name) -> ERcType

RcTypeGetBaseType()

def RcTypeGetBaseType

(

t

)

RcTypeGetBaseType(ERcType t) -> ERcType

RcTypeIsStringBased()

def RcTypeIsStringBased

(

t

)

RcTypeIsStringBased(ERcType t) -> bool

RcTypeIsUnitType()

def RcTypeIsUnitType

(

t

)

RcTypeIsUnitType(ERcType t) -> bool

RcTypeGetUnit()

def RcTypeGetUnit

(

t

)

RcTypeGetUnit(ERcType t) -> char const *

RcTypeIsEnumType()

def RcTypeIsEnumType

(

t

)

RcTypeIsEnumType(ERcType t) -> bool

RcTypeGetEnumValues()

def RcTypeGetEnumValues

(

t

)

RcTypeGetEnumValues(ERcType t) -> int

RcTypeGetEnumValue()

def RcTypeGetEnumValue	(		t,
			idx,
			warn = True
	)

RcTypeGetEnumValue(ERcType t, int idx, bool warn=True) -> char const

RcTypeGetEnumIdx()

def RcTypeGetEnumIdx	(		t,
			value,
			warn = True
	)

RcTypeGetEnumIdx(ERcType t, char const * value, bool warn=True) -> int