Represents a DMR radio ID within the abstract config. More...

#include <radioid.hh>

Inheritance diagram for DMRRadioID:

[legend]

Collaboration diagram for DMRRadioID:

[legend]

Public Member Functions
Q_INVOKABLE	DMRRadioID (QObject *parent=nullptr)
	Default constructor.

	DMRRadioID (const QString &name, uint32_t number, QObject *parent=nullptr)
	Constructor. More...

ConfigItem *	clone () const
	Clones this item.

uint32_t	number () const
	Returns the DMR ID.

void	setNumber (uint32_t number)
	Sets the DMR ID.

YAML::Node	serialize (const Context &context, const ErrorStack &err=ErrorStack())
	Recursively serializes the configuration to YAML nodes. More...

bool	parse (const YAML::Node &node, ConfigItem::Context &ctx, const ErrorStack &err=ErrorStack())
	Parses the given YAML node, updates the given object and updates the given context (IDs). More...

bool	link (const YAML::Node &node, const ConfigItem::Context &ctx, const ErrorStack &err=ErrorStack())
	Links the given object to the rest of the codeplug using the given context.

Public Member Functions inherited from ConfigObject
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...

Public Member Functions inherited from ConfigItem
virtual bool	copy (const ConfigItem &other)
	Copies the given item into this one. More...

virtual int	compare (const ConfigItem &other) const
	Compares the items. 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 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 Attributes
uint32_t	_number
	Holds the DMR ID.

Protected Attributes inherited from ConfigObject
QString	_name
	Holds the name of the object.

Properties
unsigned	number
	The number of the radio ID.

Properties inherited from ConfigObject
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.

Protected Member Functions inherited from RadioID
	RadioID (QObject *parent=nullptr)
	Hidden default constructor. More...

	RadioID (const QString &name, QObject *parent=nullptr)
	Hidden constructor with name.

Protected Member Functions inherited from ConfigObject
	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 inherited from ConfigObject
static QString	findIdPrefix (const QMetaObject *meta)
	Helper to find the `IdPrefix` class info in the class hierarchy.

Detailed Description

Represents a DMR radio ID within the abstract config.

This class is used to store the DMR ID(s) of the radio.

Constructor & Destructor Documentation

◆ DMRRadioID()

DMRRadioID::DMRRadioID	(	const QString &	name,
		uint32_t	number,
		QObject *	parent = `nullptr`
	)

Constructor.

Parameters

name	Specifies the name of the ID.
number	Specifies the DMR ID.
parent	Specifies the parent QObject owning this object.

Member Function Documentation

◆ parse()

bool DMRRadioID::parse	(	const YAML::Node &	node,
		ConfigItem::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 ConfigObject.

◆ serialize()

YAML::Node DMRRadioID::serialize	(	const Context &	context,
		const ErrorStack &	err = `ErrorStack()`
	)

virtual

Recursively serializes the configuration to YAML nodes.

The complete configuration must be labeled first.

Reimplemented from ConfigItem.

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

/home/hannes/Software/qdmr/lib/radioid.hh
/home/hannes/Software/qdmr/lib/radioid.cc

Public Member Functions

Protected Attributes