AnytoneCodeplug::DTMFContactElement Class Reference

Represents the base class for analog (DTMF) contacts in all AnyTone codeplugs. More...

#include <anytone_codeplug.hh>

Inheritance diagram for AnytoneCodeplug::DTMFContactElement:

Collaboration diagram for AnytoneCodeplug::DTMFContactElement:

Classes
struct	Limit
	Some limits for the element. More...
struct	Offset
	Internal used offsets within the codeplug. More...

Public Member Functions
	DTMFContactElement (uint8_t *ptr)
	Constructor.
virtual	~DTMFContactElement ()
	Destructor.
void	clear ()
	Resets the contact element.
virtual QString	number () const
	Returns the number of the contact.
virtual void	setNumber (const QString &number)
	Sets the number of the contact.
virtual QString	name () const
	Returns the name of the contact.
virtual void	setName (const QString &name)
	Sets the name of the contact.
virtual DTMFContact *	toContact () const
	Creates an DTMF contact from the entry.
virtual bool	fromContact (const DTMFContact *contact)
	Encodes an DTMF contact from the given one.
Public Member Functions inherited from Codeplug::Element
	Element (const Element &other)
	Copy constructor.
virtual	~Element ()
	Destructor.
Element &	operator= (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
	DTMFContactElement (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 analog (DTMF) contacts in all AnyTone codeplugs.

Encoding of the DTMF contact (0x30 bytes):

     0                               8                               16                              24
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
 0 | Number, 14 digits BCD encoded, big-endian, 0-padded                                                                        ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
    ...                                                                                            | Number of digits              |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
 8 | Name, 15 x ASCII, 0-padded                                                                                                 ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
14  ...                                                                                            | 0x00 pad                      |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+

---

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

• /home/hannes/Software/qdmr/lib/anytone_codeplug.hh
• /home/hannes/Software/qdmr/lib/anytone_codeplug.cc