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

Represents the general settings extension for Radioddity devices. More...

#include <radioddity_extensions.hh>

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

Public Types

enum class  MonitorType { Open = 0 , Silent = 1 }
 Possible monitor types. More...
 
enum class  ARTSTone { Disabled = 0 , Once = 4 , Always = 8 }
 Possible ARTS tone settings. More...
 
enum class  ScanMode { Time = 0 , Carrier = 1 , Search = 2 }
 Possible scan modes.
 

Public Member Functions

Q_INVOKABLE RadiodditySettingsExtension (QObject *parent=nullptr)
 Default constructor.
 
ConfigItemclone () const
 Clones this item.
 
unsigned preambleDuration () const
 Returns the preamble duration in ms.
 
void setPreambleDuration (unsigned ms)
 Sets the preamble duration in ms.
 
MonitorType monitorType () const
 Returns the monitor type.
 
void setMonitorType (MonitorType type)
 Sets the monitor type.
 
unsigned lowBatteryWarnInterval () const
 Returns the low-battery warn interval in seconds.
 
void setLowBatteryWarnInterval (unsigned sec)
 Sets the low-battery warn interval in seconds.
 
unsigned callAlertDuration () const
 Returns the call-alert duration in seconds.
 
void setCallAlertDuration (unsigned sec)
 Sets the call-allert duration in seconds.
 
unsigned loneWorkerResponseTime () const
 Returns the lone-worker response time in minutes.
 
void setLoneWorkerResponseTime (unsigned min)
 Sets the lone-worker response time in minutes.
 
unsigned loneWorkerReminderPeriod () const
 Returns the lone-worker reminder period in seconds.
 
void setLoneWorkerReminderPeriod (unsigned sec)
 Sets the lone-worker reminder period in seconds.
 
unsigned groupCallHangTime () const
 Returns the group call hang time in ms.
 
void setGroupCallHangTime (unsigned ms)
 Sets the group call hang time in ms.
 
unsigned privateCallHangTime () const
 Returns the private call hang time in ms.
 
void setPrivateCallHangTime (unsigned ms)
 Sets the private call hang time in ms.
 
bool downChannelModeVFO () const
 Returns true if the down-channel mode is VFO.
 
void enableDownChannelModeVFO (bool enable)
 Enables/disables down-channel mode is VFO.
 
bool upChannelModeVFO () const
 Returns true if the up-channel mode is VFO.
 
void enableUpChannelModeVFO (bool enable)
 Enables/disables up-channel mode is VFO.
 
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 powerSaveMode () const
 Returns true if the power save mode is enabled.
 
void enablePowerSaveMode (bool enable)
 Enables the power save mode.
 
bool wakeupPreamble () const
 Returns true if the wake-up preamble is send.
 
void enableWakeupPreamble (bool enable)
 Enables transmission of wakeup preamble.
 
bool allLEDsDisabled () const
 Returns true if all LEDs are disabled.
 
void disableAllLEDs (bool disable)
 Disables/enables all LEDs.
 
bool quickKeyOverrideInhibited () const
 Returns true if quick-key override is inhibited.
 
void inhibitQuickKeyOverride (bool inhibit)
 Inhibits quick-key override.
 
bool txExitTone () const
 Returns true if the TX exit tone is enabled.
 
void enableTXExitTone (bool enable)
 Enables/disables TX exit tone.
 
bool txOnActiveChannel () const
 Returns true if the radio transmits on the active channel on double monitor.
 
void enableTXOnActiveChannel (bool enable)
 Enables/disables transmission on active channel on double monitor.
 
bool animation () const
 Returns true if animation is enabled.
 
void enableAnimation (bool enable)
 Enables/disables animation.
 
ScanMode scanMode () const
 Returns the scan mode.
 
void setScanMode (ScanMode mode)
 Sets the scan mode.
 
unsigned repeaterEndDelay () const
 Returns the repeater end delay in seconds.
 
void setRepeaterEndDelay (unsigned delay)
 Sets the repeater end delay in seconds.
 
unsigned repeaterSTE () const
 Returns the repeater STE in seconds.
 
void setRepeaterSTE (unsigned ste)
 Sets the repeater STE in seconds.
 
const QString & progPassword () const
 Returns the programming password.
 
void setProgPassword (const QString &pwd)
 Sets the programming password.
 
- 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

unsigned _preambleDuration
 Holds the preamble duration in ms.
 
MonitorType _monitorType
 Holds the monitor type.
 
unsigned _lowBatteryWarnInterval
 Holds the low-battery warn interval in seconds.
 
unsigned _callAlertDuration
 Holds the call alert duration in seconds.
 
unsigned _loneWorkerResponseTime
 Holds the lone-worker response time in minutes.
 
unsigned _loneWorkerReminderPeriod
 Holds the lone-worker reminder period in seconds.
 
unsigned _groupCallHangTime
 The group-call hang-time in ms.
 
unsigned _privateCallHangTime
 The private-call hang-time in ms.
 
bool _downChannelModeVFO
 If true down-channel mode is VFO.
 
bool _upChannelModeVFO
 If true the up-channel mode is VFO.
 
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 _powerSaveMode
 If true, the power save mode is enabled.
 
bool _wakeupPreamble
 If true, the wake-up preamble is send.
 
bool _disableAllLEDs
 If true, all LEDs are disabled.
 
bool _quickKeyOverrideInhibited
 If true, the quick-key override is inhibited.
 
bool _txExitTone
 If true, the TX exit tone is enabled.
 
bool _txOnActiveChannel
 If true, the radio will transmit on the active channel when double-wait is enabled.
 
bool _animation
 If true, the boot animation is enabled.
 
ScanMode _scanMode
 Holds the scan mode.
 
unsigned _repeaterEndDelay
 Holds the repeater end delay in seconds.
 
unsigned _repeaterSTE
 Holds the repeater STE in seconds.
 
QString _progPasswd
 Holds the programming password, disabled if empty.
 

Properties

unsigned preambleDuration
 The preamble duration in ms.
 
MonitorType monitorType
 The monitor type.
 
unsigned lowBatteryWarnInterval
 The low-battery warn interval in seconds.
 
unsigned callAlertDuration
 The call-alert duration in seconds.
 
unsigned loneWorkerResponseTime
 The lone-worker response time in minutes.
 
unsigned loneWorkerReminderPeriod
 The lonw-worker reminder period in seconds.
 
unsigned groupCallHangTime
 The group-call hang-time in ms.
 
unsigned privateCallHangTime
 The private-call hang-time in ms.
 
bool downChannelModeVFO
 If true the down-channel mode is VFO.
 
bool upChannelModeVFO
 If true the up-channel mode is VFO.
 
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 powerSaveMode
 If true, the power save mode is enabled.
 
callbool allLEDsDisabled
 If true, all LEDs are disabled.
 
bool quickKeyOverrideInhibited
 If true, the quick-key override is inhibited.
 
bool txExitTone
 If true, the TX exit tone is enabled.
 
bool txOnActiveChannel
 If true, the radio will transmit on the active channel when double-wait is enabled.
 
bool animation
 If true, the boot animation is enabled.
 
ScanMode scanMode
 The scan mode.
 
unsigned repeaterEndDelay
 The repeater end delay in seconds.
 
unsigned repeaterSTE
 The repeater STE in seconds.
 
QString progPassword
 The programming password, disabled if empty.
 

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

Represents the general settings extension 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.

◆ MonitorType

Possible monitor types.

Enumerator
Open 

Monitoring by opening the squelch.

Silent 

Silent monitoring.


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