Python Script Engine  7.0
GL Studio Editor Python Script API
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.

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

Member Function Documentation

String RSOInitialAttributeValuesArray::GetAttribute ( unsigned int  attribIdx)

get an attribute from the array

Parameters
attribIdxzero based index to desired attribute( < GetCount() )
Returns
the desired attribute from the array
Exceptions
CEIExceptionif 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
attributeattribute to get initial value for
Precondition
IsAttributeInArray( attribute ) == true
bool RSOInitialAttributeValuesArray::IsAttributeInArray ( String  attribute)

determine if the given attribute is in the array

Parameters
attributedesired attribute

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