RSOInitialAttributeValuesArray Class Reference

Public Member Functions
unsigned int	GetCount (void)
String	GetAttribute (unsigned int attribIdx)
bool	IsAttributeInArray (String attribute)
String	GetInitialAttributeValue (String attribute)

Detailed Description

Common editor interface RSO initial attribute values array.

If the RSOInitialAttributeValuesArray instance is empty, it will return 'False' in comparison checks.

# Python:
import ComponentRef
compRef = ComponentRef.ComponentRef()
attrArray = compRef.GetInitialAttributeValues()
if attrArray: # Will be False if componentref has no initial attributes
  pass

Member Function Documentation

String RSOInitialAttributeValuesArray::GetAttribute

(

unsigned int

attribIdx

)

get an attribute from the array

Parameters

attribIdx

zero based index to desired attribute( < GetCount() )

Returns

the desired attribute from the array

Exceptions

CEIException

if index is out of range

unsigned int RSOInitialAttributeValuesArray::GetCount

(

void

)

get the number of available attributes in the array

Returns

the number of available attributes in the array

String RSOInitialAttributeValuesArray::GetInitialAttributeValue

(

String

attribute

)

get an initial attribute value

Parameters

attribute

attribute to get initial value for

Precondition

IsAttributeInArray( attribute ) == true

bool RSOInitialAttributeValuesArray::IsAttributeInArray

(

String

attribute

)

determine if the given attribute is in the array

Parameters

attribute

desired attribute

---

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

• RSOInitialAttributeValuesArray.i