ccf::stdpub::PubDdt Class Reference

Standard DDT Publisher. More...

#include <pubDdt.hpp>

Inheritance diagram for ccf::stdpub::PubDdt:

Public Member Functions
	PubDdt (const uint16_t proc_thread_nb, const uint16_t pub_thread_nb, const std::string &pub_name)
	PubDdt ()
virtual	~PubDdt ()
virtual void	InitialiseUser ()
virtual void	PublishUser (ccf::common::DataFrame &frame)
virtual void	DismantleUser ()
virtual void	CreateObjectUser (const uint16_t proc_thread_nb, const uint16_t pub_thread_nb, const std::string &pub_name, ccf::common::PubBase **new_object)
Public Member Functions inherited from ccf::common::PubBase
	PubBase (const uint16_t proc_thread_nb, const uint16_t pub_thread_nb, const std::string &pub_name)
	PubBase ()
virtual	~PubBase ()
void	Initialise ()
bool	GetInitialised () const
void	Dismantle ()
void	SetEnabled (const bool enabled)
bool	GetEnabled () const
const uint8_t	GetProcThreadNb () const
const uint8_t	GetPubThreadNb () const
const std::string &	GetPubId () const
const std::string &	GetPubName () 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. More...
virtual void	EstimateExecutionUser (double &duration, int64_t &nb_of_frames)
void	ResetDbStatus () const
	Update status for a given Publisher Thread in the OLDB. More...
void	UpdateDbStatus () const
std::string	ToString () const
Public Member Functions inherited from ccf::common::Base
	Base ()
	~Base ()
const std::string &	GetClassName () const
	Return the allocated name of the class. More...

Static Public Member Functions
static uint32_t	CcfToDdtDataType (ccf::common::ImageDataType ccf_datatype)
static void	_SetSimulation ()
Static Public Member Functions inherited from ccf::common::PubBase
static const std::string &	GenId (const uint16_t proc_thread_nb, const uint16_t pub_thread_nb)
static void	AddPubFactoryObj (PubBase &pub_factory_obj)
	Static method to register a Data Publisher factory object in the internal registry. More...
static void	GetPubFactoryObjs (std::vector< PubBase * > &pub_factory_objs)
	Generate vector with references to the Publisher Factory Objects registered. More...
static void	CreatePubObj (const std::string &class_name, const uint16_t proc_thread_nb, const uint16_t pub_thread_nb, const std::string &pub_name, PubBase **new_object)
static void	GetPubObj (const uint16_t proc_thread_nb, const uint16_t pub_thread_nb, PubBase **pub_obj, const bool initialise=true)
static void	GetPubObjs (std::vector< PubBase * > &pub_objs)
	Get reference to all Data Publisher Objects registered. More...
static bool	HasPubObj (const uint16_t proc_thread_nb, const uint16_t pub_thread_nb, PubBase **pub_obj)
	Check if a Publisher object is defined. More...
static void	FreePubObjs ()
static void	FreePubFactoryObjs ()
Static Public Member Functions inherited from ccf::common::Base
static ccf::mptk::Manager &	Mptk ()
	Return reference to internal MPTK instance (singleton). More...
static void	SetLogLevel (const ccf::common::LogLevel log_level)
	Set the log level. More...
static ccf::common::LogLevel	GetLogLevel ()
	Return the current CCF log level. More...

Public Attributes
const std::string	SETUP_KEY_DDT_ID = "proc%d.pub%d.ddt.id"
const std::string	SETUP_KEY_DDT_BROKER = "proc%d.pub%d.ddt.broker"
const std::string	SETUP_KEY_MAX_RATE = "proc%d.pub%d.ddt.max_rate"

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

Detailed Description

Standard DDT Publisher.

Constructor & Destructor Documentation

PubDdt() [1/2]

ccf::stdpub::PubDdt::PubDdt	(	const uint16_t	proc_thread_nb,
		const uint16_t	pub_thread_nb,
		const std::string &	pub_name
	)

PubDdt() [2/2]

ccf::stdpub::PubDdt::PubDdt

(

)

~PubDdt()

ccf::stdpub::PubDdt::~PubDdt ( )

virtual

Member Function Documentation

_SetSimulation()

void ccf::stdpub::PubDdt::_SetSimulation ( )

static

CcfToDdtDataType()

uint32_t ccf::stdpub::PubDdt::CcfToDdtDataType ( ccf::common::ImageDataType  ccf_datatype )

static

CreateObjectUser()

void ccf::stdpub::PubDdt::CreateObjectUser ( const uint16_t  proc_thread_nb, const uint16_t  pub_thread_nb, const std::string &  pub_name, ccf::common::PubBase **  new_object  )

virtual

Reimplemented from ccf::common::PubBase.

DismantleUser()

void ccf::stdpub::PubDdt::DismantleUser ( )

virtual

Reimplemented from ccf::common::PubBase.

InitialiseUser()

void ccf::stdpub::PubDdt::InitialiseUser ( )

virtual

Reimplemented from ccf::common::PubBase.

PublishUser()

void ccf::stdpub::PubDdt::PublishUser ( ccf::common::DataFrame &  frame )

virtual

Reimplemented from ccf::common::PubBase.

Member Data Documentation

SETUP_KEY_DDT_BROKER

const std::string ccf::stdpub::PubDdt::SETUP_KEY_DDT_BROKER = "proc%d.pub%d.ddt.broker"

SETUP_KEY_DDT_ID

const std::string ccf::stdpub::PubDdt::SETUP_KEY_DDT_ID = "proc%d.pub%d.ddt.id"

SETUP_KEY_MAX_RATE

const std::string ccf::stdpub::PubDdt::SETUP_KEY_MAX_RATE = "proc%d.pub%d.ddt.max_rate"

---

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

• stdpub/src/include/ccf/stdpub/pubDdt.hpp
• stdpub/src/pubDdt.cpp