CSLStringProxy Class Reference

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

#include <SL_String.h>

List of all members.

Public Member Functions
  CSLStringProxy (CdotXSITemplate *in_pTemplate, SI_Int in_Index)
  CSLStringProxy ()
SI_Error  Connect (CdotXSITemplate *in_pTemplate, SI_Int in_nIndex)
CSLStringProxy &  operator= (const CSLStringProxy &in_Value)
CSLStringProxy &  operator= (const char *in_Value)
SI_Bool  operator== (const CSLStringProxy &in_ToCompare)
SI_Bool  operator== (const char *in_ToCompare)
  operator char * ()
  Conversion operator.

Detailed Description

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

Constructor & Destructor Documentation

CSLStringProxy ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_Index  
)

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

CSLStringProxy (  ) 

Constructor Creates an unconnected proxy

Member Function Documentation

SI_Error Connect ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_nIndex  
)

Connects the proxy to a parameter of a template

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

CSLStringProxy& operator= ( const CSLStringProxy &  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.

CSLStringProxy& operator= ( const char *  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 CSLStringProxy &  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
Note:
String comparison is case-sensitive

SI_Bool operator== ( const char *  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
Note:
String comparison is case-sensitive

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