cc_tools_qt Namespace Reference

Main namespace for all classes / functions of the shared library. More...

Namespaces
namespace	field
	Namespace containing definition of field classes.
namespace	property
	Namespace containing classes describing various properties.

Classes
struct	ToolsDataInfo
	Information about incomming or outdoing data. More...
class	ToolsField
	Field class. More...
class	ToolsFilter
	Main polymorphic interface class for filters. More...
class	ToolsMessage
	Main interface class used by CommsChampion Tools to display and manipulate messages. More...
class	ToolsMessageBase
	Helper class used to define protocol message class in CommsChampion Tools plugin environment. More...
class	ToolsPlugin
	Interface class for plugin definition. More...
class	ToolsProtocol
	Main polymorphic interface class for protocols. More...
class	ToolsRawDataMessage
	Raw data message. More...
class	ToolsSocket
	Main polymorphic interface class for sockets. More...
class	ToolsTransportMessageBase
	Base class for TransportMessage definition in protocol plugin. More...

Typedefs
using	ToolsDataInfoPtr = std::shared_ptr< ToolsDataInfo >
	Pointer to ToolsDataInfo.
using	ToolsFilterPtr = std::shared_ptr< ToolsFilter >
	Pointer to ToolsFilter object.
using	ToolsMessagePtr = std::shared_ptr< ToolsMessage >
	Smart pointer to ToolsMessage.
template<template< typename... > class TMessageBase>
using	ToolsProtMsgInterface = TMessageBase< comms::option::app::IdInfoInterface, comms::option::app::ReadIterator< const std::uint8_t * >, comms::option::app::WriteIterator< std::back_insert_iterator< std::vector< std::uint8_t > > >, comms::option::app::LengthInfoInterface >
	Interface class that needs to be used for the messages when implementing protocol plugin.
using	ToolsProtocolPtr = std::shared_ptr< ToolsProtocol >
	Pointer to ToolsProtocol object.
using	ToolsSocketPtr = std::shared_ptr< ToolsSocket >
	Pointer to ToolsSocket object.

Functions
CC_TOOLS_API ToolsDataInfoPtr	makeDataInfo ()
	Dynamically allocate ToolsDataInfo and return in in ToolsDataInfoPtr;.
CC_TOOLS_API ToolsDataInfoPtr	makeDataInfoTimed ()
	Dynamically allocate ToolsDataInfo and return in in ToolsDataInfoPtr;.
constexpr unsigned	version ()
	Version of the library as single numeric value.
constexpr unsigned	versionCreate (unsigned major, unsigned minor, unsigned patch)
	Create version of the library as single unsigned numeric value.
constexpr unsigned	versionMajor ()
	Major verion of the library.
constexpr unsigned	versionMinor ()
	Minor verion of the library.
constexpr unsigned	versionPatch ()
	Patch level of the library.

Detailed Description

Main namespace for all classes / functions of the shared library.

Typedef Documentation

ToolsProtMsgInterface

template<template< typename... > class TMessageBase>

using cc_tools_qt::ToolsProtMsgInterface = typedef TMessageBase< comms::option::app::IdInfoInterface, comms::option::app::ReadIterator<const std::uint8_t*>, comms::option::app::WriteIterator<std::back_insert_iterator<std::vector<std::uint8_t> >>, comms::option::app::LengthInfoInterface >

Interface class that needs to be used for the messages when implementing protocol plugin.

Extends comms::Message as well as provided interface class, while passing required options to the latter.

Template Parameters

TMessageBase

Name of the interface class defined for custom protocol. Expected to inherit from (or be type alias of) comms::Message and have the following definition: template <typename... TOptions> class MyInterfaceClass : public comms::Message<...> {...};

Function Documentation

makeDataInfoTimed()

CC_TOOLS_API ToolsDataInfoPtr cc_tools_qt::makeDataInfoTimed

(

)

Dynamically allocate ToolsDataInfo and return in in ToolsDataInfoPtr;.

Automatically populate the timestamp.