#include <datatypebase.h>

Detailed Description

General Data class. An object of this class can store every type of data as long as that type has been registered (see DataType).

See also: $ref datatype_data

Public Member Functions
	Data ()=default

Result< void >	Init (const DataType &type)

	~Data ()

Bool	IsEmpty () const

Bool	IsPopulated () const

const DataType &	GetType () const

void	Reset ()

template<typename T >
	Data (T &&data, typename std::enable_if< !STD_IS_REPLACEMENT(same, typename std::decay< T >::type, Data), DummyParamType * >::type=(DummyParamType *) nullptr)

	Data (Data &&src)

Data &	operator= (Data &&src)

Result< Data >	GetCopy () const

Result< void >	CopyFrom (const Data &src)

Result< void >	CopyFrom (const ConstDataPtr &src)

Result< void >	MoveFrom (MoveDataPtr &&src)

Result< void >	CopyFrom (ForwardingDataPtr &&src)

template<typename T >
Result< void >	Set (T &&data)

template<typename T >
Result< typename std::conditional< GetCollectionKind< T >::value==COLLECTION_KIND::ARRAY, T, typename ByValueParam< T >::type >::type >	Get () const

template<typename T >
Result< typename std::conditional< STD_IS_REPLACEMENT(void, T)\|\|(GetCollectionKind< T >::value==COLLECTION_KIND::ARRAY), T, T & >::type >	Get ()

template<typename T >
ByValueParam< T >::type	GetOrDefault () const

template<typename T >
MAXON_ATTRIBUTE_FORCE_INLINE ByValueParam< T >::type	GetOrNull () const

template<typename T >
T	Get (const T &defaultValue) const

template<typename T >
Result< T >	Convert () const

template<typename T >
T	ConvertOrDefault () const

template<typename T >
T	Convert (const T &defaultValue) const

Result< Data >	ConvertData (const DataType &destType) const

template<typename T >
T *	GetPtr ()

template<typename T >
const T *	GetPtr () const

Generic *	GetPtr (const DataType &type)

const Generic *	GetPtr (const DataType &type) const

const Generic *	PrivateGetPtr () const

const Generic *	PrivateGetPtr (const DataType &type) const

TupleValue *	GetTuple ()

const TupleValue *	GetTuple () const

String	ToString (const FormatStatement *formatStatement=nullptr) const

COMPARERESULT	Compare (const Data &c) const

HashInt	GetHashCode () const

UniqueHash	GetUniqueHashCode () const

Bool	IsEqual (const Data &other, EQUALITY equality=EQUALITY::DEEP) const

Bool	operator== (const Data &other) const

Bool	operator!= (const Data &other) const

Bool	operator== (const ConstDataPtr &other) const

Bool	operator!= (const ConstDataPtr &other) const

Bool	operator< (const Data &other) const

Bool	operator<= (const Data &other) const

Bool	operator> (const Data &other) const

Bool	operator>= (const Data &other) const

ConstDataPtr	ToConstDataPtr (const DataType &expectedType) const

template<typename DEST , typename SRC >
Result< void >	SetImpl (SRC &&data, OverloadRank0)

template<typename DEST >
Result< void >	SetImpl (const Data &data, OverloadRank1)

template<typename DEST >
Result< void >	SetImpl (Data &data, OverloadRank1)

template<typename DEST >
Result< void >	SetImpl (Data &&data, OverloadRank1)

template<typename DEST , typename SRC >
std::enable_if< GetCollectionKind< SRC >::value==COLLECTION_KIND::ARRAY, Result< void > >::type	SetImpl (SRC &&data, OverloadRank1)

template<>
void	InitSet (Data &&data)

template<>
Data *	GetPtr ()

template<>
Result< void >	Get () const

template<>
Result< void >	Set (const Data &value)

template<>
Result< void >	Set (Data &value)

template<>
Result< void >	Set (Data &&value)

template<>
void	InitSet (HTTPREQUESTTYPE &&d)

Static Public Member Functions
template<typename T >
static Result< Data >	Create ()

Private Member Functions
	MAXON_DISALLOW_COPY_AND_ASSIGN (Data)

template<typename T >
Result< typename ByValueParam< T >::type >	GetImpl (OverloadRank0) const

template<typename T >
std::enable_if< GetCollectionKind< T >::value==COLLECTION_KIND::ARRAY, Result< T > >::type	GetImpl (OverloadRank1) const

