cc_tools_qt::ToolsMessageBase< TBase, TProtMsg, TActualMsg > Class Template Reference

#include "cc_tools_qt/ToolsMessageBase.h"

Detailed Description

template<typename TBase, template< typename... > class TProtMsg, typename TActualMsg>
class cc_tools_qt::ToolsMessageBase< TBase, TProtMsg, TActualMsg >

Helper class used to define protocol message class in CommsChampion Tools plugin environment.

Template Parameters

TBase	Base class that this class is expected to inherit. Expected to be cc_tools_qt::ToolsMessage or derivative.
TProtMsg	Type of the protocol message defined using comms::MessageBase class.
TActualMsg	Type of the actual message class inheriting from this one

Inheritance diagram for cc_tools_qt::ToolsMessageBase< TBase, TProtMsg, TActualMsg >:

Public Types
using	DataSeq = typename TBase::DataSeq
	Data sequence type.
using	ProtMsg = TProtMsg< ProtInterface, ProtOptions >
	Protocol definition message type.

Public Member Functions
	ToolsMessageBase ()=default
	Handler class.
	ToolsMessageBase (const ToolsMessageBase &other)
	Copy Constructor.
	ToolsMessageBase (ToolsMessageBase &&other)
	Move Constructor.
	~ToolsMessageBase () noexcept=default
	Destructor.
ToolsMessageBase &	operator= (const ToolsMessageBase &other)
	Copy assignment operator.
ToolsMessageBase &	operator= (ToolsMessageBase &&other)
	Move assignment operator.

Protected Member Functions
virtual bool	assignImpl (const cc_tools_qt::ToolsMessage &other) override
	Overriding polymorphic assignment.
virtual bool	decodeDataImpl (const DataSeq &data) override
	Overriding polymorphic deserialisation functionaly.
virtual DataSeq	encodeDataImpl () const override
	Overriding polymorphic serialisation functionaly.
virtual bool	isValidImpl () const override
	Overriding polymorphic validity check.
virtual const char *	nameImpl () const override
	Overriding polymorphic name retrieval functionality.
virtual qlonglong	numericIdImpl () const override
	Overriding polymorphic retrieval of the numeric id.
virtual bool	refreshMsgImpl () override
	Overriding polymorphic refresh functionality.
virtual void	resetImpl () override
	Overriding implementation to cc_tools_qt::ToolsMessage::resetImpl()

Constructor & Destructor Documentation

ToolsMessageBase()

template<typename TBase , template< typename... > class TProtMsg, typename TActualMsg >

cc_tools_qt::ToolsMessageBase< TBase, TProtMsg, TActualMsg >::ToolsMessageBase ( )

default

Handler class.

Default constructor

Member Function Documentation

decodeDataImpl()

template<typename TBase , template< typename... > class TProtMsg, typename TActualMsg >

virtual bool cc_tools_qt::ToolsMessageBase< TBase, TProtMsg, TActualMsg >::decodeDataImpl ( const DataSeq &  data )

overrideprotectedvirtual

Overriding polymorphic deserialisation functionaly.

Invokes read() inherited from provided interface class.

encodeDataImpl()

template<typename TBase , template< typename... > class TProtMsg, typename TActualMsg >

virtual DataSeq cc_tools_qt::ToolsMessageBase< TBase, TProtMsg, TActualMsg >::encodeDataImpl ( ) const

overrideprotectedvirtual

Overriding polymorphic serialisation functionaly.

Invokes write() inherited from provided interface class.

isValidImpl()

template<typename TBase , template< typename... > class TProtMsg, typename TActualMsg >

virtual bool cc_tools_qt::ToolsMessageBase< TBase, TProtMsg, TActualMsg >::isValidImpl ( ) const

overrideprotectedvirtual

Overriding polymorphic validity check.

Invokes valid() inherited from provided interface class.

refreshMsgImpl()

template<typename TBase , template< typename... > class TProtMsg, typename TActualMsg >

virtual bool cc_tools_qt::ToolsMessageBase< TBase, TProtMsg, TActualMsg >::refreshMsgImpl ( )

overrideprotectedvirtual

Overriding polymorphic refresh functionality.

Invokes refresh() inherited from the provided interface class

---

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

• include/cc_tools_qt/ToolsMessageBase.h