This class represents a GPS signalling system within the codeplug. More...

#include <gpssystem.hh>

Inheritance diagram for GPSSystem:

[legend]

Collaboration diagram for GPSSystem:

[legend]

Public Member Functions
Q_INVOKABLE	GPSSystem (QObject *parent=nullptr)
	Default constructor.

	GPSSystem (const QString &name, DMRContact contact=nullptr, DMRChannel revertChannel=nullptr, unsigned period=300, QObject *parent=nullptr)
	Constructor. More...

ConfigItem *	clone () const
	Clones this item.

bool	hasContact () const
	Returns `true` if a contact is set for the GPS system.

DMRContact *	contactObj () const
	Returns the destination contact for the GPS information or `nullptr` if not set.

void	setContactObj (DMRContact *contactObj)
	Sets the destination contact for the GPS information.

const DMRContactReference *	contact () const
	Returns the reference to the destination contact.

DMRContactReference *	contact ()
	Returns the reference to the destination contact.

void	setContact (DMRContactReference *contactObj)
	Sets the reference to the destination contact for the GPS information.

bool	hasRevertChannel () const
	Returns `true` if the GPS system has a revert channel set. More...

DMRChannel *	revertChannel () const
	Returns the revert channel for the GPS information or `nullptr` if not set.

void	setRevertChannel (DMRChannel *channel)
	Sets the revert channel for the GPS information to be sent on.

const DMRChannelReference *	revert () const
	Returns a reference to the revert channel.

DMRChannelReference *	revert ()
	Returns a reference to the revert channel.

void	setRevert (DMRChannelReference *channel)
	Sets the revert channel for the GPS information to be sent on.

YAML::Node	serialize (const Context &context, const ErrorStack &err=ErrorStack())
	Recursively serializes the configuration to YAML nodes. More...

Public Member Functions inherited from PositioningSystem
virtual	~PositioningSystem ()
	Destructor.

unsigned	period () const
	Returns the update period in seconds.

void	setPeriod (unsigned period)
	Sets the update period in seconds.

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

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.

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

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 ConfigItem *	allocateChild (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 void	clear ()
	Clears the config object.

virtual const Config *	config () 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
DMRContactReference	_contact
	Holds the destination contact for the GPS information.

DMRChannelReference	_revertChannel
	Holds the revert channel on which the GPS information is sent on.

Protected Attributes inherited from PositioningSystem
unsigned	_period
	Holds the update period in seconds.

Protected Attributes inherited from ConfigObject
QString	_name
	Holds the name of the object.

Properties
DMRContactReference *	contact
	References the destination contact.

DMRChannelReference *	revert
	References the revert channel.

Properties inherited from PositioningSystem
unsigned	period
	The update period in seconds.

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 Slots inherited from PositioningSystem
void	onReferenceModified ()
	Gets called, whenever a reference is modified.

Protected Member Functions inherited from PositioningSystem
	PositioningSystem (QObject *parent=nullptr)
	Default constructor.

	PositioningSystem (const QString &name, unsigned period=300, QObject *parent=nullptr)
	Hidden constructor. More...

bool	populate (YAML::Node &node, const ConfigItem::Context &context, const ErrorStack &err=ErrorStack())
	Recursively serializes the configuration to YAML nodes. More...

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

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

This class represents a GPS signalling system within the codeplug.

Constructor & Destructor Documentation

◆ GPSSystem()

GPSSystem::GPSSystem	(	const QString &	name,
		DMRContact *	contact = `nullptr`,
		DMRChannel *	revertChannel = `nullptr`,
		unsigned	period = `300`,
		QObject *	parent = `nullptr`
	)

Constructor.

Please note, that a contact needs to be set in order for the GPS system to work properly.

Parameters

name	Specifies the name of the GPS system.
contact	Specifies the contact, the GPS position is sent to.
revertChannel	Specifies the channel on which the GPS is sent on. If `nullptr`, the GPS data is sent on the current channel.
period	Specifies the update period in seconds.
parent	Specifies the QObject parent object.

Member Function Documentation

◆ hasRevertChannel()

bool GPSSystem::hasRevertChannel ( ) const

Returns true if the GPS system has a revert channel set.

If not, the GPS information will be sent on the current channel.

◆ serialize()

YAML::Node GPSSystem::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:

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

Public Member Functions

Protected Attributes