ifw::ccf::stdpub::PubRtms Class Reference

Standard RTMS Publisher. More...

#include <pubRtms.hpp>

Inheritance diagram for ifw::ccf::stdpub::PubRtms:

Public Member Functions
	PubRtms (const std::string &proc_thread_name, const std::string &pub_thread_name)
	PubRtms ()
virtual	~PubRtms ()
virtual void	InitialiseUser ()
virtual void	PublishUser (ifw::ccf::common::DataFrame &frame)
virtual void	DismantleUser ()
virtual void	CreateObjectUser (const std::string &proc_thread_name, const std::string &pub_thread_name, PubBase **new_object)
Public Member Functions inherited from ifw::ccf::common::PubBase
	PubBase (const std::string &proc_thread_name, const std::string &pub_thread_name)
	PubBase ()
virtual	~PubBase ()
void	Initialise ()
bool	GetInitialised () const
void	Dismantle ()
void	SetEnabled (const bool enabled)
bool	GetEnabled () const
const std::string &	GetProcThreadName () const
const std::string &	GetPubId () const
const std::string &	GetPubThreadName () const
void	Publish (DataFrame &frame, const bool force)
PubType	GetPublisherType () const
void	Activate ()
virtual void	ActivateUser ()
void	Deactivate ()
virtual void	DeactivateUser ()
void	SetActivated (const bool activated)
bool	GetActivated () const
virtual void	CheckForDeactivationUser ()
PublisherStatus &	GetPubStatus ()
void	EstimateExecution (double &duration, int64_t &nb_of_frames)
void	GetPubStatus (PublisherStatus &pub_stat) const
	Make a snapshot of the current Publisher Status object.
virtual void	CreateObjectUser (const std::string &proc_thread_name, const std::string &pub_thread_name, PubBase **new_object)
virtual void	EstimateExecutionUser (double &duration, int64_t &nb_of_frames)
void	ResetDbStatus () const
	Update status for a given Publisher Thread in the OLDB.
void	UpdateDbStatus (const bool force_update=false) const
std::string	ToString () const
Public Member Functions inherited from ifw::ccf::Base
	Base ()
	~Base ()
const std::string &	GetClassName () const
	Return the allocated name of the class.

Static Public Member Functions
static void	_SetSimulation ()
Static Public Member Functions inherited from ifw::ccf::common::PubBase
static const std::string &	GenId (const std::string &proc_thread_name, const std::string &pub_thread_name)
	Generate an ID for the Publisher.
template<class TYPE >
static void	AddPubFactoryObj (TYPE &pub_factory_obj)
	Static method to register a Data Publisher factory object in the internal registry.
static const std::map< std::string, std::shared_ptr< PubBase > > &	GetPubFactoryObjs ()
	Generate vector with references to the Publisher Factory Objects registered.
static void	CreatePubObj (const std::string &class_name, const std::string &proc_thread_name, const std::string &pub_thread_name, PubBase **new_object)
static void	GetPubObj (const std::string &proc_thread_name, const std::string &pub_thread_name, PubBase **pub_obj, const bool initialise=true)
static void	GetPubObjs (std::vector< PubBase * > &pub_objs)
	Get reference to all Data Publisher Objects registered.
static bool	HasPubObj (const std::string &proc_thread_name, const std::string &pub_thread_name, PubBase **pub_obj)
	Check if a Publisher object is defined.
static void	SetRecTrigger (const double rec_trigger)
	Set the trigger for deferred recording.
static double	GetRecTrigger ()
	Get the trigger for deferred recording.
static void	SetDeferredStart (const bool def_start_active)
	Set the deferred start mode.
static bool	GetDeferredStart ()
	Get the deferred start mode.
Static Public Member Functions inherited from ifw::ccf::Base
static ifw::ccf::mptk::Manager &	Mptk ()
	Return reference to internal MPTK instance (singleton).

Public Attributes
const std::string	SETUP_KEY_BPP = "bpp"
const std::string	SETUP_KEY_TOPIC_ID = "topic_id"
const std::string	SETUP_KEY_SAMPLE_ID = "sample_id"
const std::string	SETUP_KEY_PKT_SEND_DELAY = "pkt_send_delay"

Additional Inherited Members
Protected Member Functions inherited from ifw::ccf::Base
void	SetClassName (const std::string &class_name)
	Set the name of the class in question.
Protected Attributes inherited from ifw::ccf::common::PubBase
PubType	m_publisher_type
bool	m_initialised
bool	m_setup_enabled
bool	m_stat_active

Detailed Description

Standard RTMS Publisher.

Constructor & Destructor Documentation

PubRtms() [1/2]

ifw::ccf::stdpub::PubRtms::PubRtms	(	const std::string &	proc_thread_name,
		const std::string &	pub_thread_name )

PubRtms() [2/2]

ifw::ccf::stdpub::PubRtms::PubRtms

(

)

~PubRtms()

ifw::ccf::stdpub::PubRtms::~PubRtms ( )

virtual

Member Function Documentation

_SetSimulation()

void ifw::ccf::stdpub::PubRtms::_SetSimulation ( )

static

CreateObjectUser()

void ifw::ccf::stdpub::PubRtms::CreateObjectUser ( const std::string & proc_thread_name, const std::string & pub_thread_name, PubBase ** new_object )

virtual

DismantleUser()

void ifw::ccf::stdpub::PubRtms::DismantleUser ( )

virtual

Reimplemented from ifw::ccf::common::PubBase.

InitialiseUser()

void ifw::ccf::stdpub::PubRtms::InitialiseUser ( )

virtual

Reimplemented from ifw::ccf::common::PubBase.

PublishUser()

void ifw::ccf::stdpub::PubRtms::PublishUser ( ifw::ccf::common::DataFrame & frame )

virtual

Reimplemented from ifw::ccf::common::PubBase.

Member Data Documentation

SETUP_KEY_BPP

const std::string ifw::ccf::stdpub::PubRtms::SETUP_KEY_BPP = "bpp"

SETUP_KEY_PKT_SEND_DELAY

const std::string ifw::ccf::stdpub::PubRtms::SETUP_KEY_PKT_SEND_DELAY = "pkt_send_delay"

SETUP_KEY_SAMPLE_ID

const std::string ifw::ccf::stdpub::PubRtms::SETUP_KEY_SAMPLE_ID = "sample_id"

SETUP_KEY_TOPIC_ID

const std::string ifw::ccf::stdpub::PubRtms::SETUP_KEY_TOPIC_ID = "topic_id"

---

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

• stdpub/src/include/ifw/ccf/stdpub/pubRtms.hpp
• stdpub/src/pubRtms.cpp