swift
Public Member Functions | List of all members
swift::misc::CVariantMap Class Reference

Map of { QString, CVariant } pairs. More...

Inheritance diagram for swift::misc::CVariantMap:
[legend]

Public Member Functions

 CVariantMap ()
 Default constructor.
 
 CVariantMap (const CVariantMap &)=default
 Copy constructor.
 
 CVariantMap (CVariantMap &&other) noexcept
 Move constructor.
 
CVariantMapoperator= (const CVariantMap &other)
 Copy assignment operator.
 
CVariantMapoperator= (CVariantMap &&other) noexcept
 Move assignment operator.
 
 ~CVariantMap ()=default
 Destructor.
 
QJsonObject & mergeToJson (QJsonObject &json) const
 Insert values from this map into an existing JSON object.
 
QJsonObject toJson () const
 Cast to JSON object. More...
 
void convertFromJson (const QJsonObject &json)
 Assign from JSON object. More...
 
void convertFromJson (const QJsonObject &json, const QStringList &keys)
 Assign from JSON object. More...
 
CStatusMessageList convertFromJsonNoThrow (const QJsonObject &json, const CLogCategoryList &categories, const QString &prefix)
 Call convertFromJson, catch any CJsonException that are thrown and return them as CStatusMessage.
 
CStatusMessageList convertFromJsonNoThrow (const QJsonObject &json, const QStringList &keys, const CLogCategoryList &categories, const QString &prefix)
 Call convertFromJson, catch any CJsonException that are thrown and return them as CStatusMessage.
 
QJsonObject & mergeToMemoizedJson (QJsonObject &json) const
 Insert values from this map into an existing compact JSON object.
 
QJsonObject toMemoizedJson () const
 To compact JSON format.
 
void convertFromMemoizedJson (const QJsonObject &json)
 From compact JSON format.
 
void convertFromMemoizedJson (const QJsonObject &json, const QStringList &keys)
 From compact JSON format. Convert only keys present in list argument.
 
CStatusMessageList convertFromMemoizedJsonNoThrow (const QJsonObject &json, const CLogCategoryList &categories, const QString &prefix)
 Call convertFromMemoizedJson, catch any CJsonException that are thrown and return them as CStatusMessage.
 
CStatusMessageList convertFromMemoizedJsonNoThrow (const QJsonObject &json, const QStringList &keys, const CLogCategoryList &categories, const QString &prefix)
 Call convertFromMemoizedJson, catch any CJsonException that are thrown and return them as CStatusMessage.
 
 CDictionary ()
 Default constructor.
 
 CDictionary (std::initializer_list< std::pair< Key, Value >> il)
 Initializer list constructor.
 
 CDictionary (const CDictionary &)=default
 Copy constructor.
 
 CDictionary (CDictionary &&other) noexcept
 Move constructor.
 
- Public Member Functions inherited from swift::misc::CDictionary< QString, CVariant, QMap >
CDictionary findKeyBy (Predicate p) const
 Return a copy containing only those elements for which the dictionary keys return true for a given predicate.
 
CDictionary findKeyBy (Pairs... pairs) const
 Return a copy containing only those elements which key matches a particular pair. More...
 
CDictionary findValueBy (Predicate p) const
 Return a copy containing only those elements for which a given predicate returns true.
 
CDictionary findValueBy (Pairs... pairs) const
 Return a copy containing only those elements which value matches a particular pair. More...
 
bool containsByKey (Predicate p) const
 Return true if there is an element for which a given predicate returns true.
 
bool containsByKey (MembFunc membFunc, ReturnValue returnValue) const
 Return true if there is an element which key matches a given pair.
 
bool containsByValue (Predicate p) const
 Return true if there is an element for which a given predicate returns true.
 
bool containsByValue (MembFunc membFunc, ReturnValue returnValue) const
 Return true if there is an element which value matches a given pair.
 
void removeByKeyIf (Predicate p)
 Remove elements for which a given predicate for value returns true.
 
void removeByKeyIf (MembFunc membFunc, ReturnValue returnValue)
 Remove elements for which key matches a particular pair.
 
void removeByValueIf (Predicate p)
 Remove elements for which a given predicate for key returns true.
 
void removeByValueIf (MembFunc membFunc, ReturnValue returnValue)
 Remove elements for which value matches a particular pair.
 
void removeDuplicates (const CDictionary &other)
 Remove elements for which the same key/value pair is present in an other dictionary.
 
QJsonObject toJson () const
 Cast to JSON object. More...
 
void convertFromJson (const QJsonObject &json)
 Assign from JSON object. More...
 
 CDictionary ()
 Default constructor.
 
 CDictionary (std::initializer_list< std::pair< QString, CVariant >> il)
 Initializer list constructor.
 
 CDictionary (const CDictionary &)=default
 Copy constructor.
 
 CDictionary (CDictionary &&other) noexcept
 Move constructor.
 
 ~CDictionary ()=default
 Destructor.
 
iterator begin ()
 Returns iterator at the beginning of the dictionary.
 
const_iterator begin () const
 Returns const iterator at the beginning of the dictionary.
 
const_iterator cbegin () const
 Returns const iterator at the beginning of the dictionary.
 
iterator end ()
 Returns iterator at the end of the dictionary.
 
const_iterator end () const
 Returns const iterator at the end of the dictionary.
 
const_iterator cend () const
 Returns const iterator at the end of the dictionary.
 
auto keyBegin () const
 Returns const iterator for iterating over keys.
 
auto keyEnd () const
 Returns const iterator for iterating over keys.
 
