Apache::Geode::Client::Struct Class Reference

Encapsulates a row of query struct set. More...

Inherits Apache::Geode::Client::Serializable.

Public Member Functions
virtual Apache::Geode::Client::IGeodeSerializable ^	FromData (Apache::Geode::Client::DataInput^ input)
	Deserializes the native (C++) object – returns an instance of the Serializable class with the native object wrapped inside. More...
bool	HasNext ()
	Check whether another field value is available to iterate over in this Struct. More...
Object ^	Next ()
	Get the next field value item available in this Struct. More...
virtual void	ToData (Apache::Geode::Client::DataOutput^ output)
	Serializes this native (C++) object. More...
virtual String ^	ToString () override
	Return a string representation of the object. More...

Static Public Member Functions
static	operator Apache::Geode::Client::Serializable^ (array< bool >^ value)
	Implicit conversion operator from an boolean array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< Byte >^ value)
	Implicit conversion operator from an array of bytes to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< Char >^ value)
	Implicit conversion operator from a character array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< Double >^ value)
	Implicit conversion operator from a double array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< Single >^ value)
	Implicit conversion operator from a float array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< String^>^ value)
	Implicit conversion operator from a string array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< System::Int16 >^ value)
	Implicit conversion operator from a 16-bit integer array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< System::Int32 >^ value)
	Implicit conversion operator from a 32-bit integer array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (array< System::Int64 >^ value)
	Implicit conversion operator from a 64-bit integer array to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (bool value)
	Implicit conversion operator from a boolean to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (Byte value)
	Implicit conversion operator from a byte to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (Char value)
	Implicit conversion operator from a character to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (Double value)
	Implicit conversion operator from a double to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (Single value)
	Implicit conversion operator from a float to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (String^ value)
	Implicit conversion operator from a string to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (System::Int16 value)
	Implicit conversion operator from a 16-bit integer to a Serializable. More...
static	operator Apache::Geode::Client::Serializable^ (System::Int32 value)
	Implicit conversion operator from a 32-bit integer to a Serializable. More...
static	operator Serializable^ (System::Int64 value)
	Implicit conversion operator from a 64-bit integer to a Serializable. More...
static void	RegisterPdxSerializer (IPdxSerializer^ pdxSerializer)
	Set the PDX serializer for the cache. More...
static void	RegisterPdxType (PdxTypeFactoryMethod^ creationMethod)
static void	RegisterTypeGeneric (TypeFactoryMethodGeneric^ creationMethod)
	Register an instance factory method for a given type. More...
static void	SetPdxTypeMapper (IPdxTypeMapper^ pdxTypeMapper)
	Register an PdxTypeMapper to map the local types to pdx types More...

Properties
virtual System::UInt32	ClassId [get]
	Returns the classId of the instance being serialized. More...
Object^	Item [get]
	Get the field value for the given index number. More...
size_t	Length [get]
	Get the number of field values available. More...
virtual System::UInt32	ObjectSize [get]
	return the size of this object in bytes More...
Apache::Geode::Client::StructSet< Object^>^	Set [get]
	Get the parent StructSet of this Struct. More...

Detailed Description

Encapsulates a row of query struct set.

A Struct has a StructSet as its parent. It contains the field values returned after executing a Query obtained from a QueryService which in turn is obtained from a Cache.

Member Function Documentation

FromData()

virtual Apache::Geode::Client::IGeodeSerializable ^ Apache::Geode::Client::Serializable::FromData ( Apache::Geode::Client::DataInput^  input )

virtualinherited

Deserializes the native (C++) object – returns an instance of the Serializable class with the native object wrapped inside.

Parameters

input

the DataInput stream to use for reading the object data

Returns

the deserialized object

Implements Apache::Geode::Client::IGeodeSerializable.

Reimplemented in Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt32Array, apache::geode::client::CacheableInt32ArrayPtr, System::Int32, GeodeClassIds::CacheableInt32Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableDoubleArray, apache::geode::client::CacheableDoubleArrayPtr, Double, GeodeClassIds::CacheableDoubleArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt16Array, apache::geode::client::CacheableInt16ArrayPtr, System::Int16, GeodeClassIds::CacheableInt16Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableBytes, apache::geode::client::CacheableBytesPtr, Byte, GeodeClassIds::CacheableBytes >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CharArray, apache::geode::client::CharArrayPtr, Char, GeodeClassIds::CharArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableFloatArray, apache::geode::client::CacheableFloatArrayPtr, Single, GeodeClassIds::CacheableFloatArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::BooleanArray, apache::geode::client::BooleanArrayPtr, bool, GeodeClassIds::BooleanArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt64Array, apache::geode::client::CacheableInt64ArrayPtr, System::Int64, GeodeClassIds::CacheableInt64Array >, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >, Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableLinkedHashSet, apache::geode::client::CacheableLinkedHashSet >, and Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableHashSet, apache::geode::client::CacheableHashSet >.

