# CSLULongProxy Class Reference

Class that allows modification of a ULong parameter in a template. More...

`#include <SL_ULong.h>`

Inheritance diagram for CSLULongProxy:

List of all members.

## Public Member Functions
| CSLULongProxy (CdotXSITemplate *in_pTemplate, SI_Int in_nIndex)
CSLULongProxy & | operator= (const CSLULongProxy &in_Value)
CSLULongProxy & | operator= (const SI_ULong &in_Value)
SI_Bool | operator== (const CSLULongProxy &in_ToCompare)
SI_Bool | operator== (const SI_ULong &in_ToCompare)
| operator SI_ULong ()
| Conversion operator.
virtual EElementType | Type ()
virtual SI_Float | GetFloatValue ()
virtual SI_Void | SetFloatValue (SI_Float in_fValue)
virtual SI_Error | Connect (CdotXSITemplate *in_pTemplate, SI_Int in_iIndex)

## Detailed Description

Class that allows modification of a ULong parameter in a template.

## Constructor & Destructor Documentation

CSLULongProxy | ( | CdotXSITemplate * | in_pTemplate,
|  | SI_Int | in_nIndex |
| ) |  |  |

Constructor. Connects to a parameter in the parent template

Parameters:

  | in_pTemplate | Pointer to the parent template
  | in_Index | Index of the parameter in the template

## Member Function Documentation

CSLULongProxy& operator= | ( | const CSLULongProxy & | in_Value | ) |

Assignment operator. Assigns `in_Value` to the parameter referred by this proxy.

Parameters:

  | in_Value | The new value

Returns:
  Reference to the current object.

CSLULongProxy& operator= | ( | const SI_ULong & | in_Value | ) |

Assignment operator. Assigns `in_Value` to the parameter referred by this proxy.

Parameters:

  | in_Value | The new value

Returns:
  Reference to the current object.

SI_Bool operator== | ( | const CSLULongProxy & | in_ToCompare | ) |

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

SI_Bool operator== | ( | const SI_ULong & | in_ToCompare | ) |

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

virtual EElementType Type | ( |  | ) | `[virtual]`

Returns the animatable type of this class

Returns:
  CSLAnimatableType::SI_ULONG_TYPE

Implements CSLAnimatableType.

virtual SI_Float GetFloatValue | ( |  | ) | `[virtual]`

Converts the value of the referred parameter to float

Returns:
  The converted value

Implements CSLAnimatableType.

virtual SI_Void 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

Implements CSLAnimatableType.

virtual SI_Error Connect | ( | CdotXSITemplate * | in_pTemplate,
|  | SI_Int | in_iIndex |
| ) |  |  | `[virtual]`

Connects the proxy to the IO layer parameter

Parameters:

  | in_pTemplate | the template that owns the parameter to connect to
  | in_iIndex | the index of the parameter

Returns:
  The proxy was succesfully connected or not

Reimplemented from CSLAnimatableType.

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

- SL_ULong.h