Class that serves as a reflective interface for the tuple types. More...

#include <SPL/Runtime/Type/Tuple.h>

Public Member Functions

Tuple ()

Tuple (const Tuple &rhs)

virtual ~Tuple ()

virtual bool equals (const Tuple &ot) const =0

virtual Tuple * clone () const =0

virtual Tuple & clear ()

virtual void reset ()=0

void assignFrom (Tuple const &ot, bool typesafe=true)

virtual void assign (Tuple const &ot)=0

void swapWith (Tuple &ot, bool typesafe=true)

virtual void serialize (NetworkByteBuffer &buf) const =0

virtual void deserialize (NetworkByteBuffer &buf)=0

virtual void serialize (NativeByteBuffer &buf) const =0

virtual void deserialize (NativeByteBuffer &buf)=0

virtual void serialize (std::ostream &ostr) const =0

virtual void serializeWithPrecision (std::ostream &ostr) const =0

virtual void deserialize (std::istream &istr, bool withSuffix=false)=0

virtual size_t hashCode () const =0

virtual bool isFacade () const

virtual size_t getSerializedSize () const

virtual unsigned char const * getSerializedDataPtr () const

const Tuple & operator= (const Tuple &ot)

virtual uint32_t getNumberOfAttributes () const =0

virtual TupleIterator getBeginIterator ()=0

virtual ConstTupleIterator getBeginIterator () const =0

virtual TupleIterator getEndIterator ()=0

virtual ConstTupleIterator getEndIterator () const =0

virtual TupleIterator findAttribute (const std::string &attrb)=0

virtual ConstTupleIterator findAttribute (const std::string &attrb) const =0

virtual TupleAttribute getAttribute (uint32_t index)=0

virtual ConstTupleAttribute getAttribute (uint32_t index) const =0

virtual ValueHandle getAttributeValue (const std::string &attrb)=0

virtual ConstValueHandle getAttributeValue (const std::string &attrb) const =0

virtual ValueHandle getAttributeValue (uint32_t index)=0

virtual ConstValueHandle getAttributeValue (uint32_t index) const =0

virtual const std::string & getAttributeName (uint32_t index) const =0

virtual const
std::tr1::unordered_map
< std::string, uint32_t > & getAttributeNames () const =0

virtual void deserializeWithNanAndInfs (std::istream &istr, bool withSuffix=false)=0

void toXML (std::ostream &ostr) const

void fromXML (std::istream &istr)

void assignPayload (Tuple const &rhs)

Detailed Description

Class that serves as a reflective interface for the tuple types.

Constructor & Destructor Documentation

SPL::Tuple::Tuple ( )

inline

Constructor

SPL::Tuple::Tuple ( const Tuple & rhs )

inline

Copy constructor

Parameters:

rhs tuple to copy from

virtual SPL::Tuple::~Tuple ( )

inlinevirtual

Destructor

Member Function Documentation

virtual bool SPL::Tuple::equals ( const Tuple & ot ) const

pure virtual

Equality comparison with another reflective tuple

Parameters:

ot reflective tuple to compare to

Returns:: true if equal, false otherwise

virtual Tuple* SPL::Tuple::clone ( ) const

pure virtual

Create a clone of the tuple object

Returns:: clone of the tuple object

virtual Tuple& SPL::Tuple::clear ( )

virtual

Clear the tuple attributes (all numeric attributes will become zero; booleans will become false; all strings, collections, and blobs will become empty; timestamps will become zero; enums will take the value of their first element; and tuples will be cleared recursively)

Returns:: this Tuple

virtual void SPL::Tuple::reset ( )

pure virtual

Reset the tuple attributes (all strings, collections, and blobs will become empty; and tuples will be reset recursively)

void SPL::Tuple::assignFrom ( Tuple const & ot,

bool typesafe = true

)

Assign this tuple using another tuple

Parameters:

ot other tuple to assign from

typesafe if true expects tuples of same type, otherwise (false) performs a partial assignment

Exceptions:

SPLRuntimeTypeMismatchException when typesafe assignment is requested and the types do not match

virtual void SPL::Tuple::assign ( Tuple const & ot )

pure virtual

Assign this tuple using another tuple of the same type

Parameters:

ot other tuple to assign from

void SPL::Tuple::swapWith ( Tuple & ot,

bool typesafe = true

)

Swap this tuple with another tuple

Parameters:

ot other tuple to swap with

typesafe if true expects tuples of same type, otherwise (false) performs a partial swap

virtual void SPL::Tuple::serialize ( NetworkByteBuffer & buf ) const

pure virtual

Serialize (binary)

Parameters:

buf serialization buffer to use

virtual void SPL::Tuple::deserialize ( NetworkByteBuffer & buf )

pure virtual

Deserialize (binary)

Parameters:

buf serialization buffer to use

virtual void SPL::Tuple::serialize ( NativeByteBuffer & buf ) const

pure virtual

Serialize (binary)

Parameters:

buf serialization buffer to use

virtual void SPL::Tuple::deserialize ( NativeByteBuffer & buf )

pure virtual

Deserialize (binary)

Parameters:

buf serialization buffer to use

virtual void SPL::Tuple::serialize ( std::ostream & ostr ) const

pure virtual

Serialize (character)

Parameters:

ostr output stream

virtual void SPL::Tuple::serializeWithPrecision ( std::ostream & ostr ) const

pure virtual

