libdrmconf  0.12.0
A library to program DMR radios.
Public Types | Public Member Functions | Protected Attributes | Properties | List of all members
RadioddityToneSettingsExtension Class Reference

Tone settings for Radioddity devices. More...

#include <radioddity_extensions.hh>

Inheritance diagram for RadioddityToneSettingsExtension:
Inheritance graph
[legend]
Collaboration diagram for RadioddityToneSettingsExtension:
Collaboration graph
[legend]

Public Types

enum class  ARTSTone { Disabled = 0 , Once = 4 , Always = 8 }
 Possible ARTS tone settings. More...
 

Public Member Functions

 RadioddityToneSettingsExtension (QObject *parent=nullptr)
 Default constructor.
 
ConfigItemclone () const
 Clones this item.
 
bool lowBatteryWarn () const
 Returns true if a low battery charge is indicated by a warning.
 
void enableLowBatteryWarn (bool enable)
 Enables/disables low-battery warning.
 
Interval lowBatteryWarnInterval () const
 Returns the low-battery warn interval in seconds.
 
void setLowBatteryWarnInterval (Interval sec)
 Sets the low-battery warn interval in seconds.
 
unsigned int lowBatteryWarnVolume () const
 Returns the volume of the low-battery warning tone [1,10].
 
void setLowBatteryWarnVolume (unsigned int)
 Sets the volume of the low-battery warning tone [1,10].
 
bool keyTone () const
 Retruns true, if the key tones are enabled.
 
void enableKeyTone (bool enable)
 Enables/disables key tones.
 
unsigned int keyToneVolume () const
 Retruns the key-tone volume.
 
void setKeyToneVolume (unsigned int volume)
 Sets the key-tone volume.
 
Interval callAlertDuration () const
 Returns the call-alert duration in seconds.
 
void setCallAlertDuration (Interval sec)
 Sets the call-allert duration in seconds.
 
bool resetTone () const
 Returns true if the reset tone is enabled.
 
void enableResetTone (bool enable)
 Enables/disables reset tone.
 
bool unknownNumberTone () const
 Returns true if the unknown number tone is enabled.
 
void enableUnknownNumberTone (bool enable)
 Enables/disables reset tone.
 
ARTSTone artsToneMode () const
 Returns the ARTS tone mode.
 
void setARTSToneMode (ARTSTone mode)
 Sets the ARTS tone mode.
 
bool digitalTalkPermitTone () const
 Returns true if the digital channel talk permit tone is enabled.
 
void enableDigitalTalkPermitTone (bool enable)
 Enables/disables digital channel talk permit tone.
 
bool analogTalkPermitTone () const
 Returns true if the analog channel talk permit tone is enabled.
 
void enableAnalogTalkPermitTone (bool enable)
 Enables/disables analog channel talk permit tone.
 
bool selftestTone () const
 Returns true if the self-test tone is enabled.
 
void enableSelftestTone (bool enable)
 Enables/disables self-test tone.
 
bool channelFreeIndicationTone () const
 Returns true if the channel-free indication tone is enabled.
 
void enableChannelFreeIndicationTone (bool enable)
 Enables/disables the channel free indication tone.
 
bool allTonesDisabled () const
 Returns true if all tones are disabled.
 
void disableAllTones (bool disable)
 Disables/enables all tones.
 
bool txExitTone () const
 Returns true if the TX exit tone is enabled.
 
void enableTXExitTone (bool enable)
 Enables/disables TX exit tone.
 
unsigned int fmMicGain () const
 Returns the FM mic gain [1,10].
 
void setFMMicGain (unsigned int gain)
 Sets the FM mic gain [1,10].
 
- 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 bool label (Context &context, const ErrorStack &err=ErrorStack())
 Recursively labels the config object. More...
 
virtual YAML::Node serialize (const Context &context, const ErrorStack &err=ErrorStack())
 Recursively serializes the configuration to YAML nodes. More...
 
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. More...
 
virtual 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...
 
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 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

bool _lowBatteryWarn
 If true, a low-battery charge is indicated by a warning.
 
Interval _lowBatteryWarnInterval
 Holds the low-battery warn interval in seconds.
 
unsigned int _lowBatteryWarnVolume
 Holds the volume of the low-battery warning tone.
 
Interval _callAlertDuration
 Holds the call alert duration in seconds.
 
bool _resetTone
 If true the reset tone is enabled.
 
bool _unknownNumberTone
 If true, the unknown number tone is enabled.
 
ARTSTone _artsToneMode
 Holds the ARTS tone mode.
 
bool _digitalTalkPermitTone
 If true, the talk permit tone is enabled for digital channels.
 
bool _analogTalkPermitTone
 If true, the talk permit tone is enabled for analog channels.
 
bool _selftestTone
 If true, the self-test tone is enabled.
 
bool _channelFreeIndicationTone
 If true, the channel free indication tone is enabled.
 
bool _disableAllTones
 If true, all tones are disabled.
 
bool _txExitTone
 If true, the TX exit tone is enabled.
 
bool _keyTone
 If true, the key-tones are enabled.
 
unsigned int _keyToneVolume
 Holds the key-tone volume [1,10].
 
unsigned int _fmMicGain
 The FM mic gain.
 

Properties

bool lowBatteryWarn
 If true, the low battery warning is enabled. More...
 
Interval lowBatteryWarnInterval
 The low-battery warn interval in seconds.
 
bool lowBatteryWarnVolume
 Returns the low-battery warning volume [1,10]. More...
 
bool keyTone
 If true, the key tones are enabled.
 
bool keyToneVolume
 Returns the key-tone volume.
 
Interval callAlertDuration
 The call-alert duration in seconds.
 
bool resetTone
 If true the reset tone is enabled.
 
bool unknownNumberTone
 true, the unknown number tone is enabled.
 
ARTSTone artsToneMode
 The ARTS tone mode.
 
bool digitalTalkPermitTone
 If true, the talk permit tone is enabled for digital channels.
 
bool analogTalkPermitTone
 If true, the talk permit tone is enabled for analog channels.
 
bool selftestTone
 If true, the self-test tone is enabled.
 
bool channelFreeIndicationTone
 If true, the frequency indication tone is enabled.
 
bool allTonesDisabled
 If true, all tones are disabled.
 
bool txExitTone
 If true, the TX exit tone is enabled.
 
unsigned int fmMicGain
 Sets the FM mic gain (GD-73 only).
 

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

Detailed Description

Tone settings for Radioddity devices.

Member Enumeration Documentation

◆ ARTSTone

Possible ARTS tone settings.

Enumerator
Disabled 

ARTS tone is disabled.

Once 

ARTS tone once.

Always 

ARTS tone always.

Property Documentation

◆ lowBatteryWarn

bool RadioddityToneSettingsExtension::lowBatteryWarn
readwrite

If true, the low battery warning is enabled.

(GD-73 only)

◆ lowBatteryWarnVolume

bool RadioddityToneSettingsExtension::lowBatteryWarnVolume
readwrite

Returns the low-battery warning volume [1,10].

(GD-73 only)


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