#include <telRepubBusinessLogic.hpp>

Inheritance diagram for rtctk::telRepub::TelRepubBusinessLogic:

Public Member Functions
	TelRepubBusinessLogic (const std::string &name, rtctk::componentFramework::ServiceContainer &services)

virtual	~TelRepubBusinessLogic ()

void	Starting (StopToken st) override

void	Recovering (StopToken st) override

void	Initialising (StopToken st) override

void	Enabling (StopToken st) override

void	Disabling (StopToken st) override

void	GoingRunning (StopToken st) override

void	GoingIdle (StopToken st) override

void	Running (StopToken st) override

void	Updating (StopToken st, Payload args) override

bool	IsUpdatingAllowed (Payload args) override

Public Member Functions inherited from rtctk::componentFramework::RunnableStateMachineLogicIf
virtual	~RunnableStateMachineLogicIf ()=default

Protected Member Functions
void	CreateMudpiReceivers ()

void	DeleteMudpiReceivers ()

void	CreateDdsPubs ()

void	DeleteDdsPubs ()

Protected Attributes
const std::string	m_name

rtctk::componentFramework::ServiceContainer &	m_serviceContainer

DdsPub	m_ddsPub

std::vector< std::unique_ptr< UdpReceiver > >	udp_receivers

std::list< PubThread< rtctk::AgnosticTopic > >	m_pubThreads

Detailed Description

Telemetry Republisher business logic

Constructor & Destructor Documentation

◆ TelRepubBusinessLogic()

rtctk::telRepub::TelRepubBusinessLogic::TelRepubBusinessLogic	(	const std::string &	name,
		rtctk::componentFramework::ServiceContainer &	services
	)

◆ ~TelRepubBusinessLogic()

rtctk::telRepub::TelRepubBusinessLogic::~TelRepubBusinessLogic ( )

virtual

Member Function Documentation

◆ CreateDdsPubs()

void rtctk::telRepub::TelRepubBusinessLogic::CreateDdsPubs ( )

protected

creates DDS publishers (rtctk::telRepub::DdsPub) reading configuration from run-time repository

◆ CreateMudpiReceivers()

void rtctk::telRepub::TelRepubBusinessLogic::CreateMudpiReceivers ( )

protected

creates UDPI receivers (rtctk::telRepub::UdpReceiver) reading configuration from run-time repository

◆ DeleteDdsPubs()

void rtctk::telRepub::TelRepubBusinessLogic::DeleteDdsPubs ( )

protected

deletes DDS publishers (rtctk::telRepub::DdsPub)

◆ DeleteMudpiReceivers()

void rtctk::telRepub::TelRepubBusinessLogic::DeleteMudpiReceivers ( )

protected

deletes UDPI receivers (rtctk::telRepub::UdpReceiver)

◆ Disabling()

void rtctk::telRepub::TelRepubBusinessLogic::Disabling ( StopToken st )

overridevirtual

Activity On::Operational::Disabling

Activity method to to back to NotOperational, e.g. stop threads, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Enabling()

void rtctk::telRepub::TelRepubBusinessLogic::Enabling ( StopToken st )

overridevirtual

Activity On::NotOperational::Enabling

Activity method to prepare the component for operation, e.g. start threads, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ GoingIdle()

void rtctk::telRepub::TelRepubBusinessLogic::GoingIdle ( StopToken st )

overridevirtual

Activity On::Operational::GoingIdle

Activity method to leave state running, e.g. turn off receivers, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ GoingRunning()

void rtctk::telRepub::TelRepubBusinessLogic::GoingRunning ( StopToken st )

overridevirtual

Activity On::Operational::GoingRunning

Activity method to prepare to run, e.g. start receiving data, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Initialising()

void rtctk::telRepub::TelRepubBusinessLogic::Initialising ( StopToken st )

overridevirtual

Activity On::NotOperational::Initialising

Activity method to initialise the component, e.g. construct members, etc.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ IsUpdatingAllowed()

bool rtctk::telRepub::TelRepubBusinessLogic::IsUpdatingAllowed ( Payload args )

overridevirtual

Guard IsUpdatingAllowed

Guard method to further constrain whether an Update command is allowed to cause an Updating activity or not. Simply set the return value to configure as needed.

Parameters

args	Payload, to be able to receive information on what to update

Returns: false if update is dissalowed.; true, if update is allowed.

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Recovering()

void rtctk::telRepub::TelRepubBusinessLogic::Recovering ( StopToken st )

overridevirtual

Activity Operational::Recovering

Activity method to recover from error in On::Operational::Error, after successful recovery the state machine will transition to state On::Operational::Idle

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Running()

void rtctk::telRepub::TelRepubBusinessLogic::Running ( StopToken st )

overridevirtual

Activity On::Operational::Running

Activity method for state running, e.g. receive, compute, send

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Starting()

void rtctk::telRepub::TelRepubBusinessLogic::Starting ( StopToken st )

overridevirtual

Activity On::NotOperational::Starting

Activity method to perfrom setup work after start and reset of component.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

◆ Updating()

void rtctk::telRepub::TelRepubBusinessLogic::Updating	(	StopToken	st,
		Payload	args
	)

overridevirtual

Activity Operational::Updating

Activity method to update dynamic component configuration. On default updates are only allowed ins states. On::Operational::Idle and On::Operational::Running.

Parameters

st	StopToken, to get notified when the activity is supposed to terminate
args	Payload, to be able to receive information on what to update

Implements rtctk::componentFramework::RunnableStateMachineLogicIf.

Member Data Documentation

◆ m_ddsPub

DdsPub rtctk::telRepub::TelRepubBusinessLogic::m_ddsPub

protected

◆ m_name

const std::string rtctk::telRepub::TelRepubBusinessLogic::m_name

protected

component name

◆ m_pubThreads

std::list<PubThread<rtctk::AgnosticTopic> > rtctk::telRepub::TelRepubBusinessLogic::m_pubThreads

protected

list of DDS publishers

◆ m_serviceContainer

rtctk::componentFramework::ServiceContainer& rtctk::telRepub::TelRepubBusinessLogic::m_serviceContainer

protected

reference to container services needed to access run-time repository for configuration.

◆ udp_receivers

std::vector<std::unique_ptr<UdpReceiver> > rtctk::telRepub::TelRepubBusinessLogic::udp_receivers

protected

vector of UDP receivers

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

reusableComponents/telRepub/src/include/telRepubBusinessLogic.hpp
reusableComponents/telRepub/src/telRepubBusinessLogic.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TelRepubBusinessLogic()

◆ ~TelRepubBusinessLogic()

Member Function Documentation

◆ CreateDdsPubs()

◆ CreateMudpiReceivers()

◆ DeleteDdsPubs()

◆ DeleteMudpiReceivers()

◆ Disabling()

◆ Enabling()

◆ GoingIdle()

◆ GoingRunning()

◆ Initialising()

◆ IsUpdatingAllowed()

◆ Recovering()

◆ Running()

◆ Starting()

◆ Updating()

Member Data Documentation

◆ m_ddsPub

◆ m_name

◆ m_pubThreads

◆ m_serviceContainer

◆ udp_receivers