template<typename T >
Result< typename std::conditional< STD_IS_REPLACEMENT(void, T), void, T & >::type >	GetImpl (OverloadRank0)

template<typename T >
std::enable_if< GetCollectionKind< T >::value==COLLECTION_KIND::ARRAY, Result< T > >::type	GetImpl (OverloadRank1)

template<typename T >
SFINAEHelper< Result< T >, typename T::IsBlock >::type	GetImpl (OverloadRank2)

template<typename T >
SFINAEHelper< Result< T >, typename T::IsBlock >::type	GetImpl (OverloadRank2) const

template<typename T >
void	InitSet (T &&data)

Static Private Member Functions
static const ObjectInterface *	CheckInstanceOf (const ObjectInterface *obj, const DataType &type)

static const ObjectRef *	CheckInstanceOf (const ObjectRef *obj, const DataType &type)

Private Attributes
DataType	_typeInfo

DataMemBlock	_memBlock

Friends
class	DataDictionaryInterface

class	DataDictionaryObjectInterface

class	Url

class	ConstDataPtr

class	TrivialDataPtr

class	COWData

Constructor & Destructor Documentation

◆ Data() [1/3]

Data ( )

default

constructor initializes the data with an nullptr type.

◆ ~Data()

~Data ( )

◆ Data() [2/3]

Data	(	T &&	data,
		typename std::enable_if< !STD_IS_REPLACEMENT(same, typename std::decay< T >::type, Data), DummyParamType * >::type	= `(DummyParamType*)nullptr`
	)

explicit

Template class to construct a Data object from a value. The value has to fit in DataMemBlock, i.e., this constructor can only be used when SIZEOF(T) <= SIZEOF(DataMemBlock). Otherwise, you have to use Set which might return an error.

Template Parameters

T	Type of data. This constructor only works if SIZEOF(T) <= SIZEOF(DataMemBlock).

Parameters

[in] data Data to copy into the Data.

◆ Data() [3/3]

Data ( Data && src )

Template class to move Data from every specialized data type. e.g. Int32, Url etc.

Parameters

[in,out] src Data to move to this.

Member Function Documentation

◆ MAXON_DISALLOW_COPY_AND_ASSIGN()

MAXON_DISALLOW_COPY_AND_ASSIGN ( Data )

private

◆ Init()

Result<void> Init ( const DataType & type )

Initializes this data to the given type. If this data already has the given type, nothing happens, i.e., the value is not reset. Otherwise, the current value is freed, and the data is initialized with a new default value of the given type.

Parameters

[in] type Type to which this data shall be set.

Returns: False if the initialization failed.

◆ IsEmpty()

Bool IsEmpty ( ) const

Checks if a Data is empty.

Returns: True if it doesn't contain any data.

◆ IsPopulated()

Bool IsPopulated ( ) const

Checks if a Data contains anything.

Returns: True if it contains data.

◆ GetType()

const DataType& GetType ( ) const

Returns the DataType of the Data. you can compare this value to GetDataType<Int32>() or GetDataType<String>().

Returns: DataType pointer of this.

◆ Reset()

void Reset ( )

Frees the wrapped data and resetd the Data object to its initial state.

◆ operator=()

Data& operator= ( Data && src )

Assignment move operator to move Data, (e.g. Swap uses this)

Parameters

[in] src Data to move to this.

◆ CopyFrom() [1/3]

Result<void> CopyFrom ( const Data & src )

Makes this @CLASS a copy of src by copying the contents of src into this @CLASS.

Parameters

[in] src Another @CLASS to be used as source for the copy operation.

Returns: OK on success.

◆ CopyFrom() [2/3]

Result<void> CopyFrom ( const ConstDataPtr & src )

Copies data described by a ConstDataPtr.

Parameters

[in] src ConstDataPtr to copy data from.

Returns: OK on success.

◆ MoveFrom()

Result<void> MoveFrom ( MoveDataPtr && src )

Moves data described by a MoveDataPtr.

Parameters

[in] src MoveDataPtr to move data from.

Returns: OK on success.

◆ CopyFrom() [3/3]

Result<void> CopyFrom ( ForwardingDataPtr && src )

Copies or moves data described by a ForwardingDataPtr.

Parameters

[in] src ForwardingDataPtr to copy or move data from.

Returns: OK on success.

◆ Set()

Result<void> Set ( T && data )

Set or move a value into a Data.

Parameters

[in] data New value for this Data object.

◆ Get() [1/3]

