libdrmconf 0.12.1
A library to program DMR radios.
Loading...
Searching...
No Matches
DTMFContact Class Reference

Represents an analog contact, that is a DTMF number. More...

#include <contact.hh>

Inheritance diagram for DTMFContact:
Collaboration diagram for DTMFContact:

Public Member Functions

Q_INVOKABLE DTMFContact (QObject *parent=nullptr)
 Default constructor.
 
 DTMFContact (const QString &name, const QString &number, bool ring=false, QObject *parent=nullptr)
 Constructs a DTMF (analog) contact.
 
ConfigItemclone () const
 Clones this item.
 
void clear ()
 Clears the config object.
 
const QString & number () const
 Returns the DTMF number of this contact.
 
bool setNumber (const QString &number)
 (Re-)Sets the DTMF number of this contact.
 
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 ConfigItemallocateChild (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 Configconfig () 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

QString _number
 The DTMF number.
 
- Protected Attributes inherited from Contact
bool _ring
 Ringtone enabled?
 
- Protected Attributes inherited from ConfigObject
QString _name
 Holds the name of the object.
 

Properties

QString number
 The contact number.
 
- 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 AnalogContact
 AnalogContact (QObject *parent=nullptr)
 Hidden constructor.
 
 AnalogContact (const QString &name, bool rxTone, QObject *parent=nullptr)
 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 analog contact, that is a DTMF number.

Constructor & Destructor Documentation

◆ DTMFContact()

DTMFContact::DTMFContact ( const QString & name,
const QString & number,
bool ring = false,
QObject * parent = nullptr )

Constructs a DTMF (analog) contact.

Parameters
nameSpecifies the contact name.
numberSpecifies the DTMF number (0-9,A,B,C,D,*,#).
ringSpecifies whether the ring-tone is enabled for this contact.
parentSpecifies the QObject parent.

Member Function Documentation

◆ clear()

void DTMFContact::clear ( )
virtual

Clears the config object.

Reimplemented from Contact.

◆ clone()

ConfigItem * DTMFContact::clone ( ) const
virtual

Clones this item.

Implements ConfigItem.

◆ number()

const QString & DTMFContact::number ( ) const

Returns the DTMF number of this contact.

The number must consist of 0-9, a-f, * or #.

◆ serialize()

YAML::Node DTMFContact::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: