ifw::ccf::common::PublisherStatus Class Reference

Class used by a Publisher to handle its own publisher status. More...

#include <pubBase.hpp>

Inheritance diagram for ifw::ccf::common::PublisherStatus:

Public Member Functions
	PublisherStatus (const std::string &pub_id, const std::string obj_id="ifw::ccf::common::PublisherStatus")
	PublisherStatus (const PublisherStatus &source)
	PublisherStatus ()
virtual	~PublisherStatus ()
void	Reset ()
	Reset the members in the publisher status.
const std::string &	GetPubId () const
	Return the ID of the Publisher Status object.
void	SetStatus (const PubStatus status)
	Set the status of the Publisher Status object.
PubStatus	GetStatus () const
	Return the status of the associated Data Publisher.
double	GetStartTime () const
	Get the start time for the previous publishing started (seconds since epoch).
void	IncrFramesHandled ()
	Increment the number of frame handled by one.
int64_t	GetFramesHandled () const
	Return the number of frames handled.
void	IncrVolumeHandled (const uint32_t vol)
	Increase the volume handled by the Data Publisher with the given number.
int64_t	GetVolumeHandled () const
	Return the volume handled.
void	AddFileStored (const std::string &new_file)
uint64_t	GetNbOfFilesStored () const
	Get the number of files stored (for a Recording Publisher).
void	GetFilesStored (std::vector< std::string > &files_stored) const
	Get the names of the output files stored.
void	SetFramesHandled (const int64_t nb_of_frames_handled)
	Set the number of frames handled.
void	SetVolumeHandled (const int64_t volume_handled)
	Set the volume (in bytes) handled.
void	SetFilesStored (const std::vector< std::string > &files_stored)
	Set the names of the files stored.
std::string	ToString () const
	Generate a summarising, one line status of the object instance.
PublisherStatus &	operator= (const PublisherStatus &source)
Public Member Functions inherited from ifw::ccf::Base
	Base ()
	~Base ()
const std::string &	GetClassName () const
	Return the allocated name of the class.

Additional Inherited Members
Static Public Member Functions inherited from ifw::ccf::Base
static ifw::ccf::mptk::Manager &	Mptk ()
	Return reference to internal MPTK instance (singleton).
Protected Member Functions inherited from ifw::ccf::Base
void	SetClassName (const std::string &class_name)
	Set the name of the class in question.

Detailed Description

Class used by a Publisher to handle its own publisher status.

Constructor & Destructor Documentation

PublisherStatus() [1/3]

ifw::ccf::common::PublisherStatus::PublisherStatus	(	const std::string &	pub_id,
		const std::string	obj_id = "ifw::ccf::common::PublisherStatus" )

Instantiates a PublisherStatus class with the given Publisher ID. The object id shall be allocated to a unique ID for the instances used in the Publisher Threads for optimal performance.

PublisherStatus() [2/3]

ifw::ccf::common::PublisherStatus::PublisherStatus

(

const PublisherStatus &

source

)

PublisherStatus() [3/3]

ifw::ccf::common::PublisherStatus::PublisherStatus

(

)

~PublisherStatus()

ifw::ccf::common::PublisherStatus::~PublisherStatus ( )

virtual

Member Function Documentation

AddFileStored()

void ifw::ccf::common::PublisherStatus::AddFileStored

(

const std::string &

new_file

)

Update the internal set of output files generated by the Data Publisher. Note: This will have to be updated by the specific publisher implementation as only this knows about which exact output files have been generated.

GetFilesStored()

void ifw::ccf::common::PublisherStatus::GetFilesStored

(

std::vector< std::string > &

files_stored

)

const

Get the names of the output files stored.

GetFramesHandled()

int64_t ifw::ccf::common::PublisherStatus::GetFramesHandled

(

)

const

Return the number of frames handled.

GetNbOfFilesStored()

uint64_t ifw::ccf::common::PublisherStatus::GetNbOfFilesStored

(

)

const

Get the number of files stored (for a Recording Publisher).

GetPubId()

const std::string & ifw::ccf::common::PublisherStatus::GetPubId

(

)

const

Return the ID of the Publisher Status object.

GetStartTime()

double ifw::ccf::common::PublisherStatus::GetStartTime

(

)

const

Get the start time for the previous publishing started (seconds since epoch).

GetStatus()

ifw::ccf::PubStatus ifw::ccf::common::PublisherStatus::GetStatus

(

)

const

Return the status of the associated Data Publisher.

GetVolumeHandled()

int64_t ifw::ccf::common::PublisherStatus::GetVolumeHandled

(

)

const

Return the volume handled.

IncrFramesHandled()

void ifw::ccf::common::PublisherStatus::IncrFramesHandled

(

)

Increment the number of frame handled by one.

IncrVolumeHandled()

void ifw::ccf::common::PublisherStatus::IncrVolumeHandled

(

const uint32_t

vol

)

Increase the volume handled by the Data Publisher with the given number.

operator=()

PublisherStatus & ifw::ccf::common::PublisherStatus::operator=

(

const PublisherStatus &

source

)

Reset()

void ifw::ccf::common::PublisherStatus::Reset

(

)

Reset the members in the publisher status.

SetFilesStored()

void ifw::ccf::common::PublisherStatus::SetFilesStored

(

const std::vector< std::string > &

files_stored

)

Set the names of the files stored.

SetFramesHandled()

void ifw::ccf::common::PublisherStatus::SetFramesHandled

(

const int64_t

nb_of_frames_handled

)

Set the number of frames handled.

SetStatus()

void ifw::ccf::common::PublisherStatus::SetStatus

(

const PubStatus

status

)

Set the status of the Publisher Status object.

SetVolumeHandled()

void ifw::ccf::common::PublisherStatus::SetVolumeHandled

(

const int64_t

volume_handled

)

Set the volume (in bytes) handled.

ToString()

std::string ifw::ccf::common::PublisherStatus::ToString

(

)

const

Generate a summarising, one line status of the object instance.

---

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

• common/src/include/ifw/ccf/common/pubBase.hpp
• common/src/pubBase.cpp