Standard FITS Publisher. More...

#include <pubFits.hpp>

Inheritance diagram for ccf::stdpub::PubFits:

Public Types
enum	Format { Format::SINGLE = 1, Format::CUBE, Format::MEF }

enum	RecordingMode { RecordingMode::ALL = 1, RecordingMode::INTERVAL, RecordingMode::PERIODIC }

Public Member Functions
	PubFits (const uint16_t proc_thread_nb, const uint16_t pub_thread_nb, const std::string &pub_name)

	PubFits ()

virtual	~PubFits ()

virtual void	InitialiseUser ()

virtual void	PublishUser (ccf::common::DataFrame &frame)

virtual void	CheckForDeactivationUser ()

virtual void	ActivateUser ()

virtual void	DeactivateUser ()

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)

virtual void	EstimateExecutionUser (double &duration, int64_t &nb_of_frames)

Format	FormatToNb (const std::string &format)

std::string	FormatToStr (const Format format)

void	DecodeRecMode (const std::string &rec_mode_specifier)

std::string	RecordingModeToStr (const RecordingMode mode)

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 ()

void	Deactivate ()

void	SetActivated (const bool activated)

bool	GetActivated () const

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	DismantleUser ()

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...

Public Attributes
const std::string	SETUP_KEY_BASENAME = "proc%d.pub%d.basename"

const std::string	SETUP_KEY_MAX_SIZE = "proc%d.pub%d.max_size"

const std::string	SETUP_KEY_NB_OF_FRAMES = "proc%d.pub%d.nb_of_frames"

const std::string	SETUP_KEY_FORMAT = "proc%d.pub%d.format"

const std::string	SETUP_KEY_OVERWRITE = "proc%d.pub%d.overwrite"

const std::string	SETUP_KEY_REC_MODE = "proc%d.pub%d.rec_mode"

const std::string	FORMAT_SINGLE = "Single"

const std::string	FORMAT_CUBE = "Cube"

const std::string	FORMAT_MEF = "MEF"

const std::string	RECORDING_MODE_ALL = "ALL"

const std::string	RECORDING_MODE_INTERVAL = "INTERVAL"

const std::string	RECORDING_MODE_PERIODIC = "PERIODIC"

Static Public Attributes
static bool	s_initialised = false

static char	s_padding_bytes [2880]

Additional Inherited Members
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...

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 FITS Publisher.

Member Enumeration Documentation

◆ Format

enum ccf::stdpub::PubFits::Format

strong

Enumerator
SINGLE
CUBE
MEF

◆ RecordingMode

enum ccf::stdpub::PubFits::RecordingMode

strong

Enumerator
ALL
INTERVAL
PERIODIC

Constructor & Destructor Documentation

◆ PubFits() [1/2]

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

◆ PubFits() [2/2]

ccf::stdpub::PubFits::PubFits ( )

◆ ~PubFits()

ccf::stdpub::PubFits::~PubFits ( )

virtual

Member Function Documentation

◆ ActivateUser()

void ccf::stdpub::PubFits::ActivateUser ( )

virtual

Reimplemented from ccf::common::PubBase.

◆ CheckForDeactivationUser()

void ccf::stdpub::PubFits::CheckForDeactivationUser ( )

virtual

Reimplemented from ccf::common::PubBase.

◆ CreateObjectUser()

void ccf::stdpub::PubFits::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.

◆ DeactivateUser()

void ccf::stdpub::PubFits::DeactivateUser ( )

virtual

Reimplemented from ccf::common::PubBase.

◆ DecodeRecMode()

void ccf::stdpub::PubFits::DecodeRecMode ( const std::string & rec_mode_specifier )

◆ EstimateExecutionUser()

void ccf::stdpub::PubFits::EstimateExecutionUser	(	double &	duration,
		int64_t &	nb_of_frames
	)

virtual

Reimplemented from ccf::common::PubBase.

◆ FormatToNb()

PubFits::Format ccf::stdpub::PubFits::FormatToNb ( const std::string & format )

