libdrmconf  0.12.0
A library to program DMR radios.
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
AnytoneCodeplug::FiveToneSettingsElement Class Reference

Represents the base-class for 5Tone settings for all AnyTone codeplugs. More...

#include <anytone_codeplug.hh>

Inheritance diagram for AnytoneCodeplug::FiveToneSettingsElement:
Inheritance graph
[legend]
Collaboration diagram for AnytoneCodeplug::FiveToneSettingsElement:
Collaboration graph
[legend]

Public Types

enum class  Response { None = 0 , Tone , ToneRespond }
 Possible responses to decoded 5-tone codes.
 
typedef enum FiveToneIDElement::Standard Standard
 Possible 5-tone encoding standards.
 

Public Member Functions

 FiveToneSettingsElement (uint8_t *ptr)
 Constructor.
 
void clear ()
 Resets the 5tone settings.
 
virtual Response decodingResponse () const
 Returns the decoding response.
 
virtual void setDecodingResponse (Response response)
 Sets the decoding response.
 
virtual Standard decodingStandard () const
 Returns the decoding standard.
 
virtual void setDecodingStandard (Standard standard)
 Sets the decoding standard.
 
virtual unsigned decodingToneDuration () const
 Returns the decoding tone duration in ms.
 
virtual void setDecodingToneDuration (unsigned ms)
 Sets the decoding tone duration in ms.
 
virtual QString id () const
 Returns the 5tone radio ID.
 
virtual void setID (const QString &id)
 Sets the 5tone radio ID.
 
virtual unsigned postEncodeDelay () const
 Returns the post-encode delay in ms.
 
virtual void setPostEncodeDelay (unsigned ms)
 Sets the post-encode delay in ms.
 
virtual bool hasPTTID () const
 Returns true if the PTT ID is set.
 
virtual unsigned pttID () const
 Returns the PTT ID.
 
virtual void setPTTID (unsigned id)
 Sets the PTT ID [5,75].
 
virtual void clearPTTID ()
 Clears the PTT ID.
 
virtual unsigned autoResetTime () const
 Returns the auto-reset time in seconds.
 
virtual void setAutoResetTime (unsigned s)
 Sets the auto-reset time in seconds.
 
virtual unsigned firstDelay () const
 Returns the first delay in ms.
 
virtual void setFirstDelay (unsigned ms)
 Sets the first delay in ms.
 
virtual bool sidetoneEnabled () const
 Returns true if the sidetone is enabled.
 
virtual void enableSidetone (bool enable)
 Enables/disables side tone.
 
virtual unsigned stopCode () const
 Returns the stop code [0,15].
 
virtual void setStopCode (unsigned code)
 Sets the stop code.
 
virtual unsigned stopTime () const
 Returns the stop time in ms.
 
virtual void setStopTime (unsigned ms)
 Sets the stop time in ms.
 
virtual unsigned decodeTime () const
 Returns the decode time in ms.
 
virtual void setDecodeTime (unsigned ms)
 Sets the decode time in ms.
 
virtual unsigned delayAfterStop () const
 Returns the delay after stop in ms.
 
virtual void setDelayAfterStop (unsigned ms)
 Sets the delay after stop in ms.
 
virtual unsigned preTime () const
 Returns the pre time in ms.
 
virtual void setPreTime (unsigned ms)
 Sets the pre time in ms.
 
virtual Standard botStandard () const
 Returns the BOT standard.
 
virtual void setBOTStandard (Standard standard)
 Sets the BOT standard.
 
virtual unsigned botToneDuration () const
 Returns the BOT tone duration in ms.
 
virtual void setBOTToneDuration (unsigned ms)
 Sets the BOT tone duration in ms.
 
virtual QString botID () const
 Returns the 5tone BOT ID.
 
virtual void setBOTID (const QString &id)
 Sets the 5tone BOT ID.
 
virtual Standard eotStandard () const
 Returns the EOT standard.
 
virtual void setEOTStandard (Standard standard)
 Sets the EOT standard.
 
virtual unsigned eotToneDuration () const
 Returns the EOT tone duration in ms.
 
virtual void setEOTToneDuration (unsigned ms)
 Sets the EOT tone duration in ms.
 
virtual QString eotID () const
 Returns the 5tone EOT ID.
 
virtual void setEOTID (const QString &id)
 Sets the 5tone EOT ID.
 
- Public Member Functions inherited from Codeplug::Element
 Element (const Element &other)
 Copy constructor.
 
virtual ~Element ()
 Destructor.
 
Elementoperator= (const Element &other)
 Copy assignment.
 
virtual bool isValid () const
 Returns true if the pointer is not null.
 
bool fill (uint8_t value, unsigned offset=0, int size=-1)
 Fills the memsets the entire element to the given value.
 
