Represents the base-class for all contact types, analog (DTMF) or digital (DMR, M17). More...

#include <contact.hh>

Inheritance diagram for Contact:

[legend]

Collaboration diagram for Contact:

[legend]

Public Member Functions
void	clear ()
	Clears the config object.

bool	ring () const
	Returns `true` if the ring-tone is enabled for this contact.

void	setRing (bool enable)
	Enables/disables the ring-tone for this contact.

template<class T >
bool	is () const
	Typecheck contact. More...

template<class T >
T *	as ()
	Typecast contact.

template<class T >
const T *	as () const
	Typecast contact.

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...

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.

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 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 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
	Contact (QObject *parent=nullptr)
	Default constructor.

	Contact (const QString &name, bool ring=true, QObject *parent=nullptr)
	Hidden constructor. More...

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...

Protected Attributes
bool	_ring
	Ringtone enabled?

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

Properties
bool	ring
	If `true` and supported by radio, ring on call from this contact.

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.

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 the base-class for all contact types, analog (DTMF) or digital (DMR, M17).

Constructor & Destructor Documentation

◆ Contact()

Contact::Contact	(	const QString &	name,
		bool	ring = `true`,
		QObject *	parent = `nullptr`
	)

protected

Hidden constructor.

Parameters

name	Specifies the name of the contact.
ring	Specifies whether a ring-tone for this contact is used.
parent	Specifies the QObject parent.

Member Function Documentation

◆ is()

template<class T >

bool Contact::is ( ) const

inline

Typecheck contact.

For example, contact->is<DigitalContact>() returns true if contact is a DigitalContact.

◆ parse()

bool Contact::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 ConfigObject.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes