IParameterManager Class Reference

This class exposes an interface for the DSI to interact with ODBC layer in order to provide information about parameters. More...

List of all members.

Public Member Functions

virtual IParameterSourceRegisterParameter (simba_uint16 in_index)=0
 Registers a parameter to the IParameterManager at in_index.
virtual ~IParameterManager ()
 Destructor.

Protected Member Functions

 IParameterManager ()
 Constructor.

Detailed Description

This class exposes an interface for the DSI to interact with ODBC layer in order to provide information about parameters.


Constructor & Destructor Documentation

virtual ~IParameterManager (  )  [inline, virtual]

Destructor.

IParameterManager (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual IParameterSource* RegisterParameter ( simba_uint16  in_index  )  [pure virtual]

Registers a parameter to the IParameterManager at in_index.

This method is meant to be called during IQueryExecutor::PopulateParameters().

The IParameterSource pointer returned is used to set and get fields for the parameter at in_index.

Parameter indexes should start at 1. When IQueryExecutor::PopulateParameters() is complete, the set of registered parameter indexes should be consecutive, with no gaps.

The returned IParameterSource* should not be cached. The pointer is not usable outside of a call to IQueryExecutor::PopulateParameters().

Parameters:
in_index Index of the target parameter to register.
Exceptions:
CallbackException if it is used outside of IQueryExecutor::PopulateParameters().
Returns:
IParameterSource pointer. (NOT OWN)

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

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