DSIResults Class Reference

Exposes an iterator over the results of execution to the ODBC Layer. More...

Inherits Simba::DSI::IResults.

List of all members.

Public Member Functions

void AddResult (AutoPtr< Simba::DSI::IResult > in_result)
 Adds an IResult to the results.
void AddResult (Simba::DSI::IResult *in_result)
 Adds an IResult to the results.
void AddResults (std::vector< Simba::DSI::IResult * > &io_results)
 Add a vector of IResults to the results.
void Clear ()
 Removes all the results from this object.
 DSIResults (std::vector< Simba::DSI::IResult * > &io_results)
 Constructor, created with a set of results.
 DSIResults (simba_size_t in_numResults)
 Constructor.
 DSIResults ()
 Constructor.
void EraseResult (simba_size_t in_resultIndex)
 Erase the result at the specified index.
Simba::DSI::IResultGetCurrentResult ()
 Gets the current result.
simba_uint16 GetResultsCount ()
 Returns the number of results associated with the executed query.
bool Next ()
 Moves to the next result in the iterator.
void Reset ()
 Resets the iterator such that it points to the first result.
virtual ~DSIResults ()
 Destructor.

Detailed Description

Exposes an iterator over the results of execution to the ODBC Layer.

The iterator is initially positioned to the first entry.


Constructor & Destructor Documentation

DSIResults (  ) 

Constructor.

DSIResults ( simba_size_t  in_numResults  )  [explicit]

Constructor.

Parameters:
in_numResults The number of results which will be added to this object. This is just used to pre-allocate a vector, so it is not a hard limit.
DSIResults ( std::vector< Simba::DSI::IResult * > &  io_results  ) 

Constructor, created with a set of results.

Parameters:
io_results The results to add. This removes the results from the vector. (OWN)
virtual ~DSIResults (  )  [virtual]

Destructor.


Member Function Documentation

void AddResult ( AutoPtr< Simba::DSI::IResult in_result  ) 

Adds an IResult to the results.

Parameters:
in_result The result to add to the results. (OWN)
void AddResult ( Simba::DSI::IResult in_result  ) 

Adds an IResult to the results.

Parameters:
in_result The result to add to the results. (OWN)
void AddResults ( std::vector< Simba::DSI::IResult * > &  io_results  ) 

Add a vector of IResults to the results.

Parameters:
io_results The results to add. This removes the results from the vector. (OWN)
void Clear (  ) 

Removes all the results from this object.

void EraseResult ( simba_size_t  in_resultIndex  ) 

Erase the result at the specified index.

Parameters:
in_resultIndex The 0-based result index. If the index is invalid, no result will be erased.
Simba::DSI::IResult* GetCurrentResult (  )  [virtual]

Gets the current result.

Returns:
Current result. (NOT OWN)

Implements IResults.

simba_uint16 GetResultsCount (  )  [virtual]

Returns the number of results associated with the executed query.

Returns:
Number of results.

Implements IResults.

bool Next (  )  [virtual]

Moves to the next result in the iterator.

Returns:
True if there is a result to move to; false if there are no further results.

Implements IResults.

void Reset (  )  [virtual]

Resets the iterator such that it points to the first result.

Implements IResults.


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