Represents the header of an entry in the callsign database. More...

#include <d868uv_callsigndb.hh>

Inheritance diagram for D868UVCallsignDB::EntryElement:

Collaboration diagram for D868UVCallsignDB::EntryElement:

Public Types
enum class	RingTone { Off = 0 , Tone = 1 , Online = 2 }
	Notification tones for callsign entry.

Public Member Functions
	EntryElement (uint8_t *ptr)
	Constructor.

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

virtual void	setCallType (DMRContact::Type type)
	Sets the call type.

virtual void	setNumber (unsigned num)
	Sets the DMR ID number.

virtual void	setFriendFlag (bool set)
	Set/clear friend flag.

virtual void	setRingTone (RingTone tone)
	Sets the ring tone.

virtual void	setContent (const QString &name, const QString &city, const QString &call, const QString &state, const QString &country, const QString &comment)
	Sets the entry content.

virtual unsigned	fromUser (const UserDatabase::User &user)
	Constructs a database entry from the given user. More...

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

virtual	~Element ()
	Destructor.

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 (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...

Static Public Member Functions
static unsigned	size (const UserDatabase::User &user)
	Computes the size of the database entry for the given user.

Protected Member Functions
	EntryElement (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 header of an entry in the callsign database.

Each entry is of variable size. That is, every entry has a common header containing the number, call-type etc. All strings, that is contact name, city, callsign, state, country and comment are 0x00 terminated strings in a lists.

Max length for name is 16, city is 15, callsign is 8, state is 16, country is 16 and comment is 16, excluding terminating 0x00.

Memory layout of encoded Callsign/User database entry (variable size, min 0x000c-0x0064):

     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 | Call type                     | DMR ID, 8-digit BCD, big-endian                                                            ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
04  ...                            | 0   0   0 |FRD| 0   0 | Ring  | Body, up to 94 bytes, string list, 0-terminated        ...
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
    ...                                                                                                                            |
   +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+

Field description:
  - Call type: The call type of the entry, 0=Private, 1=Group and 2=All call.
  - FRD: Friend flag.
  - Ring: Ring tone settings, 0=Off, 1=Tone, 2=Online(?).
  - Body: String list variable size. Each string in list 0-terminated. List is [Name, City, Call, State, Country, Comment].
    Maximum length is 96 including 0 bytes.

Member Function Documentation

◆ clear()

void D868UVCallsignDB::EntryElement::clear ( )

virtual

Abstract method to reset the element within the codeplug.

Any device specific element should implement this method.

Reimplemented from Codeplug::Element.

◆ fromUser()

unsigned D868UVCallsignDB::EntryElement::fromUser ( const UserDatabase::User & user )

virtual

Constructs a database entry from the given user.

Returns: The size of the entry.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clear()

◆ fromUser()