#include <ValueHash.h>

Classes
struct	Private

Public Member Functions
	ValueHash (std::initializer_list< std::pair< QString, Value > >)

	ValueHash (const QHash< QString, Value > &_value)

	ValueHash (const ValueHash &_list)

	ValueHash (ValueHash &&_list)

ValueHash	operator= (const ValueHash &_list)

int	size () const

QStringList	keys () const

Value	value (const QString &_key) const

template<typename _T_ >
ReturnValue< _T_ >	value (const QString &_key) const

template<typename _T_ >
ReturnValue< _T_ >	value (const QString &_key, const _T_ &_default) const

bool	contains (const QString &_key) const

bool	contains (const QString &_key, const knowCore::Uri &_datatype) const

template<typename _T_ >
bool	contains (const QString &_key) const

knowCore::ReturnVoid	ensureContains (const QString &_key, const knowCore::Uri &_datatype) const

template<typename _T_ >
knowCore::ReturnVoid	ensureContains (const QString &_key) const

template<typename _T_ >
ReturnValue< QHash< QString, _T_ > >	hash () const

QHash< QString, Value >	hash () const

template<typename _T_ >
ReturnValue< QMap< QString, _T_ > >	map () const

QMap< QString, Value >	map () const

template<typename _T_ >
ReturnValue< QList< _T_ > >	values () const

QList< Value >	values () const

bool	operator== (const ValueHash &_rhs) const

bool	operator!= (const ValueHash &_rhs) const

bool	operator== (const QHash< QString, Value > &_rhs) const

ReturnValue< QByteArray >	md5 () const

ReturnValue< QJsonValue >	toJsonValue (const SerialisationContexts &_contexts) const

ReturnValue< QCborValue >	toCborValue (const SerialisationContexts &_contexts) const

ReturnValue< QString >	printable () const

QVariantHash	toVariantHash () const

QVariantMap	toVariantMap () const

QVariant	toVariant () const

ReturnVoid	checkContainsOnly (const Uri &_uri) const

template<typename _T_ >
ReturnVoid	checkContainsOnly () const

	operator Value () const

template<typename _T_ >
ValueHash &	add (const QString &_key, const _T_ &_value)

template<typename _T_ , typename... _TOther_>
ValueHash &	add (const QString &_key, const _T_ &_value, const QString &_key_n, const _TOther_ &... _other)

ValueHash &	add (const QString &_key, const knowCore::Value &_value)

knowCore::ReturnVoid	add (const QString &_key, const QVariant &_value)

knowCore::ReturnVoid	add (const QVariantHash &_value)

ValueHash &	add (const knowCore::ValueHash &_value)

knowCore::ReturnVoid	add (const QVariantMap &_value)

knowCore::ReturnVoid	add (const QJsonObject &_value)

ValueHash &	remove (const QString &_key)

void	clear ()

Static Public Member Functions
static ReturnValue< ValueHash >	fromVariantMap (const QVariantMap &_map)

static ReturnValue< ValueHash >	fromVariantHash (const QVariantHash &_map)

static ReturnValue< ValueHash >	fromJsonValue (const QJsonValue &_value, const DeserialisationContexts &_contexts)

static ReturnValue< ValueHash >	fromCborValue (const QCborValue &_value, const DeserialisationContexts &_contexts)

Detailed Description

Represent a (key, value) where key are strings for integration with knowCore::Value.

Member Function Documentation

◆ add() [1/8]

ValueHash & ValueHash::add ( const knowCore::ValueHash & _value )

Merge a QVariantHash into the hash.

◆ add() [2/8]

knowCore::ReturnVoid ValueHash::add ( const QJsonObject & _value )

Attempt to add the content of a QJsonObject to the hash.

◆ add() [3/8]

template<typename _T_ >

ValueHash & knowCore::ValueHash::add	(	const QString &	_key,
		const _T_ &	_value )

inline

Add a value to the hash with the given key.

◆ add() [4/8]

template<typename _T_ , typename... _TOther_>

ValueHash & knowCore::ValueHash::add	(	const QString &	_key,
		const _T_ &	_value,
		const QString &	_key_n,
		const _TOther_ &...	_other )

inline

Add a set of keys/values to the hash.

◆ add() [5/8]

ValueHash & ValueHash::add	(	const QString &	_key,
		const knowCore::Value &	_value )

Add a value to the hash with the given key.

◆ add() [6/8]

knowCore::ReturnVoid ValueHash::add	(	const QString &	_key,
		const QVariant &	_value )

Add a value from variant. This can potentially trigger a failure that is detected at create.

◆ add() [7/8]