bool getBit (const Offset::BitOffset &offset) const
 Reads a specific bit at the given byte-offset.
 
bool getBit (unsigned offset, unsigned bit) const
 Reads a specific bit at the given byte-offset.
 
void setBit (const Offset::BitOffset &offset, bool value=true)
 Sets a specific bit at the given byte-offset.
 
void setBit (unsigned offset, unsigned bit, bool value=true)
 Sets a specific bit at the given byte-offset.
 
void clearBit (unsigned offset, unsigned bit)
 Clears a specific bit at the given byte-offset.
 
uint8_t getUInt2 (unsigned offset, unsigned bit) const
 Reads a 2bit unsigned integer at the given byte- and bit-offset.
 
void setUInt2 (unsigned offset, unsigned bit, uint8_t value)
 Stores a 2bit unsigned integer at the given byte- and bit-offset.
 
uint8_t getUInt3 (unsigned offset, unsigned bit) const
 Reads a 3bit unsigned integer at the given byte- and bit-offset.
 
void setUInt3 (unsigned offset, unsigned bit, uint8_t value)
 Stores a 3bit unsigned integer at the given byte- and bit-offset.
 
uint8_t getUInt4 (unsigned offset, unsigned bit) const
 Reads a 4bit unsigned integer at the given byte- and bit-offset.
 
void setUInt4 (unsigned offset, unsigned bit, uint8_t value)
 Stores a 4bit unsigned integer at the given byte- and bit-offset.
 
uint8_t getUInt5 (unsigned offset, unsigned bit) const
 Reads a 5bit unsigned integer at the given byte- and bit-offset.
 
void setUInt5 (unsigned offset, unsigned bit, uint8_t value)
 Stores a 5bit iunsinged nteger at the given byte- and bit-offset.
 
uint8_t getUInt6 (unsigned offset, unsigned bit) const
 Reads a 6bit unsigned integer at the given byte- and bit-offset.
 
void setUInt6 (unsigned offset, unsigned bit, uint8_t value)
 Stores a 6bit unsigned integer at the given byte- and bit-offset.
 
uint8_t getUInt8 (unsigned offset) const
 Reads a 8bit unsigned integer at the given byte- and bit-offset.
 
void setUInt8 (unsigned offset, uint8_t value)
 Reads a 8bit unsigned integer at the given byte- and bit-offset.
 
int8_t getInt8 (unsigned offset) const
 Reads a 8bit signed integer at the given byte- and bit-offset.
 
void setInt8 (unsigned offset, int8_t value)
 Reads a 8bit signed integer at the given byte- and bit-offset.
 
uint16_t getUInt16_be (unsigned offset) const
 Reads a 16bit big-endian unsigned integer at the given byte-offset.
 
uint16_t getUInt16_le (unsigned offset) const
 Reads a 16bit little-endian unsigned integer at the given byte-offset.
 
void setUInt16_be (unsigned offset, uint16_t value)
 Stores a 16bit big-endian unsigned integer at the given byte-offset.
 
void setUInt16_le (unsigned offset, uint16_t value)
 Stores a 16bit little-endian unsigned integer at the given byte-offset.
 
uint32_t getUInt24_be (unsigned offset) const
 Reads a 24bit big-endian unsigned integer at the given byte-offset.
 
uint32_t getUInt24_le (unsigned offset) const
 Reads a 24bit little-endian unsigned integer at the given byte-offset.
 
void setUInt24_be (unsigned offset, uint32_t value)
 Stores a 24bit big-endian unsigned integer at the given byte-offset.
 
void setUInt24_le (unsigned offset, uint32_t value)
 Stores a 24bit little-endian unsigned integer at the given byte-offset.
 
uint32_t getUInt32_be (unsigned offset) const
 Reads a 32bit big-endian unsigned integer at the given byte-offset.
 
uint32_t getUInt32_le (unsigned offset) const
 Reads a 32bit little-endian unsigned integer at the given byte-offset.
 
void setUInt32_be (unsigned offset, uint32_t value)
 Stores a 32bit big-endian unsigned integer at the given byte-offset.
 
void setUInt32_le (unsigned offset, uint32_t value)
 Stores a 32bit little-endian unsigned integer at the given byte-offset.
 
uint64_t getUInt64_be (unsigned offset) const
 Reads a 64bit big-endian unsigned integer at the given byte-offset.
 
uint64_t getUInt64_le (unsigned offset) const
 Reads a 64bit little-endian unsigned integer at the given byte-offset.
 
void setUInt64_be (unsigned offset, uint64_t value)
 Stores a 64bit big-endian unsigned integer at the given byte-offset.
 
void setUInt64_le (unsigned offset, uint64_t value)
 Stores a 64bit little-endian unsigned integer at the given byte-offset.
 
