SPL::optional< T > Class Template Reference

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

Inheritance diagram for SPL::optional< T >:

Public Types
using	value_type = T

Public Member Functions
	optional ()
	optional (const value_type &val)
	optional (const optional< T > &ot)
	optional (const ConstValueHandle &o)
virtual	~optional ()=default
virtual bool	isPresent () const
virtual void	setPresentWithDefaultValue ()
	Sets the underlying value of the optional to be a default initialized value of the underlying type T. Once this is done, isPresent() will return true unless the optional is later reset to null. More...
T &	value ()
const T &	value () const
size_t	getSerializedSize () const
optional< T > &	operator= (const T &val)
virtual ValueHandle	createValue () const
virtual Optional *	clone () const
virtual ValueHandle	getValue ()
virtual ConstValueHandle	getValue () const
virtual Meta::Type	getValueMetaType () const
virtual void	swapWith (Optional &ot)
	Swaps the null-ness or wrapped value (if not null) of another Optional with this Optional's state, using intermediate copies as necessary. More...
virtual void	assignFrom (const Optional &ot)
	Assigns the null-ness or wrapped value (if not null) of another Optional to this Optional's state. This will perform copying of any underlying value to preserve value semantics. More...
virtual bool	equals (const Optional &ot) const
virtual void	setValue (const ConstValueHandle &v)
	Sets the underlying value of the optional to be the same value as the one wrapped by the given const value handle. This performs a copy of the value pointed to by the handle so as to preserve value semantics. More...
bool	operator== (const SPL::optional< T > &other) const
bool	operator!= (const SPL::optional< T > &other) const
void	clear ()
	Reset to null. More...
virtual void	serialize (std::ostream &ostr) const
virtual void	deserialize (std::istream &istr, bool withSuffix=false)
template<class BufferType >
void	serialize (ByteBuffer< BufferType > &sbuf) const
template<class BufferType >
void	deserialize (ByteBuffer< BufferType > &sbuf)
void	deserializeWithNanAndInfs (std::istream &istr, bool withSuffix=false)
virtual size_t	hashCode () const
template<>
void	clear ()
	Reset this optional to null. More...
Public Member Functions inherited from SPL::Optional
virtual	~Optional ()=default
const Optional &	operator= (const Optional &ov)

Member Typedef Documentation

value_type

template<class T >

using SPL::optional< T >::value_type = T

Constructor & Destructor Documentation

optional() [1/4]

template<class T >

SPL::optional< T >::optional ( )

inlineexplicit

optional() [2/4]

template<class T >

SPL::optional< T >::optional ( const value_type &  val )

inlineexplicit

optional() [3/4]

template<class T >

SPL::optional< T >::optional ( const optional< T > &  ot )

inline

optional() [4/4]

template<class T >

SPL::optional< T >::optional ( const ConstValueHandle &  o )

inline

~optional()

template<class T >

virtual SPL::optional< T >::~optional ( )

virtualdefault

Member Function Documentation

isPresent()

template<class T >

virtual bool SPL::optional< T >::isPresent ( ) const

inlinevirtual

Returns true if the optional is set to non-null, false if it is null

Returns

true if the optional is set to non-null, false if it is null

Implements SPL::Optional.

setPresentWithDefaultValue()

template<class T >

virtual void SPL::optional< T >::setPresentWithDefaultValue ( )

inlinevirtual

Sets the underlying value of the optional to be a default initialized value of the underlying type T. Once this is done, isPresent() will return true unless the optional is later reset to null.

Implements SPL::Optional.

value() [1/2]

template<class T >

T& SPL::optional< T >::value ( )

inline

value() [2/2]

template<class T >

const T& SPL::optional< T >::value ( ) const

inline

getSerializedSize()

template<class T >

size_t SPL::optional< T >::getSerializedSize ( ) const

inlinevirtual

Get the size in bytes when serialized

Returns

size in bytes when serialized

Implements SPL::Optional.

operator=()

template<class T >

optional<T>& SPL::optional< T >::operator= ( const T &  val )

inline

createValue()

template<class T >

virtual ValueHandle SPL::optional< T >::createValue ( ) const

inlinevirtual

Create a new value of the value type. The returned value handle is a wrapper for an object allocated on the heap. As a result, the caller is responsible for cleaning up the memory by calling ValueHandle::deleteValue()

Returns

value handle for the new element

Implements SPL::Optional.

clone()

template<class T >

virtual Optional* SPL::optional< T >::clone ( ) const

inlinevirtual