knowCore::ReturnVoid ValueHash::add ( const QVariantHash & _value )

Merge a QVariantHash into the hash.

◆ add() [8/8]

knowCore::ReturnVoid ValueHash::add ( const QVariantMap & _value )

Merge a QVariantMap into the hash.

◆ checkContainsOnly()

ReturnVoid ValueHash::checkContainsOnly ( const Uri & _uri ) const

Check that the list only contains value of type _uri. It returns success if that is true. It returns a failure with an error message in case a value has a different type in the list.

◆ clear()

void ValueHash::clear ( )

Clear the hash.

◆ contains() [1/3]

bool ValueHash::contains ( const QString & _key ) const

Returns: if the value is contained in the hash.

◆ contains() [2/3]

template<typename _T_ >

bool knowCore::ValueHash::contains ( const QString & _key ) const

Returns: if the value is contained in the hash and is of type _T_.

◆ contains() [3/3]

bool ValueHash::contains	(	const QString &	_key,
		const knowCore::Uri &	_datatype ) const

Returns: if the value is contained in the hash and has the given _datatype.

◆ ensureContains() [1/2]

template<typename _T_ >

knowCore::ReturnVoid knowCore::ValueHash::ensureContains ( const QString & _key ) const

Returns: if the value is contained in the hash and is of type _T_.

◆ ensureContains() [2/2]

knowCore::ReturnVoid ValueHash::ensureContains	(	const QString &	_key,
		const knowCore::Uri &	_datatype ) const

Returns: if the value is contained in the hash and has the given _datatype.

◆ hash() [1/2]

template<typename _T_ >

ReturnValue< QHash< QString, _T_ > > knowCore::ValueHash::hash ( ) const

inline

Returns

attempt to return as a hash of a specific type

T if they are convertible to
T

◆ hash() [2/2]

QHash< QString, Value > ValueHash::hash ( ) const

Returns: the underlying QHash<QString, Value>

◆ keys()

QStringList ValueHash::keys ( ) const

Returns: the list of keys

◆ map() [1/2]

template<typename _T_ >

ReturnValue< QMap< QString, _T_ > > knowCore::ValueHash::map ( ) const

inline

Returns

attempt to return as a map of a specific type

T if they are convertible to
T

◆ map() [2/2]

QMap< QString, Value > knowCore::ValueHash::map ( ) const

inline

Returns: convert the underlying hash into a QMap<QString, Value>

◆ operator Value()

knowCore::ValueHash::operator Value ( ) const

inline

Allow direct casting to Value.

◆ remove()

ValueHash & ValueHash::remove ( const QString & _key )

Remove the _key.

◆ size()

int ValueHash::size ( ) const

Returns: the number of elements in the hash

◆ toVariantHash()

QVariantHash ValueHash::toVariantHash ( ) const

Returns: a variant hash representation

◆ toVariantMap()

QVariantMap ValueHash::toVariantMap ( ) const

Returns: a variant map representation

◆ value() [1/3]

Value ValueHash::value ( const QString & _key ) const

Returns

the value for the given

_key or an empty value

◆ value() [2/3]

template<typename _T_ >

ReturnValue< _T_ > knowCore::ValueHash::value ( const QString & _key ) const

inline

Returns

attempt to return the value for the given

_key if convertible to
T

◆ value() [3/3]

template<typename _T_ >

ReturnValue< _T_ > knowCore::ValueHash::value	(	const QString &	_key,
		const _T_ &	_default ) const

inline

Returns

attempt to return the value for the given

_key if convertible to
T

◆ values() [1/2]

template<typename _T_ >

ReturnValue< QList< _T_ > > knowCore::ValueHash::values ( ) const

Returns

attempt to return the values if they are convertible to

T

◆ values() [2/2]

QList< Value > knowCore::ValueHash::values ( ) const

inline

Returns: return the list of values

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

knowl/src/knowCore/ValueHash.h
knowl/src/knowCore/ValueHash.cpp

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ add() [1/8]

◆ add() [2/8]

◆ add() [3/8]

◆ add() [4/8]

◆ add() [5/8]

◆ add() [6/8]

◆ add() [7/8]

◆ add() [8/8]

◆ checkContainsOnly()

◆ clear()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ ensureContains() [1/2]

◆ ensureContains() [2/2]

◆ hash() [1/2]

◆ hash() [2/2]

◆ keys()

◆ map() [1/2]

◆ map() [2/2]

◆ operator Value()

◆ remove()

◆ size()

◆ toVariantHash()

◆ toVariantMap()

◆ value() [1/3]

◆ value() [2/3]

◆ value() [3/3]

◆ values() [1/2]

◆ values() [2/2]