ConfigObject Class Reference

Base class of all labeled and named objects. More...

#include <configobject.hh>

Inheritance diagram for ConfigObject:

Collaboration diagram for ConfigObject:

Public Member Functions
virtual const QString &	name () const
	Returns the name of the object.
virtual void	setName (const QString &name)
	Sets the name of the object.
QString	idPrefix () const
	Returns the ID prefix for this object.
bool	label (Context &context, const ErrorStack &err=ErrorStack())
	Recursively labels the config object. More...
bool	parse (const YAML::Node &node, Context &ctx, const ErrorStack &err=ErrorStack())
	Parses the given YAML node, updates the given object and updates the given context (IDs). More...
Public Member Functions inherited from ConfigItem
virtual bool	copy (const ConfigItem &other)
	Copies the given item into this one. More...
virtual ConfigItem *	clone () const =0
	Clones this item.
virtual int	compare (const ConfigItem &other) const
	Compares the items. More...
virtual YAML::Node	serialize (const Context &context, const ErrorStack &err=ErrorStack())
	Recursively serializes the configuration to YAML nodes. More...
virtual ConfigItem *	allocateChild (QMetaProperty &prop, const YAML::Node &node, const Context &ctx, const ErrorStack &err=ErrorStack())
	Allocates an instance for the given property on the given YAML node. More...
virtual bool	link (const YAML::Node &node, const Context &ctx, const ErrorStack &err=ErrorStack())
	Links the given object to the rest of the codeplug using the given context.
virtual void	clear ()
	Clears the config object.
virtual const Config *	config () const
	Returns the config, the item belongs to or nullptr if not part of a config.
virtual void	findItemsOfTypes (const QStringList &typeNames, QSet< ConfigItem * > &items) const
	Searches the config tree to find all instances of the given type names.
template<class Object >
bool	is () const
	Returns true if this object is of class Object.
template<class Object >
const Object *	as () const
	Casts this object to the given type.
template<class Object >
Object *	as ()
	Casts this object to the given type.
bool	hasDescription () const
	Returns true if there is a class info "description" for this instance.
bool	hasLongDescription () const
	Returns true if there is a class info "longDescription" for this instance.
bool	hasDescription (const QMetaProperty &prop) const
	Returns true if there is a class info "[PropertyName]Description" for the given property.
bool	hasLongDescription (const QMetaProperty &prop) const
	Returns true if there is a class info "[PropertyName]LongDescription" for the given property.
QString	description () const
	Returns the description of this instance if set by a class info.
QString	longDescription () const
	Returns the long description of this instance if set by a class info.
QString	description (const QMetaProperty &prop) const
	Returns the description of property if set by a class info.
QString	longDescription (const QMetaProperty &prop) const
	Returns the long description of property if set by a class info.

Protected Member Functions
	ConfigObject (QObject *parent=nullptr)
	Specifies the prefix for every ID assigned to every object during serialization. More...
	ConfigObject (const QString &name, QObject *parent=nullptr)
	Hidden constructor. More...
virtual bool	populate (YAML::Node &node, const Context &context, const ErrorStack &err=ErrorStack())
	Recursively serializes the configuration to YAML nodes. More...
Protected Member Functions inherited from ConfigItem
	ConfigItem (QObject *parent=nullptr)
	Hidden constructor. More...

Static Protected Member Functions
static QString	findIdPrefix (const QMetaObject *meta)
	Helper to find the IdPrefix class info in the class hierarchy.

Protected Attributes
QString	_name
	Holds the name of the object.

Properties
QString	name
	The name of the object.

Additional Inherited Members
Signals inherited from ConfigItem
void	modified (ConfigItem *obj)
	Gets emitted once the config object is modified. More...
void	beginClear ()
	Gets emitted before clearing the item.
void	endClear ()
	Gets emitted after clearing the item.

Detailed Description

Base class of all labeled and named objects.

Constructor & Destructor Documentation

ConfigObject() [1/2]

ConfigObject::ConfigObject ( QObject *  parent = nullptr )

protected

Specifies the prefix for every ID assigned to every object during serialization.

Hidden constructor.

Parameters

parent

Specifies the QObject parent.

ConfigObject() [2/2]

ConfigObject::ConfigObject ( const QString &  name, QObject *  parent = nullptr  )

protected

Hidden constructor.

Parameters

name	Name of the object.
parent	Specifies the QObject parent.

Member Function Documentation

label()

bool ConfigObject::label ( ConfigObject::Context &  context, const ErrorStack &  err = ErrorStack()  )

virtual

Recursively labels the config object.

Does not assign a label if the idBase passed to the constructor is empty.

Reimplemented from ConfigItem.

parse()

bool ConfigObject::parse ( const YAML::Node &  node, Context &  ctx, const ErrorStack &  err = ErrorStack()  )

virtual

Parses the given YAML node, updates the given object and updates the given context (IDs).

Todo:

With Qt 5.15, we can use the REQUIRED flag to check for mandatory properties. However, Ubuntu 20.04 (Focal) comes with Qt 5.12.

Reimplemented from ConfigItem.

Reimplemented in APRSSystem, PositioningSystem, AESEncryptionKey, EnhancedEncryptionKey, BasicEncryptionKey, Contact, RoamingChannel, and DMRRadioID.

populate()

bool ConfigObject::populate ( YAML::Node &  node, const Context &  context, const ErrorStack &  err = ErrorStack()  )

protectedvirtual

Recursively serializes the configuration to YAML nodes.

The complete configuration must be labeled first.

Reimplemented from ConfigItem.

Reimplemented in APRSSystem, FMChannel, Channel, RoamingZone, RoamingChannel, and PositioningSystem.

---

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

• /home/hannes/Software/qdmr/lib/configobject.hh
• /home/hannes/Software/qdmr/lib/configobject.cc