Returns a cloned copy of this Optional

Returns

a cloned copy of this Optional

Implements SPL::Optional.

getValue() [1/2]

template<class T >

virtual ValueHandle SPL::optional< T >::getValue ( )

inlinevirtual

If the optional isPresent(), return a handle the underlying value of type T wrapped by the optional. Otherwise a runtime exception occurs.

Returns

a handle to the underlying value wrapped by the optional

Implements SPL::Optional.

getValue() [2/2]

template<class T >

virtual ConstValueHandle SPL::optional< T >::getValue ( ) const

inlinevirtual

If the optional isPresent(), return a const handle the underlying value of type T wrapped by the optional. Otherwise a runtime exception occurs.

Returns

a const handle to the underlying value wrapped by the optional

Implements SPL::Optional.

getValueMetaType()

template<class T >

virtual Meta::Type SPL::optional< T >::getValueMetaType ( ) const

inlinevirtual

Returns

the metatype corresponding to the underlying value of type T

Implements SPL::Optional.

swapWith()

template<class T >

virtual void SPL::optional< T >::swapWith ( Optional &  ot )

inlinevirtual

Swaps the null-ness or wrapped value (if not null) of another Optional with this Optional's state, using intermediate copies as necessary.

Implements SPL::Optional.

assignFrom()

template<class T >

virtual void SPL::optional< T >::assignFrom ( const Optional &  ov )

inlinevirtual

Assigns the null-ness or wrapped value (if not null) of another Optional to this Optional's state. This will perform copying of any underlying value to preserve value semantics.

Implements SPL::Optional.

equals()

template<class T >

virtual bool SPL::optional< T >::equals ( const Optional &  ot ) const

inlinevirtual

Returns true if the type and either the null-ness or wrapped value (if not null) of the given Optional is the same as this optional. If the types of the Optionals do not match, a runtime exception occurs.

Returns

true if the type and either the null-ness or wrapped value (if not null) of the given Optional is the same as this optional. If the types of the Optionals do not match, a runtime exception occurs.

Implements SPL::Optional.

setValue()

template<class T >

virtual void SPL::optional< T >::setValue ( const ConstValueHandle &  v )

inlinevirtual

Sets the underlying value of the optional to be the same value as the one wrapped by the given const value handle. This performs a copy of the value pointed to by the handle so as to preserve value semantics.

Implements SPL::Optional.

operator==()

template<class T >

bool SPL::optional< T >::operator== ( const SPL::optional< T > &  other ) const

inline

operator!=()

template<class T >

bool SPL::optional< T >::operator!= ( const SPL::optional< T > &  other ) const

inline

clear() [1/2]

template<class T >

void SPL::optional< T >::clear ( )

inlinevirtual

Reset to null.

Implements SPL::Optional.

serialize() [1/2]

template<class T >

void SPL::optional< T >::serialize ( std::ostream &  ostr ) const

virtual

Serialize (character)

Parameters

ostr	output stream

Implements SPL::Optional.

deserialize() [1/2]

template<class T >

void SPL::optional< T >::deserialize ( std::istream &  istr, bool  withSuffix = false  )

virtual

Deserialize (character)

Parameters

istr	input stream
withSuffix	if true then consume suffix, otherwise (false) assume no suffix is present

Implements SPL::Optional.

serialize() [2/2]

template<class T >

template<class BufferType >

void SPL::optional< T >::serialize ( ByteBuffer< BufferType > &  sbuf ) const

inline

Serialize (binary)

Parameters

buf	byte buffer to use

deserialize() [2/2]

template<class T >

template<class BufferType >

void SPL::optional< T >::deserialize ( ByteBuffer< BufferType > &  sbuf )

inline

Deserialize (binary)

Parameters

buf	byte buffer to use

deserializeWithNanAndInfs()

template<class T >

void SPL::optional< T >::deserializeWithNanAndInfs	(	std::istream &	istr,
		bool	withSuffix = false
	)

Deserialize with Inf and Nan (character)

Parameters

istr	input stream
withSuffix	if true then consume suffix, otherwise (false) assume no suffix is present

hashCode()

template<class T >

virtual size_t SPL::optional< T >::hashCode ( ) const

inlinevirtual

Get hash code

Returns

hash code

Implements SPL::Optional.

clear() [2/2]

template<>

void SPL::optional< ustring >::clear ( )

inlinevirtual

Reset this optional to null.

Implements SPL::Optional.

---

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

• SPL/Runtime/Type/Optional.h