uint8_t getBCD2 (unsigned offset) const
 Reads a 2-digit (1-byte/8bit) BDC value in big-endian at the given byte-offset.
 
void setBCD2 (unsigned offset, uint8_t value)
 Stores a 2-digit (1-byte/8bit) BDC value in big-endian at the given byte-offset.
 
uint16_t getBCD4_be (unsigned offset) const
 Reads a 4-digit (2-byte/16bit) BDC value in big-endian at the given byte-offset.
 
void setBCD4_be (unsigned offset, uint16_t value)
 Stores a 4-digit (2-byte/16bit) BDC value in big-endian at the given byte-offset.
 
uint16_t getBCD4_le (unsigned offset) const
 Reads a 4-digit (2-byte/16bit) BDC value in little-endian at the given byte-offset.
 
void setBCD4_le (unsigned offset, uint16_t value)
 Stores a 4-digit (1-byte/16bit) BDC value in little-endian at the given byte-offset.
 
uint32_t getBCD8_be (unsigned offset) const
 Reads a 8-digit (4-byte/32bit) BDC value in big-endian at the given byte-offset.
 
void setBCD8_be (unsigned offset, uint32_t value)
 Stores a 8-digit (4-byte/32bit) BDC value in big-endian at the given byte-offset.
 
uint32_t getBCD8_le (unsigned offset) const
 Reads a 8-digit (4-byte/32bit) BDC value in little-endian at the given byte-offset.
 
void setBCD8_le (unsigned offset, uint32_t value)
 Stores a 8-digit (4-byte/32bit) BDC value in little-endian at the given byte-offset.
 
QString readASCII (unsigned offset, unsigned maxlen, uint8_t eos=0x00) const
 Reads up to maxlen ASCII chars at the given byte-offset using eos as the string termination char.
 
void writeASCII (unsigned offset, const QString &txt, unsigned maxlen, uint8_t eos=0x00)
 Stores up to maxlen ASCII chars at the given byte-offset using eos as the string termination char. More...
 
QString readUnicode (unsigned offset, unsigned maxlen, uint16_t eos=0x0000) const
 Reads up to maxlen unicode chars at the given byte-offset using eos as the string termination char.
 
void writeUnicode (unsigned offset, const QString &txt, unsigned maxlen, uint16_t eos=0x0000)
 Stores up to maxlen unicode chars at the given byte-offset using eos as the string termination char. More...
 

Static Public Member Functions

static constexpr unsigned int size ()
 Returns the size of the element.
 

Protected Member Functions

 FiveToneSettingsElement (uint8_t *ptr, unsigned size)
 Hidden constructor.
 
- Protected Member Functions inherited from Codeplug::Element
 Element (uint8_t *ptr, size_t size)
 Hidden constructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from Codeplug::Element
uint8_t * _data
 Holds the pointer to the element.
 
size_t _size
 Holds the size of the element.
 

Detailed Description

Represents the base-class for 5Tone settings for all AnyTone codeplugs.

Memory encoding of the settings (size 0x0080 bytes):

     7   6   5   4   3   2   1   0   7   6   5   4   3   2   1   0   7   6   5   4   3   2   1   0   7   6   5   4   3   2   1   0
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
00 | Unknown settings                                                                                                           ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
1c  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
20 | Unused set to 0x00            | Decoding response             | Decoding standard             | Radio ID length               |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
24 | Decoding tone duration in ms  | Radio ID up to 14 BCD digits                                                               ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
28  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
2c | Post encode delay in 10ms     | PTT ID 0=off [5,75]           | Auto reset time in 10s        | First delay in 10ms           |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
30 | Sidetone enable               | Unknown                       | Stop code [0,15]              | Stop time in 10ms             |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
34 | Decode time in 10ms           | Delay after stop in 10ms      | Pre time in 10ms              | Unused set to 0x00                                                                         ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
3c  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
40 | Unused set to 0x00            | BOT standard                  | BOT ID length                 | BOT tone duration in ms       |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
44 | BOT ID, up to 24 BCD digits                                                                                                ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
4c  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
50 | Unused set to 0x00                                                                                                         ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
5c  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
60 | Unused set to 0x00            | EOT standard                  | EOT ID length                 | EOT tone duration in ms       |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
64 | EOT ID up to 24 BCD digits                                                                                                 ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
6c  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
70 | Unused set to 0x00                                                                                                         ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
7c  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+

Field description:
 - Decoding response: 0=None, 1=Tone, 2=ToneRespond
 - Decoding/BOT/EOT standard: 0=ZVEI1, 1=ZVEI2, 2=ZVEI3, 3=PZVEI, 4=DZVEI, 5=PDZVEI, 6=CCIR1, 7=CCIR2, 8=PCCIR, 9=EEA, 10=EuroSignal,
   11=NATEL, 12=MODAT, 13=CCITT, 14=EIA


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