Class that represents an xml type. More...

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

Public Member Functions

xml ()

xml (const char *schema)

xml (const std::string &schema)

xml (const char *schema, const char *data, size_t size)

xml (const char *schema, const char *value)

xml (const std::string &schema, const std::string &value)

xml (const std::string &schema, const char *data, size_t size)

xml (const ConstValueHandle &ot)

xml (const xml &ot)

virtual ~xml ()

bool operator== (const xml &rhs) const

bool operator!= (const xml &rhs) const

xml & operator= (const xml &rhs)

xml & operator= (const std::string &rhs)

xml & operator= (const SPL::Tuple &rhs)

void swap (xml &ot)

void clear ()

Clear - clear the XML object. More...

const std::string & getValue () const

const std::string & getSchema () const

bool hasSchema () const

template<class BufferType >

void serialize (ByteBuffer< BufferType > &buf) const

template<class BufferType >

void deserialize (ByteBuffer< BufferType > &buf)

void serialize (std::ostream &ostr) const

void deserialize (std::istream &istr)

size_t hashCode () const

size_t getSerializedSize () const

Detailed Description

Class that represents an xml type.

An xml type has an optional schema, and contains the xml value

Constructor & Destructor Documentation

◆ xml() [1/9]

SPL::xml::xml ( )

inline

Empty constructor

◆ xml() [2/9]

SPL::xml::xml ( const char * schema )

inline

Constructor

Parameters

schema Schema against which the xml is validated An empty string signifies no validation

◆ xml() [3/9]

SPL::xml::xml ( const std::string & schema )

inline

Constructor

Parameters

schema Schema against which the xml is validated

◆ xml() [4/9]

SPL::xml::xml ( const char * schema,

const char * data,

size_t size

)

inline

Constructor

Parameters

schema Schema against which the xml is validated

data XML data

size size of XML data

◆ xml() [5/9]

SPL::xml::xml ( const char * schema,

const char * value

)

inline

Constructor

Parameters

schema schema for XML

value initial XML value

◆ xml() [6/9]

SPL::xml::xml ( const std::string & schema,

const std::string & value

)

inline

Constructor

Parameters

schema schema for XML

value initial XML value

◆ xml() [7/9]

SPL::xml::xml ( const std::string & schema,

const char * data,

size_t size

)

inline

Constructor

Parameters

schema schema for XML

data XML data

size size of XML data

◆ xml() [8/9]

SPL::xml::xml ( const ConstValueHandle & ot )

inline

Constructor

Parameters

ot Value handle

◆ xml() [9/9]

SPL::xml::xml ( const xml & ot )

inline

Copy contructor

Parameters

ot other xml

◆ ~xml()

virtual SPL::xml::~xml ( )

inlinevirtual

Destructor

Member Function Documentation

◆ operator==()

bool SPL::xml::operator== ( const xml & rhs ) const

inline

Equality operator

Parameters

rhs other xml

◆ operator!=()

bool SPL::xml::operator!= ( const xml & rhs ) const

inline

Inequality operator

Parameters

rhs other xml

◆ operator=() [1/3]

xml& SPL::xml::operator= ( const xml & rhs )

inline

Assignment operator

Parameters

rhs other xml

◆ operator=() [2/3]

xml& SPL::xml::operator= ( const std::string & rhs )

inline

Assignment operator

Parameters

rhs string value to assign

◆ operator=() [3/3]

xml& SPL::xml::operator= ( const SPL::Tuple & rhs )

inline

Assignment operator

Parameters

rhs tuple value to assign

◆ swap()

void SPL::xml::swap ( xml & ot )

inline

Swap

Parameters

ot xml to swap with

◆ clear()

void SPL::xml::clear ( )

inline

Clear - clear the XML object.

◆ getValue()

const std::string& SPL::xml::getValue ( ) const

inline

The XML value

Returns: the XML value

◆ getSchema()

const std::string& SPL::xml::getSchema ( ) const

inline

The XML schema

Returns: the XML schema

◆ hasSchema()

bool SPL::xml::hasSchema ( ) const

inline

Does this XML value have an associate XML schema

Returns: true if there is a schema associated with the value

◆ serialize() [1/2]

template<class BufferType >

void SPL::xml::serialize ( ByteBuffer< BufferType > & buf ) const

inline

Serialize (binary)

Parameters

buf byte buffer to use

◆ deserialize() [1/2]

template<class BufferType >

void SPL::xml::deserialize ( ByteBuffer< BufferType > & buf )

inline

Deserialize (binary)

Parameters

buf byte buffer to use

◆ serialize() [2/2]

void SPL::xml::serialize ( std::ostream & ostr ) const

Serialize (character)

Parameters

ostr output stream

◆ deserialize() [2/2]

void SPL::xml::deserialize ( std::istream & istr )

Deserialize (character)

Parameters

istr input stream

◆ hashCode()

size_t SPL::xml::hashCode ( ) const

inline

Get hash code

Returns: hash code

◆ getSerializedSize()

size_t SPL::xml::getSerializedSize ( ) const

inline

Get the size in bytes when serialized

Returns: size in bytes when serialized

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

SPL/Runtime/Type/Xml.h