libdrmconf  0.12.0
A library to program DMR radios.
Public Member Functions | Protected Slots | Protected Attributes | Properties | List of all members
RXGroupList Class Reference

Generic representation of a RX group list. More...

#include <rxgrouplist.hh>

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

Public Member Functions

Q_INVOKABLE RXGroupList (QObject *parent=nullptr)
 Default constructor.
 
 RXGroupList (const QString &name, QObject *parent=nullptr)
 Constructor. More...
 
RXGroupListoperator= (const RXGroupList &other)
 Copy from other group list.
 
ConfigItemclone () const
 Clones this item.
 
int count () const
 Returns the number of contacts within the group list.
 
void clear ()
 Resets & clears this group list.
 
DMRContactcontact (int idx) const
 Returns the contact at the given list index.
 
int addContact (DMRContact *contact, int idx=-1)
 Adds a contact to the list.
 
bool remContact (DMRContact *contact)
 Removes the given contact from the list.
 
bool remContact (int idx)
 Removes the contact from the list at the given position.
 
const DMRContactRefListcontacts () const
 Returns the contact list.
 
DMRContactRefListcontacts ()
 Returns the contact list.
 
YAML::Node serialize (const Context &context, const ErrorStack &err=ErrorStack())
 Recursively serializes the configuration to YAML nodes. More...
 
- Public Member Functions inherited from ConfigObject
virtual const QString & name () const
 Returns the name of the object.
 
virtual void setName (const QString &name)
 Sets the name of the object.
 
QString idPrefix () const
 Returns the ID prefix for this object.
 
bool label (Context &context, const ErrorStack &err=ErrorStack())
 Recursively labels the config object. More...
 
bool parse (const YAML::Node &node, Context &ctx, const ErrorStack &err=ErrorStack())
 Parses the given YAML node, updates the given object and updates the given context (IDs). More...
 
- Public Member Functions inherited from ConfigItem
virtual bool copy (const ConfigItem &other)
 Copies the given item into this one. More...
 
virtual int compare (const ConfigItem &other) const
 Compares the items. More...
 
virtual ConfigItemallocateChild (QMetaProperty &prop, const YAML::Node &node, const Context &ctx, const ErrorStack &err=ErrorStack())
 Allocates an instance for the given property on the given YAML node. More...
 
virtual bool link (const YAML::Node &node, const Context &ctx, const ErrorStack &err=ErrorStack())
 Links the given object to the rest of the codeplug using the given context.
 
virtual const Configconfig () const
 Returns the config, the item belongs to or nullptr if not part of a config.
 
virtual void findItemsOfTypes (const QStringList &typeNames, QSet< ConfigItem * > &items) const
 Searches the config tree to find all instances of the given type names.
 
template<class Object >
bool is () const
 Returns true if this object is of class Object.
 
template<class Object >
const Object * as () const
 Casts this object to the given type.
 
template<class Object >
Object * as ()
 Casts this object to the given type.
 
bool hasDescription () const
 Returns true if there is a class info "description" for this instance.
 
bool hasLongDescription () const
 Returns true if there is a class info "longDescription" for this instance.
 
bool hasDescription (const QMetaProperty &prop) const
 Returns true if there is a class info "[PropertyName]Description" for the given property.
 
bool hasLongDescription (const QMetaProperty &prop) const
 Returns true if there is a class info "[PropertyName]LongDescription" for the given property.
 
QString description () const
 Returns the description of this instance if set by a class info.
 
QString longDescription () const
 Returns the long description of this instance if set by a class info.
 
QString description (const QMetaProperty &prop) const
 Returns the description of property if set by a class info.
 
QString longDescription (const QMetaProperty &prop) const
 Returns the long description of property if set by a class info.
 

Protected Slots

void onModified ()
 Internal used callback to handle list modifications.
 

Protected Attributes

DMRContactRefList _contacts
 The list of contacts.
 
- Protected Attributes inherited from ConfigObject
QString _name
 Holds the name of the object.
 

Properties

DMRContactRefListcontacts
 The list of contacts.
 
- Properties inherited from ConfigObject
QString name
 The name of the object.
 

Additional Inherited Members

- Signals inherited from ConfigItem
void modified (ConfigItem *obj)
 Gets emitted once the config object is modified. More...
 
void beginClear ()
 Gets emitted before clearing the item.
 
void endClear ()
 Gets emitted after clearing the item.
 
- Protected Member Functions inherited from ConfigObject
 ConfigObject (QObject *parent=nullptr)
 Specifies the prefix for every ID assigned to every object during serialization. More...
 
 ConfigObject (const QString &name, QObject *parent=nullptr)
 Hidden constructor. More...
 
virtual bool populate (YAML::Node &node, const Context &context, const ErrorStack &err=ErrorStack())
 Recursively serializes the configuration to YAML nodes. More...
 
- Protected Member Functions inherited from ConfigItem
 ConfigItem (QObject *parent=nullptr)
 Hidden constructor. More...
 
- Static Protected Member Functions inherited from ConfigObject
static QString findIdPrefix (const QMetaObject *meta)
 Helper to find the IdPrefix class info in the class hierarchy.
 

Detailed Description

Generic representation of a RX group list.

Constructor & Destructor Documentation

◆ RXGroupList()

RXGroupList::RXGroupList ( const QString &  name,
QObject *  parent = nullptr 
)

Constructor.

Parameters
nameSpecifies the name of the group list.
parentQObject parent instance.

Member Function Documentation

◆ serialize()

YAML::Node RXGroupList::serialize ( const Context context,
const ErrorStack err = ErrorStack() 
)
virtual

Recursively serializes the configuration to YAML nodes.

The complete configuration must be labeled first.

Reimplemented from ConfigItem.


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