◆ FormatToStr()

std::string ccf::stdpub::PubFits::FormatToStr ( const Format format )

◆ InitialiseUser()

void ccf::stdpub::PubFits::InitialiseUser ( )

virtual

Reimplemented from ccf::common::PubBase.

◆ PublishUser()

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

virtual

Reimplemented from ccf::common::PubBase.

◆ RecordingModeToStr()

std::string ccf::stdpub::PubFits::RecordingModeToStr ( const RecordingMode mode )

Member Data Documentation

◆ FORMAT_CUBE

const std::string ccf::stdpub::PubFits::FORMAT_CUBE = "Cube"

◆ FORMAT_MEF

const std::string ccf::stdpub::PubFits::FORMAT_MEF = "MEF"

◆ FORMAT_SINGLE

const std::string ccf::stdpub::PubFits::FORMAT_SINGLE = "Single"

◆ RECORDING_MODE_ALL

const std::string ccf::stdpub::PubFits::RECORDING_MODE_ALL = "ALL"

◆ RECORDING_MODE_INTERVAL

const std::string ccf::stdpub::PubFits::RECORDING_MODE_INTERVAL = "INTERVAL"

◆ RECORDING_MODE_PERIODIC

const std::string ccf::stdpub::PubFits::RECORDING_MODE_PERIODIC = "PERIODIC"

◆ s_initialised

bool ccf::stdpub::PubFits::s_initialised = false

static

Copyright: ESO - European Southern Observatory

◆ s_padding_bytes

char ccf::stdpub::PubFits::s_padding_bytes

static

◆ SETUP_KEY_BASENAME

const std::string ccf::stdpub::PubFits::SETUP_KEY_BASENAME = "proc%d.pub%d.basename"

◆ SETUP_KEY_FORMAT

const std::string ccf::stdpub::PubFits::SETUP_KEY_FORMAT = "proc%d.pub%d.format"

◆ SETUP_KEY_MAX_SIZE

const std::string ccf::stdpub::PubFits::SETUP_KEY_MAX_SIZE = "proc%d.pub%d.max_size"

◆ SETUP_KEY_NB_OF_FRAMES

const std::string ccf::stdpub::PubFits::SETUP_KEY_NB_OF_FRAMES = "proc%d.pub%d.nb_of_frames"

◆ SETUP_KEY_OVERWRITE

const std::string ccf::stdpub::PubFits::SETUP_KEY_OVERWRITE = "proc%d.pub%d.overwrite"

◆ SETUP_KEY_REC_MODE

const std::string ccf::stdpub::PubFits::SETUP_KEY_REC_MODE = "proc%d.pub%d.rec_mode"

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

stdpub/src/include/ccf/stdpub/pubFits.hpp
stdpub/src/pubFits.cpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Format

◆ RecordingMode

Constructor & Destructor Documentation

◆ PubFits() [1/2]

◆ PubFits() [2/2]

◆ ~PubFits()

Member Function Documentation

◆ ActivateUser()

◆ CheckForDeactivationUser()

◆ CreateObjectUser()

◆ DeactivateUser()

◆ DecodeRecMode()

◆ EstimateExecutionUser()

◆ FormatToNb()

◆ FormatToStr()

◆ InitialiseUser()

◆ PublishUser()

◆ RecordingModeToStr()

Member Data Documentation

◆ FORMAT_CUBE

◆ FORMAT_MEF

◆ FORMAT_SINGLE

◆ RECORDING_MODE_ALL

◆ RECORDING_MODE_INTERVAL

◆ RECORDING_MODE_PERIODIC

◆ s_initialised

◆ s_padding_bytes

◆ SETUP_KEY_BASENAME

◆ SETUP_KEY_FORMAT

◆ SETUP_KEY_MAX_SIZE

◆ SETUP_KEY_NB_OF_FRAMES

◆ SETUP_KEY_OVERWRITE

◆ SETUP_KEY_REC_MODE