HasNext()

bool Apache::Geode::Client::Struct::HasNext

(

)

Check whether another field value is available to iterate over in this Struct.

Returns

true if available otherwise false.

Next()

Object ^ Apache::Geode::Client::Struct::Next

(

)

Get the next field value item available in this Struct.

Returns

A reference to the next item in the Struct or null if no more available.

operator Apache::Geode::Client::Serializable^() [1/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< bool >^  value )

staticinherited

Implicit conversion operator from an boolean array to a Serializable.

operator Apache::Geode::Client::Serializable^() [2/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Byte >^  value )

staticinherited

Implicit conversion operator from an array of bytes to a Serializable.

operator Apache::Geode::Client::Serializable^() [3/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Char >^  value )

staticinherited

Implicit conversion operator from a character array to a Serializable.

operator Apache::Geode::Client::Serializable^() [4/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Double >^  value )

staticinherited

Implicit conversion operator from a double array to a Serializable.

operator Apache::Geode::Client::Serializable^() [5/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Single >^  value )

staticinherited

Implicit conversion operator from a float array to a Serializable.

operator Apache::Geode::Client::Serializable^() [6/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< String^>^  value )

staticinherited

Implicit conversion operator from a string array to a Serializable.

operator Apache::Geode::Client::Serializable^() [7/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int16 >^  value )

staticinherited

Implicit conversion operator from a 16-bit integer array to a Serializable.

operator Apache::Geode::Client::Serializable^() [8/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int32 >^  value )

staticinherited

Implicit conversion operator from a 32-bit integer array to a Serializable.

operator Apache::Geode::Client::Serializable^() [9/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int64 >^  value )

staticinherited

Implicit conversion operator from a 64-bit integer array to a Serializable.

