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
	RcTypeGetName (t)

	RcTypeGetFromName (name)

	RcTypeGetBaseType (t)

	RcTypeIsStringBased (t)

	RcTypeIsUnitType (t)

	RcTypeGetUnit (t)

	RcTypeIsEnumType (t)

	RcTypeGetEnumValues (t)

	RcTypeGetEnumValue (t, idx, warn=True)

	RcTypeGetEnumIdx (t, value, warn=True)

Function Documentation

◆ RcTypeGetName()

RcTypeGetName ( t )

RcTypeGetName(ERcType t) -> char const *

◆ RcTypeGetFromName()

RcTypeGetFromName ( name )

RcTypeGetFromName(char const * name) -> ERcType

◆ RcTypeGetBaseType()

RcTypeGetBaseType ( t )

RcTypeGetBaseType(ERcType t) -> ERcType

◆ RcTypeIsStringBased()

RcTypeIsStringBased ( t )

RcTypeIsStringBased(ERcType t) -> bool

◆ RcTypeIsUnitType()

RcTypeIsUnitType ( t )

RcTypeIsUnitType(ERcType t) -> bool

◆ RcTypeGetUnit()

RcTypeGetUnit ( t )

RcTypeGetUnit(ERcType t) -> char const *

◆ RcTypeIsEnumType()

RcTypeIsEnumType ( t )

RcTypeIsEnumType(ERcType t) -> bool

◆ RcTypeGetEnumValues()

RcTypeGetEnumValues ( t )

RcTypeGetEnumValues(ERcType t) -> int

◆ RcTypeGetEnumValue()

RcTypeGetEnumValue	(	t,
		idx,
		warn = `True`
	)

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

◆ RcTypeGetEnumIdx()

RcTypeGetEnumIdx	(	t,
		value,
		warn = `True`
	)

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