Result<typename std::conditional<GetCollectionKind<T>::value == COLLECTION_KIND::ARRAY, T, typename ByValueParam<T>::type>::type> Get ( ) const

Returns the value of type T of this Data.

Template Parameters

T	The expected type of the value.

Returns: The value stored in this Data, or an error if this Data doesn't store a value of type T.

◆ Get() [2/3]

Result<typename std::conditional<STD_IS_REPLACEMENT(void, T) || (GetCollectionKind<T>::value == COLLECTION_KIND::ARRAY), T, T&>::type> Get ( )

◆ GetOrDefault()

ByValueParam<T>::type GetOrDefault ( ) const

Returns the value of type T of this Data.

Template Parameters

T	The expected type of the value.

Returns: The value stored in this Data, or a default value if this Data doesn't store a value of type T.

◆ GetOrNull()

MAXON_ATTRIBUTE_FORCE_INLINE ByValueParam<T>::type GetOrNull ( ) const

◆ Get() [3/3]

T Get ( const T & defaultValue ) const

Returns the value of type T of this Data.

Parameters

[in] defaultValue If this Data doesn't store a value of type T, the default value will be returned.

Template Parameters

T	The expected type of the value.

Returns: The value stored in this Data, or defaultValue if this Data doesn't store a value of type T.

◆ Convert() [1/2]

Result<T> Convert ( ) const

Returns the value of this Data, converted to T.

Template Parameters

T	The type to convert to.

Returns: The value stored in this Data, converted to T, or an error if this Data doesn't store a value or the value cannot be converted to T.

See also: DataType::Convert

◆ ConvertOrDefault()

T ConvertOrDefault ( ) const

Returns the value of this Data, converted to T.

Template Parameters

T	The type to convert to.

Returns: The value stored in this Data, converted to T, or T() if this Data doesn't store a value or the value cannot be converted to T.

See also: DataType::Convert

◆ Convert() [2/2]

T Convert ( const T & defaultValue ) const

Returns the value of this Data, converted to T.

Parameters

[in] defaultValue If this Data doesn't store a value or the value cannot converted to T, the default value will be returned.

Template Parameters

T	The type to convert to.

Returns: The value stored in this Data, converted to T, or defaultValue if this Data doesn't store a value or the value cannot be converted to T.

See also: DataType::Convert

◆ ConvertData()

Result<Data> ConvertData ( const DataType & destType ) const

Returns the value of this Data, converted to destType.

Parameters

[in] destType The type to convert to.

Returns: The value stored in this Data, converted to destType, or an error if this Data doesn't store a value or the value cannot be converted to dataType.

See also: DataType::Convert

◆ GetPtr() [1/3]

const T* GetPtr ( ) const

Returns the pointer of the native data if its type matches the given type T, otherwise nullptr.

Template Parameters

T	The desired type.

Returns: Pointer to the data in native format.

◆ GetPtr() [2/3]

Generic* GetPtr ( const DataType & type )

Returns the pointer of the native data if its type matches the given type, otherwise nullptr.

Parameters

[in] type The desired type.

Returns: Pointer to the data in native format.

◆ GetPtr() [3/3]

const Generic* GetPtr ( const DataType & type ) const

◆ PrivateGetPtr() [1/2]

const Generic* PrivateGetPtr ( ) const

Returns the pointer to the native data.

Returns: Pointer to the data in native format.

◆ PrivateGetPtr() [2/2]

const Generic* PrivateGetPtr ( const DataType & type ) const

Returns the pointer to the native data. It is not checked if its type matches the given type, the only purpose of the parameter is to enable a special behavior when type is the type Data: Then a pointer to this Data object itself is returned.

Parameters

[in] type The desired type.

Returns: Pointer to the data in native format.

◆ GetTuple() [1/2]

TupleValue* GetTuple ( )

Returns the value of this Data object as a TupleValue. If this object doesn't hold a tuple value, nullptr is returned.

Returns: Pointer to the TupleValue stored in this object, or nullptr if no tuple value is stored.

◆ GetTuple() [2/2]

const TupleValue* GetTuple ( ) const

Returns the value of this Data object as a TupleValue. If this object doesn't hold a tuple value, nullptr is returned.

Returns: Pointer to the TupleValue stored in this object, or nullptr if no tuple value is stored.

◆ ToString()

String ToString ( const FormatStatement * formatStatement = nullptr ) const

Returns a readable string of the content.

Parameters

[in] formatStatement Nullptr or additional formatting instruction. See also Formatting Mixed types.