operator Apache::Geode::Client::Serializable^() [10/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( bool  value )

staticinherited

Implicit conversion operator from a boolean to a Serializable.

operator Apache::Geode::Client::Serializable^() [11/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Byte  value )

staticinherited

Implicit conversion operator from a byte to a Serializable.

operator Apache::Geode::Client::Serializable^() [12/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Char  value )

staticinherited

Implicit conversion operator from a character to a Serializable.

operator Apache::Geode::Client::Serializable^() [13/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Double  value )

staticinherited

Implicit conversion operator from a double to a Serializable.

operator Apache::Geode::Client::Serializable^() [14/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Single  value )

staticinherited

Implicit conversion operator from a float to a Serializable.

operator Apache::Geode::Client::Serializable^() [15/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( String^  value )

staticinherited

Implicit conversion operator from a string to a Serializable.

operator Apache::Geode::Client::Serializable^() [16/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( System::Int16  value )

staticinherited

Implicit conversion operator from a 16-bit integer to a Serializable.

operator Apache::Geode::Client::Serializable^() [17/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( System::Int32  value )

staticinherited

Implicit conversion operator from a 32-bit integer to a Serializable.

operator Serializable^()

static Apache::Geode::Client::Serializable::operator Serializable^ ( System::Int64  value )

staticinherited

Implicit conversion operator from a 64-bit integer to a Serializable.

RegisterPdxSerializer()

static void Apache::Geode::Client::Serializable::RegisterPdxSerializer ( IPdxSerializer^  pdxSerializer )

staticinherited

Set the PDX serializer for the cache.

If this serializer is set, it will be consulted to see if it can serialize any domain classes which are added to the cache in portable data exchange format.

RegisterPdxType()

static void Apache::Geode::Client::Serializable::RegisterPdxType ( PdxTypeFactoryMethod^  creationMethod )

staticinherited

Register an instance factory method for a given type. This should be used when registering types that implement IPdxSerializable.

Parameters

creationMethod

the creation function to register

Exceptions

IllegalArgumentException

if the method is null

RegisterTypeGeneric()

static void Apache::Geode::Client::Serializable::RegisterTypeGeneric ( TypeFactoryMethodGeneric^  creationMethod )

staticinherited

Register an instance factory method for a given type.

This should be used when registering types that implement IGeodeSerializable.

Parameters

creationMethod

the creation function to register

Exceptions

IllegalArgumentException	if the method is null
IllegalStateException	if the typeId has already been registered, or there is an error in registering the type; check Utils::LastError for more information in the latter case.

SetPdxTypeMapper()

static void Apache::Geode::Client::Serializable::SetPdxTypeMapper ( IPdxTypeMapper^  pdxTypeMapper )

staticinherited

Register an PdxTypeMapper to map the local types to pdx types

Parameters

pdxTypeMapper

Object which implements IPdxTypeMapper interface

ToData()

virtual void Apache::Geode::Client::Serializable::ToData ( Apache::Geode::Client::DataOutput^  output )

virtualinherited

Serializes this native (C++) object.

Parameters

output

the DataOutput object to use for serializing the object

Implements Apache::Geode::Client::IGeodeSerializable.

Reimplemented in Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt32Array, apache::geode::client::CacheableInt32ArrayPtr, System::Int32, GeodeClassIds::CacheableInt32Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableDoubleArray, apache::geode::client::CacheableDoubleArrayPtr, Double, GeodeClassIds::CacheableDoubleArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt16Array, apache::geode::client::CacheableInt16ArrayPtr, System::Int16, GeodeClassIds::CacheableInt16Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableBytes, apache::geode::client::CacheableBytesPtr, Byte, GeodeClassIds::CacheableBytes >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CharArray, apache::geode::client::CharArrayPtr, Char, GeodeClassIds::CharArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableFloatArray, apache::geode::client::CacheableFloatArrayPtr, Single, GeodeClassIds::CacheableFloatArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::BooleanArray, apache::geode::client::BooleanArrayPtr, bool, GeodeClassIds::BooleanArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt64Array, apache::geode::client::CacheableInt64ArrayPtr, System::Int64, GeodeClassIds::CacheableInt64Array >, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::Internal::CacheableHashSetType< TYPEID, HSTYPE >, Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableLinkedHashSet, apache::geode::client::CacheableLinkedHashSet >, and Apache::Geode::Client::Internal::CacheableHashSetType< Apache::Geode::Client::GeodeClassIds::CacheableHashSet, apache::geode::client::CacheableHashSet >.

ToString()

virtual String ^ Apache::Geode::Client::Serializable::ToString ( )

overridevirtualinherited

Return a string representation of the object.

It simply returns the string representation of the underlying native object by calling its toString() function.

Implements Apache::Geode::Client::IGeodeSerializable.

Reimplemented in Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt32Array, apache::geode::client::CacheableInt32ArrayPtr, System::Int32, GeodeClassIds::CacheableInt32Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableDoubleArray, apache::geode::client::CacheableDoubleArrayPtr, Double, GeodeClassIds::CacheableDoubleArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt16Array, apache::geode::client::CacheableInt16ArrayPtr, System::Int16, GeodeClassIds::CacheableInt16Array >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableBytes, apache::geode::client::CacheableBytesPtr, Byte, GeodeClassIds::CacheableBytes >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CharArray, apache::geode::client::CharArrayPtr, Char, GeodeClassIds::CharArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableFloatArray, apache::geode::client::CacheableFloatArrayPtr, Single, GeodeClassIds::CacheableFloatArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::BooleanArray, apache::geode::client::BooleanArrayPtr, bool, GeodeClassIds::BooleanArray >, Apache::Geode::Client::CacheableBuiltinArray< apache::geode::client::CacheableInt64Array, apache::geode::client::CacheableInt64ArrayPtr, System::Int64, GeodeClassIds::CacheableInt64Array >, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableFloat, Single, GeodeClassIds::CacheableFloat >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableInt32, System::Int32, GeodeClassIds::CacheableInt32 >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableDouble, Double, GeodeClassIds::CacheableDouble >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableBoolean, bool, GeodeClassIds::CacheableBoolean >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableInt64, System::Int64, GeodeClassIds::CacheableInt64 >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableInt16, System::Int16, GeodeClassIds::CacheableInt16 >, Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableWideChar, Char, GeodeClassIds::CacheableCharacter >, and Apache::Geode::Client::CacheableBuiltinKey< apache::geode::client::CacheableByte, Byte, GeodeClassIds::CacheableByte >.

Property Documentation

ClassId

virtual System:: UInt32 Apache::Geode::Client::Serializable::ClassId

getinherited

Returns the classId of the instance being serialized.

This is used by deserialization to determine what instance type to create and deserialize into.

Returns

the classId

Item

Object Apache::Geode::Client::Struct::Item

get

Get the field value for the given index number.

Get the field value for the given field name.

Returns

The value of the field or null if index is out of bounds.

Returns

The value of the field.

Exceptions

IllegalArgumentException

if the field name is not found.

Length

size_t Apache::Geode::Client::Struct::Length

get

Get the number of field values available.

Returns

the number of field values available.

ObjectSize

virtual System:: UInt32 Apache::Geode::Client::Serializable::ObjectSize

getinherited

return the size of this object in bytes

Set

Apache:: Geode:: Client:: StructSet< Object^>^ Apache::Geode::Client::Struct::Set

get

Get the parent StructSet of this Struct.

Returns

A reference to the parent StructSet of this Struct.