libdrmconf  0.11.3
A library to program DMR radios.
Classes | Public Member Functions | Protected Member Functions | List of all members
CallsignDB Class Referenceabstract

Abstract base class of all callsign database implementations. More...

#include <callsigndb.hh>

Inheritance diagram for CallsignDB:
Inheritance graph
[legend]
Collaboration diagram for CallsignDB:
Collaboration graph
[legend]

Classes

class  Selection
 Controls the selection of callsigns from the UserDatabase to be encoded into the callsign db. More...
 

Public Member Functions

virtual ~CallsignDB ()
 Destructor.
 
virtual bool encode (UserDatabase *db, const Selection &selection=Selection(), const ErrorStack &err=ErrorStack())=0
 Encodes the given user db into the device specific callsign db.
 
- Public Member Functions inherited from DFUFile
 DFUFile (QObject *parent=nullptr)
 Constructs an empty DFU file object.
 
uint32_t size () const
 Returns the total size of the DFU file.
 
uint32_t memSize () const
 Returns the total memory size stored in the DFU file.
 
int numImages () const
 Returns the number of images within the DFU file.
 
const Imageimage (int i) const
 Returns a reference to the i-th image of the file.
 
Imageimage (int i)
 Returns a reference to the i-th image of the file.
 
void addImage (const QString &name, uint8_t altSettings=1)
 Adds a new image to the file.
 
void addImage (const Image &img)
 Adds an image to the file.
 
void remImage (int i)
 Deletes the i-th image from the file.
 
bool isAligned (unsigned blocksize) const
 Checks if all image addresses and sizes is aligned with the given block size.
 
bool read (const QString &filename, const ErrorStack &err=ErrorStack())
 Reads the specified DFU file. More...
 
bool read (QFile &file, const ErrorStack &err=ErrorStack())
 Reads the specified DFU file. More...
 
bool write (const QString &filename, const ErrorStack &err=ErrorStack())
 Writes to the specified file. More...
 
bool write (QFile &file, const ErrorStack &err=ErrorStack())
 Writes to the specified file. More...
 
void dump (QTextStream &stream) const
 Dumps a text representation of the DFU file structure to the specified text stream.
 
virtual bool isAllocated (uint32_t offset, uint32_t img=0) const
 Returns true if the specified address (and image) is allocated.
 
virtual unsigned char * data (uint32_t offset, uint32_t img=0)
 Returns a pointer to the encoded raw data at the specified offset.
 
virtual const unsigned char * data (uint32_t offset, uint32_t img=0) const
 Returns a const pointer to the encoded raw data at the specified offset.
 

Protected Member Functions

 CallsignDB (QObject *parent=nullptr)
 Hidden constructor.
 

Additional Inherited Members

- Protected Attributes inherited from DFUFile
QVector< Image_images
 The list of images.
 

Detailed Description

Abstract base class of all callsign database implementations.

This class defines the interface for all device-specific binary encodings of call sign databases. The interface is particularly simple: reimplement the encode method.


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