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

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

#include <Struct.hpp>

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

Public Member Functions
virtual String ^	ToString () override
	Return a string representation of the object.

Properties
int32_t	Count [get]
	Get the number of field values available.
Object^	Item [get]
	Get the field value for the given index number.
virtual System::UInt64	ObjectSize [get]
	return the size of this object in bytes
Apache::Geode::Client::StructSet< Object^>^	Set [get]
	Get the parent StructSet of this Struct.

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

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::ISerializable.

Reimplemented in Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableBoolean, bool, static_cast< int8_t >(DSCode::CacheableBoolean)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableByte, Byte, static_cast< int8_t >(DSCode::CacheableByte)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableCharacter, Char, static_cast< int8_t >(DSCode::CacheableCharacter)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableDouble, Double, static_cast< int8_t >(DSCode::CacheableDouble)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableFloat, Single, static_cast< int8_t >(DSCode::CacheableFloat)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt16, System::Int16, static_cast< int8_t >(DSCode::CacheableInt16)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt32, System::Int32, static_cast< int8_t >(DSCode::CacheableInt32)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt64, System::Int64, static_cast< int8_t >(DSCode::CacheableInt64)>, and Apache::Geode::Client::CacheableString.

Property Documentation

Count

int32_t Apache::Geode::Client::Struct::Count

get

Get the number of field values available.

Returns

the number of field values available.

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.

ObjectSize

virtual System:: UInt64 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.