Returns: The converted result.

◆ Compare()

COMPARERESULT Compare ( const Data & c ) const

Returns a readable string of the content.

Returns: String that represents the content of Data.

◆ GetHashCode()

HashInt GetHashCode ( ) const

Returns the hash code of the wrapped object. If the object's type doesn't provide a hash code function, this function returns DefaultHasher::EMPTY_HASH.

Returns: Hash code of this Data.

◆ GetUniqueHashCode()

UniqueHash GetUniqueHashCode ( ) const

Returns the hash value of the wrapped object. If the object's type doesn't provide a hash value function, this function returns a default-constructed UniqueHash.

Returns: Hash code of this Data.

◆ IsEqual()

Bool IsEqual	(	const Data &	other,
		EQUALITY	equality = `EQUALITY::DEEP`
	)		const

Returns true if the wrapped object of this Data equals that of the other Data.

Parameters

[in]	other	Another Data object to compare.
[in]	equality	The equality mode, by default EQUALITY::DEEP.

Returns: True if both Data objects are equal, false otherwise.

◆ operator==()

Bool operator== ( const Data & other ) const

==

◆ operator!=() [1/2]

Bool operator!= ( const Data & other ) const

!=

◆ operator!=() [2/2]

Bool operator!= ( const ConstDataPtr & other ) const

◆ operator<()

Bool operator< ( const Data & other ) const

<

◆ operator<=()

Bool operator<= ( const Data & other ) const

<=

◆ operator>()

Bool operator> ( const Data & other ) const

>

◆ operator>=()

Bool operator>= ( const Data & other ) const

>=

◆ ToConstDataPtr()

ConstDataPtr ToConstDataPtr ( const DataType & expectedType ) const

◆ SetImpl()

std::enable_if< GetCollectionKind< SRC >::value==COLLECTION_KIND::ARRAY, Result< void > >::type SetImpl	(	SRC &&	data,
		OverloadRank1
	)

◆ CheckInstanceOf() [1/2]

static const ObjectInterface* CheckInstanceOf	(	const ObjectInterface *	obj,
		const DataType &	type
	)

staticprivate

◆ CheckInstanceOf() [2/2]

static const ObjectRef* CheckInstanceOf	(	const ObjectRef *	obj,
		const DataType &	type
	)

DataType _typeInfo

private

pointer to the DataType structure

◆ _memBlock

DataMemBlock _memBlock

private

placeholder for embedded data. this size must stay for compatibility reasons.

Detailed Description

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ Data() [1/3]

◆ ~Data()

◆ Data() [2/3]

◆ Data() [3/3]

Member Function Documentation

◆ MAXON_DISALLOW_COPY_AND_ASSIGN()

◆ Init()

◆ IsEmpty()

◆ IsPopulated()

◆ GetType()

◆ Reset()

◆ operator=()

◆ CopyFrom() [1/3]

◆ CopyFrom() [2/3]

◆ MoveFrom()

◆ CopyFrom() [3/3]

◆ Set()

◆ Get() [1/3]

◆ Get() [2/3]

◆ GetOrDefault()

◆ GetOrNull()

◆ Get() [3/3]

◆ Convert() [1/2]

◆ ConvertOrDefault()

◆ Convert() [2/2]

◆ ConvertData()

◆ GetPtr() [1/3]

◆ GetPtr() [2/3]

◆ GetPtr() [3/3]

◆ PrivateGetPtr() [1/2]

◆ PrivateGetPtr() [2/2]

◆ GetTuple() [1/2]

◆ GetTuple() [2/2]

◆ ToString()

◆ Compare()

◆ GetHashCode()

◆ GetUniqueHashCode()

◆ IsEqual()

◆ operator==()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator<()

◆ operator<=()

◆ operator>()

◆ operator>=()

◆ ToConstDataPtr()

◆ SetImpl()

◆ CheckInstanceOf() [1/2]

◆ CheckInstanceOf() [2/2]

◆ GetImpl() [1/6]

◆ GetImpl() [2/6]

◆ GetImpl() [3/6]

◆ GetImpl() [4/6]

◆ GetImpl() [5/6]

◆ GetImpl() [6/6]

◆ InitSet()

Friends And Related Function Documentation

◆ DataDictionaryInterface

◆ DataDictionaryObjectInterface

◆ Url

◆ ConstDataPtr

◆ TrivialDataPtr

◆ COWData

Member Data Documentation

◆ _typeInfo

◆ _memBlock