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

Generic representation of a scan list. More...

#include <scanlist.hh>

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

Public Member Functions

 ScanList (QObject *parent=nullptr)
 Default constructor.
 
 ScanList (const QString &name, QObject *parent=nullptr)
 Constructs a scan list with the given name.
 
ScanListoperator= (const ScanList &other)
 Copies the given scan list.
 
ConfigItemclone () const
 Clones this item.
 
int count () const
 Returns the number of channels within the scanlist.
 
void clear ()
 Clears the scan list.
 
bool contains (Channel *channel) const
 Returns true if the given channel is part of this scanlist.
 
Channelchannel (int idx) const
 Returns the channel at the given index.
 
int addChannel (Channel *channel, int idx=-1)
 Adds a channel to the scan list.
 
bool remChannel (int idx)
 Removes the channel at the given index.
 
bool remChannel (Channel *channel)
 Removes the given channel.
 
const ChannelRefListchannels () const
 Returns the channels of the scan list.
 
ChannelRefListchannels ()
 Returns the channels of the scan list.
 
const ChannelReferenceprimary () const
 Returns the primary channel reference.
 
ChannelReferenceprimary ()
 Returns the primary channel reference.
 
ChannelprimaryChannel () const
 Returns the priority channel.
 
void setPrimaryChannel (Channel *channel)
 Sets the priority channel.
 
const ChannelReferencesecondary () const
 Returns the secondary channel reference.
 
ChannelReferencesecondary ()
 Returns the secondary channel reference.
 
ChannelsecondaryChannel () const
 Returns the secondary priority channel.
 
void setSecondaryChannel (Channel *channel)
 Sets the secondary priority channel.
 
const ChannelReferencerevert () const
 Returns the revert channel reference.
 
ChannelReferencerevert ()
 Returns the revert channel reference.
 
ChannelrevertChannel () const
 Returns the TX channel.
 
void setRevertChannel (Channel *channel)
 Sets the TX channel.
 
TyTScanListExtensiontytScanListExtension () const
 Returns the TyT scan-list extension instance (if set).
 
void setTyTScanListExtension (TyTScanListExtension *tyt)
 Sets the TyT scan-list extension.
 
- 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 YAML::Node serialize (const Context &context, const ErrorStack &err=ErrorStack())
 Recursively serializes the configuration to YAML nodes. 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 Attributes

ChannelRefList _channels
 The channel list.
 
ChannelReference _primary
 The priority channel.
 
ChannelReference _secondary
 The secondary priority channel.
 
ChannelReference _revert
 The transmit channel.
 
TyTScanListExtension_tyt
 TyT scan-list settings extension.
 
- Protected Attributes inherited from ConfigObject
QString _name
 Holds the name of the object.
 

Properties

ChannelReferenceprimary
 The primary channel.
 
ChannelReferencesecondary
 The secondary channel.
 
ChannelReferencerevert
 The revert channel.
 
ChannelRefListchannels
 The list of channels.
 
TyTScanListExtensiontyt
 The TyT scan-list extension.
 
- 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 scan list.


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