Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

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 Methods


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

template<class EnumType, SI_Int MaxValue>
CSLStrEnumProxy< EnumType, MaxValue >::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_pTemplate  Pointer to the template
in_Index  Index of the parameter in the template


Member Function Documentation

template<class EnumType, SI_Int MaxValue>
SI_Float CSLStrEnumProxy< EnumType, MaxValue >::GetFloatValue   [virtual]
 

Converts the value of the referred parameter to float

Returns:
The converted value

Reimplemented from CSLAnimatableType.

template<class EnumType, SI_Int MaxValue>
SI_Bool CSLStrEnumProxy< EnumType, MaxValue >::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

template<class EnumType, SI_Int MaxValue>
CSLStrEnumProxy< EnumType, MaxValue >::operator EnumType   [inline]
 

Conversion operator.

Returns:
The stored enum value

template<class EnumType, SI_Int MaxValue>
CSLStrEnumProxy< EnumType, MaxValue > & CSLStrEnumProxy< EnumType, MaxValue >::operator= const EnumType &    in_Value [inline]
 

Assignment operator. Assigns the value of in_Value to this class

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

template<class EnumType, SI_Int MaxValue>
CSLStrEnumProxy< EnumType, MaxValue > & CSLStrEnumProxy< EnumType, MaxValue >::operator= const CSLStrEnumProxy< EnumType, MaxValue > &    in_Value [inline]
 

Assignment operator. Assigns the value of in_Value to this class

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

template<class EnumType, SI_Int MaxValue>
SI_Bool CSLStrEnumProxy< EnumType, MaxValue >::operator== const EnumType &    in_nToCompare [inline]
 

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

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

template<class EnumType, SI_Int MaxValue>
SI_Bool CSLStrEnumProxy< EnumType, MaxValue >::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_ToCompare  The instance to compare values with
Returns:
Whether or not the referred parameter and in_ToCompare are equal

template<class EnumType, SI_Int MaxValue>
SI_Void CSLStrEnumProxy< EnumType, MaxValue >::SetFloatValue SI_Float    in_fValue [virtual]
 

Sets the value of the referred parameter from a float

Parameters:
in_fValue  The float value used to set the parameter

Reimplemented from CSLAnimatableType.

template<class EnumType, SI_Int MaxValue>
CSLAnimatableType::EElementType CSLStrEnumProxy< EnumType, MaxValue >::Type   [virtual]
 

Returns the animatable type of this class

Returns:
CSLAnimatableType::SI_STRING_ENUM_TYPE

Reimplemented from CSLAnimatableType.


The documentation for this class was generated from the following file: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.