Telemetry Subscriber

Telemetry Subscriber and related components. More...

Modules
	Instantiation used for functional tests.
	Integration test components.

Files
file	businessLogic.cpp
	Implements the business logic for telSub.
file	correlator.cpp
	Implementation of the Correlator class.
file	dataSample.cpp
	Definition of data sample classes.
file	ddsSubscriber.cpp
	Implementation of the DdsSubscriber.
file	businessLogic.hpp
	Implements the business logic for telSub.
file	correlator.hpp
	Declares Correlator.
file	correlatorIf.hpp
	Declares CorrelatorIf.
file	dataSample.hpp
	Declares ShmPublisher.
file	ddsReaderListener.hpp
	DDS Reader Listener.
file	ddsSubscriber.hpp
	Declares the DdsSubscriber implementation.
file	ddsSubscriberIf.hpp
	Declares DdsSubscriberIf.
file	main.hpp
	Entry-point for Telemetry Subscriber.
file	operationalLogic.hpp
	Declares OperationalLogic.
file	operationalLogicIf.hpp
	Declares OperationalLogicIf.
file	shmPublisher.hpp
	Declares ShmPublisher.
file	shmPublisherIf.hpp
	Declares ShmPublisher.
file	operationalLogic.cpp
	Definition of OperationalLogic.
file	shmPublisher.cpp
	shmPublisher definition
file	incMain.cpp
	Test that rtck/telSub/main.hpp is self-contained.
file	mockCorrelatorIf.hpp
	Mock of ShmPublisherIf.
file	mockShmPublisherIf.hpp
	Mock of ShmPublisherIf.
file	testDdsSubscriber.cpp
	Unit test for ShmPublisher.
file	testOperationalLogic.cpp
	Unit tests for OperationalLogic.
file	testShmPublisher.cpp
	Unit test for ShmPublisher.
file	main.cpp
	Entry point for telSubTestApp.
file	wscript
	Telemetry Subscriber package.
file	wscript
	Topic definition for telSub test application.
file	wscript
	Telemetry Subscriber package.
file	testShmSubscriber.cpp
	Unit tests for ShmSubscriber.

Classes
class	rtctk::telSub::DdsReaderListener
	Listener class for different DDS events. More...
class	rtctk::telSub::ShmPublisherIf

Functions
template<class UserTopicType , class DataBlender >
void	rtctk::telSub::Main (const rtctk::componentFramework::Args &args, DataBlender &&blender) noexcept
template<class UserTopicType , class DataBlender , class ShmWriter >
auto	rtctk::telSub::MakeShmPublisher (ShmWriter &&shm_writer, DataBlender &blender) -> std::unique_ptr< ShmPublisher< UserTopicType, DataBlender, ShmWriter >>

Detailed Description

Telemetry Subscriber and related components.

Refer to the Telemetry Subscriber Package for an overview.

Function Documentation

Main()

template<class UserTopicType , class DataBlender >

void rtctk::telSub::Main ( const rtctk::componentFramework::Args &  args, DataBlender &&  blender  )

noexcept

Entrypoint for running telemetry subscriber.

Template Parameters

UserTopicType	User defined topic used in shared memory queue.
DataBlender	Type for the blender function.

Parameters

args	Command line arguments as received in RtcComponentMain.
blender	The function used to convert DDS agnostic topic samples into the user defined topic in shared memory. The signature for the function must be the following: std::error_code myBlender(const rtctk::telSub::CorrelatedDataSamplesRef& dds_samples, UserTopicType& shm_sample)

MakeShmPublisher()

template<class UserTopicType , class DataBlender , class ShmWriter >

auto rtctk::telSub::MakeShmPublisher	(	ShmWriter &&	shm_writer,
		DataBlender &	blender
	)		-> std::unique_ptr<ShmPublisher<UserTopicType, DataBlender, ShmWriter>>

Helper that can deduce DataBlender class template argument.