Class used by a Publisher to handle its own publisher status. More...
#include <pubBase.hpp>
Public Member Functions | |
| PublisherStatus (const std::string &pub_id, const std::string obj_id="ccf::common::PublisherStatus") | |
| PublisherStatus (const PublisherStatus &source) | |
| PublisherStatus () | |
| virtual | ~PublisherStatus () |
| void | Reset () |
| Reset the members in the publisher status. More... | |
| const std::string & | GetPubId () const |
| Return the ID of the Publisher Status object. More... | |
| void | SetStatus (const PubStatus status) |
| Set the status of the Publisher Status object. More... | |
| PubStatus | GetStatus () const |
| Return the status of the associated Data Publisher. More... | |
| double | GetStartTime () const |
| Get the start time for the previous publishing started (seconds since epoch). More... | |
| void | IncrFramesHandled () |
| Increment the number of frame handled by one. More... | |
| int64_t | GetFramesHandled () const |
| Return the number of frames handled. More... | |
| void | IncrVolumeHandled (const uint32_t vol) |
| Increase the volume handled by the Data Publisher with the given number. More... | |
| int64_t | GetVolumeHandled () const |
| Return the volume handled. More... | |
| void | AddFileStored (const std::string &new_file) |
| uint64_t | GetNbOfFilesStored () const |
| Get the number of files stored (for a Recording Publisher). More... | |
| void | GetFilesStored (std::vector< std::string > &files_stored) const |
| Get the names of the output files stored. More... | |
| void | SetFramesHandled (const int64_t nb_of_frames_handled) |
| Set the number of frames handled. More... | |
| void | SetVolumeHandled (const int64_t volume_handled) |
| Set the volume (in bytes) handled. More... | |
| void | SetFilesStored (const std::vector< std::string > &files_stored) |
| Set the names of the files stored. More... | |
| std::string | ToString () const |
| Generate a summarising, one line status of the object instance. More... | |
| PublisherStatus & | operator= (const PublisherStatus &source) |
 Public Member Functions inherited from ccf::Base | |
| Base () | |
| ~Base () | |
| const std::string & | GetClassName () const |
| Return the allocated name of the class. More... | |
| log4cplus::Logger & | Loggger () |
| Return reference to logger used in this context. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ccf::Base | |
| static ccf::mptk::Manager & | Mptk () |
| Return reference to internal MPTK instance (singleton). More... | |
| static void | SetLogLevel (const ccf::LogLevel log_level) |
| Set the log level. More... | |
| static ccf::LogLevel | GetLogLevel () |
| Return the current CCF log level. More... | |
| Protected Member Functions inherited from ccf::Base | |
| void | SetClassName (const std::string &class_name) |
| Set the name of the class in question. More... | |
| void | SetLogger (log4cplus::Logger &logger) |
| Set reference to logger used in this context. More... | |
| Protected Attributes inherited from ccf::Base | |
| log4cplus::Logger | m_logger |
Detailed Description
Class used by a Publisher to handle its own publisher status.
Constructor & Destructor Documentation
◆ PublisherStatus() [1/3]
| ccf::common::PublisherStatus::PublisherStatus | ( | const std::string & | pub_id, |
| const std::string | obj_id = "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]
| ccf::common::PublisherStatus::PublisherStatus | ( | const PublisherStatus & | source | ) |
◆ PublisherStatus() [3/3]
| ccf::common::PublisherStatus::PublisherStatus | ( | ) |
◆ ~PublisherStatus()
|
virtual |
Member Function Documentation
◆ AddFileStored()
| void 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 ccf::common::PublisherStatus::GetFilesStored | ( | std::vector< std::string > & | files_stored | ) | const |
Get the names of the output files stored.
◆ GetFramesHandled()
| int64_t ccf::common::PublisherStatus::GetFramesHandled | ( | ) | const |
Return the number of frames handled.
◆ GetNbOfFilesStored()
| uint64_t ccf::common::PublisherStatus::GetNbOfFilesStored | ( | ) | const |
Get the number of files stored (for a Recording Publisher).
◆ GetPubId()
| const std::string & ccf::common::PublisherStatus::GetPubId | ( | ) | const |
Return the ID of the Publisher Status object.
◆ GetStartTime()
| double ccf::common::PublisherStatus::GetStartTime | ( | ) | const |
Get the start time for the previous publishing started (seconds since epoch).
◆ GetStatus()
| ccf::PubStatus ccf::common::PublisherStatus::GetStatus | ( | ) | const |
Return the status of the associated Data Publisher.
◆ GetVolumeHandled()
| int64_t ccf::common::PublisherStatus::GetVolumeHandled | ( | ) | const |
Return the volume handled.
◆ IncrFramesHandled()
| void ccf::common::PublisherStatus::IncrFramesHandled | ( | ) |
Increment the number of frame handled by one.
◆ IncrVolumeHandled()
| void ccf::common::PublisherStatus::IncrVolumeHandled | ( | const uint32_t | vol | ) |
Increase the volume handled by the Data Publisher with the given number.
◆ operator=()
| PublisherStatus & ccf::common::PublisherStatus::operator= | ( | const PublisherStatus & | source | ) |
◆ Reset()
| void ccf::common::PublisherStatus::Reset | ( | ) |
Reset the members in the publisher status.
◆ SetFilesStored()
| void ccf::common::PublisherStatus::SetFilesStored | ( | const std::vector< std::string > & | files_stored | ) |
Set the names of the files stored.
◆ SetFramesHandled()
| void ccf::common::PublisherStatus::SetFramesHandled | ( | const int64_t | nb_of_frames_handled | ) |
Set the number of frames handled.
◆ SetStatus()
| void ccf::common::PublisherStatus::SetStatus | ( | const PubStatus | status | ) |
Set the status of the Publisher Status object.
◆ SetVolumeHandled()
| void ccf::common::PublisherStatus::SetVolumeHandled | ( | const int64_t | volume_handled | ) |
Set the volume (in bytes) handled.
◆ ToString()
| std::string 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/ccf/common/pubBase.hpp
- common/src/pubBase.cpp
