GemStone::GemFire::Cache::Generic::StructSet< TResult > Class Template Reference

Inherits GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::StructSet >, and GemStone::GemFire::Cache::Generic::ICqResults< TResult >< TResult >.


Detailed Description

template<class TResult>
class GemStone::GemFire::Cache::Generic::StructSet< TResult >

Encapsulates a query struct set.

Public Member Functions

virtual
System::Collections::Generic::IEnumerator
< TResult >^ 
GetEnumerator ()
size_t GetFieldIndex (String^ fieldName)
String^ GetFieldName (size_t index)
virtual
SelectResultsIterator
< TResult >^ 
GetIterator ()

Protected Member Functions

void _SetNativePtr (gemfire::StructSet *nativeptr)
void AssignPtr (gemfire::StructSet *nativeptr)
void InternalCleanup ()
void SetPtr (gemfire::StructSet *nativeptr)

Properties

virtual bool IsModifiable [get]
virtual TResult Item [get]
virtual int32_t Size [get]

Member Function Documentation

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::StructSet >::_SetNativePtr ( gemfire::StructSet *  nativeptr  )  [inline, protected, inherited]

Set the native pointer to the new object without doing a preserveSB(). DO NOT USE UNLESS YOU KNOW WHAT YOU ARE DOING.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::StructSet >::AssignPtr ( gemfire::StructSet *  nativeptr  )  [inline, protected, inherited]

Used to assign the native pointer to a new object.

Note the order of preserveSB() and releaseSB(). This handles the corner case when m_nativeptr is same as nativeptr.

template<class TResult>
virtual System::Collections::Generic::IEnumerator<TResult> ^ GemStone::GemFire::Cache::Generic::StructSet< TResult >::GetEnumerator (  )  [virtual]

Returns an enumerator that iterates through the StructSet.

Returns:
A System.Collections.Generic.IEnumerator that can be used to iterate through the StructSet.

template<class TResult>
size_t GemStone::GemFire::Cache::Generic::StructSet< TResult >::GetFieldIndex ( String^   fieldName  ) 

Get the index number of the specified field name in the StructSet.

Parameters:
fieldName the field name for which the index is required.
Returns:
the index number of the specified field name.
Exceptions:
IllegalArgumentException if the field name is not found.

template<class TResult>
String ^ GemStone::GemFire::Cache::Generic::StructSet< TResult >::GetFieldName ( size_t  index  ) 

Get the field name of the StructSet from the specified index number.

Parameters:
index the index number of the field name to get.
Returns:
the field name from the specified index number or null if not found.

template<class TResult>
virtual SelectResultsIterator<TResult> ^ GemStone::GemFire::Cache::Generic::StructSet< TResult >::GetIterator (  )  [virtual]

Get a SelectResultsIterator with which to iterate over the items in the StructSet.

Returns:
The SelectResultsIterator with which to iterate.

Implements GemStone::GemFire::Cache::Generic::ISelectResults< TResult >.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::StructSet >::InternalCleanup (  )  [inline, protected, inherited]

Internal cleanup function invoked by dispose/finalizer.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::StructSet >::SetPtr ( gemfire::StructSet *  nativeptr  )  [inline, protected, inherited]

Used to set the native pointer to a new object. This should only be used when you know that the underlying object is NULL.


Property Documentation

template<class TResult>
virtual bool GemStone::GemFire::Cache::Generic::StructSet< TResult >::IsModifiable [get]

True if this StructSet is modifiable.

Returns:
returns false always at this time.

Implements GemStone::GemFire::Cache::Generic::ISelectResults< TResult >.

template<class TResult>
virtual TResult GemStone::GemFire::Cache::Generic::StructSet< TResult >::Item [get]

Index operator to directly access an item in the StructSet.

Exceptions:
IllegalArgumentException if the index is out of bounds.
Returns:
Item at the given index.

Implements GemStone::GemFire::Cache::Generic::ISelectResults< TResult >.

template<class TResult>
virtual int32_t GemStone::GemFire::Cache::Generic::StructSet< TResult >::Size [get]

The size of the StructSet.

Returns:
the number of items in the StructSet.

Implements GemStone::GemFire::Cache::Generic::ISelectResults< TResult >.


GemFire C++ Cache .NET API Documentation