CSLStrEnumProxy Class Template Reference

Class that allows modification of an enum implemented as a string in a template. More...

#include <SL_Enum.h>

Inheritance diagram for CSLStrEnumProxy:

CSLAnimatableType List of all members.

Public Member Functions
  CSLStrEnumProxy (CdotXSITemplate *in_pTemplate, SI_Int in_nIndex, CEnumDictionary< EnumType, MaxValue > *in_pDictionary)
CSLStrEnumProxy &  operator= (const CSLStrEnumProxy &in_Value)
CSLStrEnumProxy &  operator= (const EnumType &in_Value)
SI_Bool  operator== (const CSLStrEnumProxy &in_ToCompare)
SI_Bool  operator== (const EnumType &in_ToCompare)
SI_Bool  IsValid ()
  operator EnumType ()
virtual EElementType  Type ()
virtual SI_Float  GetFloatValue ()
virtual SI_Void  SetFloatValue (SI_Float in_fValue)
SI_Error  Connect (CdotXSITemplate *in_pTemplate, SI_Int in_nIndex)

Detailed Description

template<class EnumType, SI_Int MaxValue>
class CSLStrEnumProxy< EnumType, MaxValue >

Class that allows modification of an enum implemented as a string in a template.

Constructor & Destructor Documentation

CSLStrEnumProxy ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_nIndex,
CEnumDictionary< EnumType, MaxValue > *  in_pDictionary  
)

Constructor. Connects to an enum parameter implemented as a string in the template

Parameters:
[in]  in_pTemplate  Pointer to the template
[in]  in_nIndex  Index of the parameter in the template
[in]  in_pDictionary  Pointer to the enum dictionary (converts between strings and enums)

Member Function Documentation

CSLStrEnumProxy< EnumType, MaxValue > & operator= ( const CSLStrEnumProxy< EnumType, MaxValue > &  in_Value  )  [inline]

Assignment operator. Assigns the value of in_Value to this class

Parameters:
[in]  in_Value  The new value
Returns:
Reference to the current object.

CSLStrEnumProxy< EnumType, MaxValue > & operator= ( const EnumType &  in_Value  )  [inline]

Assignment operator. Assigns the value of in_Value to this class

Parameters:
[in]  in_Value  The new value
Returns:
Reference to the current object.

SI_Bool operator== ( const CSLStrEnumProxy< EnumType, MaxValue > &  in_ToCompare  )  [inline]

Comparison operator. Compares in_ToCompare with the value of the parameter referred by this proxy.

Parameters:
[in]  in_ToCompare  The instance to compare values with
Returns:
Whether or not the referred parameter and in_ToCompare are equal

SI_Bool operator== ( const EnumType &  in_ToCompare  )  [inline]

Comparison operator. Compares in_ToCompare with the value of the parameter referred by this proxy.

Parameters:
[in]  in_ToCompare  The instance to compare values with
Returns:
Whether or not the referred parameter and in_ToCompare are equal

SI_Bool IsValid (  )  [inline]

Checks if the internally stored enum value is valid

Return values:
true  if the stored enum is within valid range
false  if the stored enum is invalid

operator EnumType (  )  [inline]

Conversion operator

Returns:
The stored enum value

CSLAnimatableType::EElementType Type (  )  [virtual]

Returns the animatable type of this class

Return values:
CSLAnimatableType::SI_STRING_ENUM_TYPE  Animatable type

Implements CSLAnimatableType.

SI_Float GetFloatValue (  )  [virtual]

Converts the value of the referred parameter to float

Returns:
The converted value

Implements CSLAnimatableType.

SI_Void SetFloatValue ( SI_Float  in_fValue  )  [virtual]

Sets the value of the referred parameter from a float

Parameters:
[in]  in_fValue  The float value used to set the parameter

Implements CSLAnimatableType.

SI_Error Connect ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_nIndex  
) [virtual]

Connects the proxy to a parameter of a template

Parameters:
[in]  in_pTemplate  Parent template
[in]  in_nIndex  Index of the parameter in the parent template
Return values:
SI_Error::SI_SUCCESS 

Reimplemented from CSLAnimatableType.

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