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 home2l.RcTypeGetName

(

t

)

RcTypeGetName(ERcType t) -> char const *

RcTypeGetFromName()

def home2l.RcTypeGetFromName

(

name

)

RcTypeGetFromName(char const * name) -> ERcType

RcTypeGetBaseType()

def home2l.RcTypeGetBaseType

(

t

)

RcTypeGetBaseType(ERcType t) -> ERcType

RcTypeIsStringBased()

def home2l.RcTypeIsStringBased

(

t

)

RcTypeIsStringBased(ERcType t) -> bool

RcTypeIsUnitType()

def home2l.RcTypeIsUnitType

(

t

)

RcTypeIsUnitType(ERcType t) -> bool

RcTypeGetUnit()

def home2l.RcTypeGetUnit

(

t

)

RcTypeGetUnit(ERcType t) -> char const *

RcTypeIsEnumType()

def home2l.RcTypeIsEnumType

(

t

)

RcTypeIsEnumType(ERcType t) -> bool

RcTypeGetEnumValues()

def home2l.RcTypeGetEnumValues

(

t

)

RcTypeGetEnumValues(ERcType t) -> int

RcTypeGetEnumValue()

def home2l.RcTypeGetEnumValue	(		t,
			idx,
			warn = True
	)

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

RcTypeGetEnumIdx()

def home2l.RcTypeGetEnumIdx	(		t,
			value,
			warn = True
	)

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