Represents a scan list within the codeplug. More...

#include <tyt_codeplug.hh>

Inheritance diagram for TyTCodeplug::ScanListElement:

Collaboration diagram for TyTCodeplug::ScanListElement:

Public Member Functions
	ScanListElement (uint8_t *ptr)
	Constructor.

virtual	~ScanListElement ()
	Destructor.

bool	isValid () const
	Returns `true` if the pointer is not null.

void	clear ()
	Abstract method to reset the element within the codeplug. More...

virtual QString	name () const
	Returns the name of the scan list.

virtual void	setName (const QString &nm)
	Sets the name of the scan list.

virtual uint16_t	priorityChannel1Index () const
	Returns the index (+1) of the first priority channel.

virtual void	setPriorityChannel1Index (uint16_t idx)
	Set the index (+1) of the first priority channel.

virtual uint16_t	priorityChannel2Index () const
	Returns the index (+1) of the second priority channel.

virtual void	setPriorityChannel2Index (uint16_t idx)
	Set the index (+1) of the second priority channel.

virtual uint16_t	txChannelIndex () const
	Returns the index (+1) of the TX channel. More...

virtual void	setTXChannelIndex (uint16_t idx)
	Sets the index (+1) of the TX channel. More...

virtual unsigned	holdTime () const
	Returns the hold time in ms.

virtual void	setHoldTime (unsigned time)
	Sets the hold time in ms.

virtual unsigned	prioritySampleTime () const
	Returns the priority sample time in ms.

virtual void	setPrioritySampleTime (unsigned time)
	Sets the priority sample time in ms.

virtual uint16_t	memberIndex (unsigned n) const
	Returns the n-th member index.

virtual void	setMemberIndex (unsigned n, uint16_t idx)
	Sets the n-th member index.

virtual bool	fromScanListObj (const ScanList *lst, Context &ctx)
	Encodes the given scan list.

virtual ScanList *	toScanListObj (Context &ctx)
	Creates a scan list.

virtual bool	linkScanListObj (ScanList *lst, Context &ctx)
	Links the scan list object.

Public Member Functions inherited from Codeplug::Element
	Element (const Element &other)
	Copy constructor.

virtual	~Element ()
	Destructor.

bool	fill (uint8_t value, unsigned offset=0, int size=-1)
	Fills the memsets the entire element to the given value.

bool	getBit (unsigned offset, unsigned bit) const
	Reads 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...

Protected Member Functions
	ScanListElement (uint8_t *ptr, size_t size)
	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 a scan list within the codeplug.

Memory layout of encoded scan list (0x0068 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 | Scan List Name 16 x 16bit unicode characters, each unicode char is encoded in little-endian                                ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
1c  ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
20 | Priority Channel 1, index+1, 0x0000=current, 0xffff=none      | Priority Channel 1, index+1, 0x0000=current, 0xffff=none      |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
24 |Tx Designated Channel index+1, 0x0000=current, 0xffff=none     | !!! Unknown set to 0xf1 !!!   | Hold Time N x 25ms            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
28 | Prio. Sample Time N x 250ms   | Unused, set to 0xff           | Member Channel index+1 00                                     |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
2c | Member Channel index+1 01                                     |                                                            ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
64  ...                                                            | Member Channel index+1 30                                     |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+

Note:
 - All indices are encoded little-endian.

Member Function Documentation

◆ clear()

void TyTCodeplug::ScanListElement::clear ( )

virtual

Abstract method to reset the element within the codeplug.

Any device specific element should implement this method.

Reimplemented from Codeplug::Element.

◆ setTXChannelIndex()

void TyTCodeplug::ScanListElement::setTXChannelIndex ( uint16_t idx )

virtual

Sets the index (+1) of the TX channel.

0=current, 0xffff=none.

◆ txChannelIndex()

uint16_t TyTCodeplug::ScanListElement::txChannelIndex ( ) const

virtual

Returns the index (+1) of the TX channel.

0=current, 0xffff=none.

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

/home/hannes/Software/qdmr/lib/tyt_codeplug.hh
/home/hannes/Software/qdmr/lib/tyt_codeplug.cc

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clear()

◆ setTXChannelIndex()

◆ txChannelIndex()