IParameterSetIter Class Reference

This class exposes an interface for customer DSII to interact with ODBC layer to access parameter sets. More...

List of all members.

Public Member Functions

virtual Simba::DSI::IParameterSetGetParameterSet ()=0
 Returns the IParameterSet from which the DSI can extract inputs values and insert insert output values.
virtual simba_unsigned_native GetParameterSetCount ()=0
 Returns the total parameter set number.
virtual simba_unsigned_native GetParameterSetIndex ()=0
 Returns the index for this parameter set.
virtual bool IsEmpty ()=0
 Indicates if there are any parameter sets in this iterator.
virtual bool Next ()=0
 Positions the iterator to the next parameter set.
virtual ~IParameterSetIter ()
 Destructor.

Protected Member Functions

 IParameterSetIter ()
 Constructor.

Detailed Description

This class exposes an interface for customer DSII to interact with ODBC layer to access parameter sets.

This is a forward only iterator, which lets the customer DSII iterate through all available parameter sets. The iterator is initially placed before the first parameter set upon construction. Next() must be called to iterate to the first parameter set.

Note that this iterator is not thread-safe. For example, if thread A called Next() and thread B called Next() on the same IParameterSetIter, then the position will be incremented by 2 in total, not incremented by 1 as the threads would expect.


Constructor & Destructor Documentation

virtual ~IParameterSetIter (  )  [inline, virtual]

Destructor.

IParameterSetIter (  )  [inline, protected]

Constructor.

The iterator is initially placed before the first parameter set upon construction. Next() must be called to iterate to the first parameter set.


Member Function Documentation

virtual Simba::DSI::IParameterSet* GetParameterSet (  )  [pure virtual]

Returns the IParameterSet from which the DSI can extract inputs values and insert insert output values.

Note that DSII only needs to call GetParameterSet() once, because calling Next() will only update the contents in the data buffers of the IParameterSet.

Returns:
IParameterSet from which the DSI can extract inputs values and insert output values. (NOT OWN)
virtual simba_unsigned_native GetParameterSetCount (  )  [pure virtual]

Returns the total parameter set number.

Returns:
Total parameter set number.
virtual simba_unsigned_native GetParameterSetIndex (  )  [pure virtual]

Returns the index for this parameter set.

Returns:
Index for this parameter set.
virtual bool IsEmpty (  )  [pure virtual]

Indicates if there are any parameter sets in this iterator.

Returns:
True if there are any parameter sets in this iterator; false otherwise.
virtual bool Next (  )  [pure virtual]

Positions the iterator to the next parameter set.

The same IParameterSet is used, only the data buffers of the IParameterSet will have updated to reflect the data of the next parameter set.

Returns:
True if the next parameter set is valid; false if there is no next parameter set to iterate to.

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