Represents an M17 contact. More...

#include <contact.hh>

Inheritance diagram for M17Contact:

[legend]

Collaboration diagram for M17Contact:

[legend]

Public Member Functions
	M17Contact (QObject *parent=nullptr)
	Empty constructor.
	M17Contact (const QString &name, bool ring, const QString &call, QObject *parent=nullptr)
	Constructor.
ConfigItem *	clone () const
	Clones this item.
void	clear ()
	Clears the config object.
const QString &	call () const
	Returns the call/ID of the contact.
void	setCall (const QString &call)
	Sets the call/ID of the contact.
bool	isBroadcast () const
	Retunrs `true`, if the contact is the M17 broadcast contact.
void	setBroadcast (bool enable)
	Sets/Resets the broadcast flag.
YAML::Node	serialize (const Context &context, const ErrorStack &err=ErrorStack())
	Recursively serializes the configuration to YAML nodes.
Public Member Functions inherited from Contact
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.
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).
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.
Public Member Functions inherited from ConfigItem
virtual bool	copy (const ConfigItem &other)
	Copies the given item into this one.
virtual int	compare (const ConfigItem &other) const
	Compares the items.
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.
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.

Static Public Member Functions
static QString	normalizeCall (const QString call)
	Helper function to normalize a call.

Protected Attributes
bool	_isBroadcast
	If true, the contact is the M17 broadcast contact.
QString	_call
	Holds the normalized call/ID of the contact.
Protected Attributes inherited from Contact
bool	_ring
	Ringtone enabled?
Protected Attributes inherited from ConfigObject
QString	_name
	Holds the name of the object.

Properties
QString	call
	The call of the contact.
bool	isBroadcast
	If `true`, the contact is the M17 broadcast destination.
Properties inherited from Contact
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.
void	beginClear ()
	Gets emitted before clearing the item.
void	endClear ()
	Gets emitted after clearing the item.
Protected Member Functions inherited from DigitalContact
	DigitalContact (QObject *parent=nullptr)
	Hidden constructor.
	DigitalContact (const QString &name, bool ring, QObject *parent=nullptr)
	Hidden constructor.
Protected Member Functions inherited from Contact
	Contact (QObject *parent=nullptr)
	Default constructor.
	Contact (const QString &name, bool ring=true, QObject *parent=nullptr)
	Hidden constructor.
Protected Member Functions inherited from ConfigObject
	ConfigObject (QObject *parent=nullptr)
	Specifies the prefix for every ID assigned to every object during serialization.
	ConfigObject (const QString &name, QObject *parent=nullptr)
	Hidden constructor.
virtual bool	populate (YAML::Node &node, const Context &context, const ErrorStack &err=ErrorStack())
	Recursively serializes the configuration to YAML nodes.
Protected Member Functions inherited from ConfigItem
	ConfigItem (QObject *parent=nullptr)
	Hidden constructor.
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 an M17 contact.

Constructor & Destructor Documentation

◆ M17Contact()

M17Contact::M17Contact	(	const QString &	name,
		bool	ring,
		const QString &	call,
		QObject *	parent = nullptr )

Constructor.

Parameters

name	Specifies the name of the contact. Can be descriptive.
ring	Specifies if a call from this contact rings a bell.
call	Specifies the call/ID of the contact.
parent	QObject parent, takes the ownership of this object.

Member Function Documentation

◆ clear()

void M17Contact::clear ( )

virtual

Clears the config object.

Reimplemented from Contact.

◆ clone()

ConfigItem * M17Contact::clone ( ) const

virtual

Clones this item.

Implements ConfigItem.

◆ isBroadcast()

bool M17Contact::isBroadcast ( ) const

Retunrs true, if the contact is the M17 broadcast contact.

If set, the call has no effect.

◆ serialize()

YAML::Node M17Contact::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.

Member Data Documentation

◆ _isBroadcast

bool M17Contact::_isBroadcast

protected

If true, the contact is the M17 broadcast contact.

The call is ignored then.

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

/builddir/build/BUILD/qdmr-0.15.0-build/qdmr-0.15.0/lib/contact.hh
/builddir/build/BUILD/qdmr-0.15.0-build/qdmr-0.15.0/lib/contact.cc

Public Member Functions

Static Public Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ M17Contact()

Member Function Documentation

◆ clear()

◆ clone()

◆ isBroadcast()

◆ serialize()

Member Data Documentation

◆ _isBroadcast