Apache::Geode::Client::StructSet< TResult > Class Template Reference

Encapsulates a query struct set. More...

Inherits SBWrap< apache::geode::client::StructSet >, and Apache::Geode::Client::ICqResults< TResult >.

Public Member Functions
virtual System::Collections::Generic::IEnumerator< TResult > ^	GetEnumerator ()
	Returns an enumerator that iterates through the StructSet. More...
size_t	GetFieldIndex (String^ fieldName)
	Get the index number of the specified field name in the StructSet. More...
String ^	GetFieldName (size_t index)
	Get the field name of the StructSet from the specified index number. More...
virtual SelectResultsIterator< TResult > ^	GetIterator ()
	Get a SelectResultsIterator with which to iterate over the items in the StructSet. More...

Properties
virtual bool	IsModifiable [get]
	True if this StructSet is modifiable. More...
virtual TResult	Item [get]
	Index operator to directly access an item in the StructSet. More...
virtual System::Int32	Size [get]
	The size of the StructSet. More...

Detailed Description

template<class TResult>
class Apache::Geode::Client::StructSet< TResult >

Encapsulates a query struct set.

Member Function Documentation

GetEnumerator()

template<class TResult >

virtual System::Collections::Generic::IEnumerator<TResult> ^ Apache::Geode::Client::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.

GetFieldIndex()

template<class TResult >

size_t Apache::Geode::Client::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.

GetFieldName()

template<class TResult >

String ^ Apache::Geode::Client::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.

GetIterator()

template<class TResult >

virtual SelectResultsIterator<TResult> ^ Apache::Geode::Client::StructSet< TResult >::GetIterator ( )

virtual

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

Returns

The SelectResultsIterator with which to iterate.

Property Documentation

IsModifiable

template<class TResult >

virtual bool Apache::Geode::Client::StructSet< TResult >::IsModifiable

get

True if this StructSet is modifiable.

Returns

returns false always at this time.

Item

template<class TResult >

virtual TResult Apache::Geode::Client::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.

Size

template<class TResult >

virtual System:: Int32 Apache::Geode::Client::StructSet< TResult >::Size

get

The size of the StructSet.

Returns

the number of items in the StructSet.