Serialize (character), with maximum precision for floats

Parameters:

ostr output stream

virtual void SPL::Tuple::deserialize ( std::istream & istr,

bool withSuffix = false

)

pure virtual

Deserialize (character)

Parameters:

istr input stream

withSuffix if true then any suffix will be consumed, otherwise (false) assume no suffix is present

virtual size_t SPL::Tuple::hashCode ( ) const

pure virtual

Get hash code

Returns:: hash code

virtual bool SPL::Tuple::isFacade ( ) const

inlinevirtual

Check if this a facade tuple

Returns:: true if this is a facade tuple, false otherwise

virtual size_t SPL::Tuple::getSerializedSize ( ) const

inlinevirtual

Get the size in bytes when serialized

Returns:: size in bytes when serialized

virtual unsigned char const* SPL::Tuple::getSerializedDataPtr ( ) const

inlinevirtual

Get the serialized data for the tuple (only if this is a facade tuple)

Returns:: the serialized data pointer, NULL if this is not a facade tuple

const Tuple& SPL::Tuple::operator= ( const Tuple & ot )

inline

Assign from another Tuple

Parameters:

ot other tuple to assign from

Returns:: this

virtual uint32_t SPL::Tuple::getNumberOfAttributes ( ) const

pure virtual

Get the number of attributes

Returns:: the number of attributes

virtual TupleIterator SPL::Tuple::getBeginIterator ( )

pure virtual

Get a begin iterator

Returns:: begin iterator

virtual ConstTupleIterator SPL::Tuple::getBeginIterator ( ) const

pure virtual

Get a begin iterator

Returns:: begin iterator

virtual TupleIterator SPL::Tuple::getEndIterator ( )

pure virtual

Get an end iterator

Returns:: end iterator

virtual ConstTupleIterator SPL::Tuple::getEndIterator ( ) const

pure virtual

Get an end iterator

Returns:: end iterator

virtual TupleIterator SPL::Tuple::findAttribute ( const std::string & attrb )

pure virtual

Find an attribute in the tuple

Parameters:

attrb attribute name

Returns:: an iterator for the element if found, the end iterator otherwise

virtual ConstTupleIterator SPL::Tuple::findAttribute ( const std::string & attrb ) const

pure virtual

Find an attribue in the tuple

Parameters:

attrb attribute name

Returns:: an iterator for the attribute if found, the end iterator otherwise

virtual TupleAttribute SPL::Tuple::getAttribute ( uint32_t index )

pure virtual

Get tuple attribue at the given index

Parameters:

index attribute index

Returns:: a tuple attribute

Exceptions:

SPLRuntimeInvalidIndex if index is not valid

virtual ConstTupleAttribute SPL::Tuple::getAttribute ( uint32_t index ) const

pure virtual

Get tuple attribue at the given index

Parameters:

index attribute index

Returns:: a tuple attribute

Exceptions:

SPLRuntimeInvalidIndex if index is not valid

virtual ValueHandle SPL::Tuple::getAttributeValue ( const std::string & attrb )

pure virtual

Get attribute value for the given attribute name Same as (*findAttribute(attrb)).getValue()

Parameters:

attrb attribute name

Returns:: a value handle for the tuple attribute

Exceptions:

SPLRuntimeInvalidIndex if attribute is not in the tuple

virtual ConstValueHandle SPL::Tuple::getAttributeValue ( const std::string & attrb ) const

pure virtual

Get attribute value for the given attribute name Same as (*findAttribute(attrb)).getValue()

Parameters:

attrb attribute name

Returns:: a value handle for the tuple attribute

virtual ValueHandle SPL::Tuple::getAttributeValue ( uint32_t index )

pure virtual

Get attribute value for the given index

Parameters:

index attribute index

Returns:: a value handle for the tuple attribute

virtual ConstValueHandle SPL::Tuple::getAttributeValue ( uint32_t index ) const

pure virtual

Get attribute value for the given index

Parameters:

index attribute index

Returns:: a value handle for the tuple attribute

virtual const std::string& SPL::Tuple::getAttributeName ( uint32_t index ) const

pure virtual

Return the i'th attribute name

Parameters:

index attribute index

Returns:: the attribute's name

virtual const std::tr1::unordered_map<std::string,uint32_t>& SPL::Tuple::getAttributeNames ( ) const

pure virtual

Return all the attributes for the Tuple

Returns:: attribute name map

virtual void SPL::Tuple::deserializeWithNanAndInfs ( std::istream & istr,

bool withSuffix = false

)

pure virtual

Deserialize with Inf and Nan (character)

Parameters:

istr input stream

withSuffix if true then any suffix will be consumed, otherwise (false) assume no suffix is present

void SPL::Tuple::toXML ( std::ostream & ostr ) const

Serialize a Tuple to the 'serialized tuple format'

Parameters:

ostr Stream to which the tuple should be serialized

void SPL::Tuple::fromXML ( std::istream & istr )

Deserialize a Tuple from the 'serialized tuple format'

Parameters:

istr Stream containing 'serialized tuple format' XML for a tuple of the same type a the current tuple.

Note:: the existing content of the tuple will be replaced by the values from the input stream of XML.

void SPL::Tuple::assignPayload ( Tuple const & rhs )

Assign the tuple's payload

Parameters:

rhs source tuple to assign payload from (if any)

The documentation for this class was generated from the following file:

SPL/Runtime/Type/Tuple.h