auto keyValueBegin ()
 Returns iterator for iterating over keys and values together.
 
auto keyValueBegin () const
 Returns const iterator for iterating over keys and values together.
 
auto keyValueEnd ()
 Returns iterator for iterating over keys and values together.
 
auto keyValueEnd () const
 Returns const iterator for iterating over keys and values together.
 
auto constKeyValueBegin () const
 Returns const iterator for iterating over keys and values together.
 
auto constKeyValueEnd () const
 Returns const iterator for iterating over keys and values together.
 
void clear ()
 Removes all items from the dictionary.
 
const_iterator constBegin () const
 Returns const iterator at the beginning of the dictionary.
 
const_iterator constEnd () const
 Returns const iterator at the end of the dictionary.
 
const_iterator constFind (const QString &key) const
 Returns an const iterator pointing to the item with the key. More...
 
const_iterator find (const QString &key) const
 Returns an const iterator pointing to the item with the key. More...
 
iterator find (const QString &key)
 Returns an iterator pointing to the item with the key. More...
 
bool contains (const QString &key) const
 Returns true if dictionary contains an item with key, otherwise false.
 
int count (const QString &key) const
 Returns the number of items with key.
 
int count () const
 Returns the size of the dictionary.
 
bool empty () const
 Returns true if the.
 
iterator erase (iterator pos)
 Removes the key/value pair iterator is currently pointing to and returns an iterator to the next item.
 
iterator insert (const QString &key, const CVariant &value)
 Insert new item with key and value.
 
void insert (const CDictionary &other)
 Insert all items of other dictionary into this dictionary.
 
bool isEmpty () const
 Returns true if dictionary is empty.
 
const QString key (const CVariant &value) const
 Return key assigned to value.
 
const QString key (const CVariant &value, const QString &defaultKey) const
 Return key assigned to value or if key is not found defaultKey.
 
auto keys () const
 Return a range of all keys (does not allocate a temporary container)
 
int remove (const QString &key)
 Remove all items with key from the dictionary.
 
int size () const
 Returns the number of items in the hash.
 
void swap (CDictionary &other) noexcept
 Swaps hash other with this hash. This operation is very fast and never fails.
 
const CVariant value (const QString &key) const
 Returns the value associated with the key.
 
const CVariant value (const QString &key, const CVariant &defaultValue) const
 Returns the value associated with the key or if key is not found defaultValue.
 
CRange< const_iteratorvalues () const
 Return a range of all values (does not allocate a temporary container)
 
CDictionaryoperator= (const CDictionary &other)
 Copy assignment.
 
CDictionaryoperator= (CDictionary &&other) noexcept
 Move assignment.
 
CVariantoperator[] (const QString &key)
 Access an element by its key. More...
 
const CVariant operator[] (const QString &key) const
 Access an element by its key.
 
QString convertToQString (bool i18n=false) const
 Cast as QString. More...
 
void marshallToDbus (QDBusArgument &argument) const
 Marshall without begin/endStructure, for when composed within another object. More...
 
void unmarshallFromDbus (const QDBusArgument &argument)
 Unmarshall without begin/endStructure, for when composed within another object. More...
 
void marshalToDataStream (QDataStream &stream) const
 Marshal a value to a QDataStream. More...
 
void unmarshalFromDataStream (QDataStream &stream)
 Unmarshal a value from a QDataStream. More...
 
- Public Member Functions inherited from swift::misc::mixin::String< Derived >
QString toQString (bool i18n=false) const
 Cast as QString.
 
std::string toStdString (bool i18n=false) const
 To std string.
 
QString stringForStreaming () const
 String for streaming operators.
 
- Public Member Functions inherited from swift::misc::mixin::MetaType< CVariantMap >
int getMetaTypeId () const
 Returns the Qt meta type ID of this object. More...
 
QString getClassName () const
 Class name.
 
bool isA (int metaTypeId) const
 Returns true if this object is an instance of the class with the given meta type ID, or one of its subclasses.
 

Additional Inherited Members

- Public Types inherited from swift::misc::CDictionary< QString, CVariant, QMap >
using impl_type = QMap< QString, CVariant >
 The implementation container.
 
typedef QString key_type
 STL compatibility.
 
typedef CVariant value_type
 STL compatibility.
 
typedef CVariantreference
 STL compatibility.
 
typedef const CVariantconst_reference
 STL compatibility.
 
typedef QMap< QString, CVariant >::size_type size_type
 STL compatibility.
 
typedef QMap< QString, CVariant >::iterator iterator
 STL compatibility.
 
typedef QMap< QString, CVariant >::const_iterator const_iterator
 STL compatibility.
 
- Static Public Member Functions inherited from swift::misc::mixin::MetaType< CVariantMap >
static void registerMetadata ()
 Register metadata.
 

Detailed Description

Map of { QString, CVariant } pairs.

Using QMap as implementation type so keys are sorted.

Definition at line 32 of file variantmap.h.

Member Function Documentation

◆ convertFromJson() [1/2]

void swift::misc::CVariantMap::convertFromJson ( const QJsonObject &  json)

Assign from JSON object.

Definition at line 27 of file variantmap.cpp.

◆ convertFromJson() [2/2]

void swift::misc::CVariantMap::convertFromJson ( const QJsonObject &  json,
const QStringList &  keys 
)

Assign from JSON object.

Convert only keys present in list argument.

Definition at line 41 of file variantmap.cpp.

◆ toJson()

QJsonObject swift::misc::CVariantMap::toJson ( ) const

Cast to JSON object.

Definition at line 20 of file variantmap.cpp.


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