ETParameterData Class Reference

Stores parameter data so that multiple ETParameter nodes can share it. More...

Inherits Simba::Support::UnsafeSharedObject.

List of all members.

Public Member Functions

 ETParameterData (const void *in_inputData, simba_uint32 in_inputDataLength, bool in_isDefaultValue, SqlData *in_outputData=NULL)
 Constructor. Used for input and IO parameters.
SqlDataGetOutputData ()
 Get the output SqlData holder.
bool IsDefaultValue ()
 Indicates if the default value for this value expression should be used.
void RegisterCacheInvalidationListener (ETCacheInvalidationListener *in_listener)
 Register a ETCacheInvalidationListener which will be notified whenever the value of this parameter changes due to iteration through parameter sets.
bool RetrieveData (ETDataRequest &io_dataRequest)
void SetInputData (const void *in_inputData, simba_uint32 in_inputDataLength)
 Sets the input data.
void SetIsDefaultValue (bool in_isDefaultValue)
 Set if the default value for this value expression should be used.

Detailed Description

Stores parameter data so that multiple ETParameter nodes can share it.


Constructor & Destructor Documentation

ETParameterData ( const void *  in_inputData,
simba_uint32  in_inputDataLength,
bool  in_isDefaultValue,
SqlData in_outputData = NULL 
)

Constructor. Used for input and IO parameters.

Parameters:
in_inputData The input data for the parameter. (NOT OWN)
in_inputDataLength The length of the input data for the parameter, in bytes.
in_isDefaultValue Indicates if the default value for this parameter should be used. True if it should; false otherwise.
in_outputData The output SqlData holder. (NOT OWN)

Member Function Documentation

SqlData* GetOutputData (  ) 

Get the output SqlData holder.

Will be NULL if this is an input parameter.

Returns:
The output SqlData to place output data in. (NOT OWN)
bool IsDefaultValue (  ) 

Indicates if the default value for this value expression should be used.

Returns:
True the default value should be used; false otherwise.
void RegisterCacheInvalidationListener ( ETCacheInvalidationListener *  in_listener  ) 

Register a ETCacheInvalidationListener which will be notified whenever the value of this parameter changes due to iteration through parameter sets.

Parameters:
in_listener The ETCacheInvalidationListener to register with this object. (NOT OWN)
Exceptions:
SEInvalidArgumentException If in_listener is NULL.
bool RetrieveData ( ETDataRequest io_dataRequest  ) 
void SetInputData ( const void *  in_inputData,
simba_uint32  in_inputDataLength 
)

Sets the input data.

Parameters:
in_inputData The input data for the parameter. (NOT OWN)
in_inputDataLength The length of the input data for the parameter, in bytes.
void SetIsDefaultValue ( bool  in_isDefaultValue  ) 

Set if the default value for this value expression should be used.

Parameters:
in_isDefaultValue Whether the default value should be used.

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

Generated on Wed May 17 14:21:18 2017 for SimbaEngine 10.1.3.1011 by simba