AnytoneCodeplug::TwoToneFunctionElement Class Reference

Represents the base-class for a 2-tone function for all AnyTone codeplugs. More...

#include <anytone_codeplug.hh>

Inheritance diagram for AnytoneCodeplug::TwoToneFunctionElement:

Collaboration diagram for AnytoneCodeplug::TwoToneFunctionElement:

Classes
struct	Limit
	Some limits of the element. More...
struct	Offset
	Some internal offsets within the element. More...

Public Types
enum class	Response { None = 0 , Tone , ToneRespond }
	Possible responses to a decode.

Public Member Functions
	TwoToneFunctionElement (uint8_t *ptr)
	Constructor.
void	clear ()
	Resets the function.
virtual double	firstTone () const
	Returns the first tone of the sequence.
virtual void	setFirstTone (double f)
	Sets the first tone of the sequence.
virtual double	secondTone () const
	Returns the second tone of the sequence.
virtual void	setSecondTone (double f)
	Sets the second tone of the sequence.
virtual Response	response () const
	Returns the response.
virtual void	setResponse (Response resp)
	Sets the response.
virtual QString	name () const
	Returns the name of the function.
virtual void	setName (const QString &name)
	Sets the name of the function.
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
	TwoToneFunctionElement (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 a 2-tone function for all AnyTone codeplugs.

Memory encoding of the function (size 0x0020 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 | Frequency 1 in 0.1Hz, little endian                           | Frequency 2 in 0.1Hz, little endian                           |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
04 | Response                      | Name, up to 7 ASCII chars                                                                  ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
08  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
0c | Pad byte 0x00                 | Unused set to 0x00                                                                         ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
1c  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+

Field description:
 - Response: 0=None, 1=Tone, 2=ToneRespond

---

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