Namespaces
namespace	fits

namespace	test

Classes
class	AcqTrigger

class	AppBase
	Class to be used as parent for CCF application type of classes. More...

class	ComAdptBase
	Class to be used as parent for CCF Communication Adapters. More...

class	Config

class	DataFrame
	Frame class used to store the data and metadata for one frames received from the camera. More...

class	Db
	Interface to the OLDB and Pub/Sub. More...

class	DcsClient
	Used to implement CCF Control client applications. More...

struct	DeviceInfo

struct	DeviceProperty

class	ExecAdptBase
	Class to be used as parent for CCF Execution Adapters. More...

class	FrameQueue
	The FrameQueue class implements a queue, to manage a set of CCF DataFrame instances as a ring buffer. More...

class	FrameStatistics
	Class used by the threads to store info for generating performance statistics. More...

class	InternalDb
	DB implementing the ifw::core::utils::bat::DbInterface; used for internal/test purposes. More...

class	MonAdptBase
	Class to be used as parent for CCF Monitor Adapters. More...

class	NameMapping
	Implements a name mapping service, based on a Name Mapping File to be loaded and installed. More...

class	PubBase
	Class for implementing CCF Data Publishers. More...

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

class	RecipeBase
	Processing Recipe base class. All recipes shall be derived from this class. More...

class	Setup
	Global setup class for CCF applications. An Initialisation Setup, containing all the parameters shall be loaded before using the class. More...

Enumerations
enum class	TriggerType { SIGNAL = 0 , ABS_TIME = 1 , CUSTOM = 2 , NOT_USED = 3 }

Functions
std::string	GetHostAddress_ ()

ifw::fnd::datatype::DataType	StrParToDataType (const std::string &par_name)

void	CheckIfReqSupported (const std::string &request)

std::string	GetHostAddress ()

ifw::ccf::common::Config &	GetCfg ()
	Return reference to the singleton instance of the configuration.

ifw::fnd::datatype::DataType	ParToIfwDataType (const std::string &par)
	Attempt to determine the native type of the parameter contained in the parameter object.

template<class SRC_IM_TYPE , class TRG_IM_TYPE >
void	ConvertImage (SRC_IM_TYPE image_buffer, uint32_t pixels, TRG_IM_TYPE target_buf, uint32_t target_buf_size)

void	PrepCplImage (const ifw::ccf::common::DataFrame &frame, cpl_image *image, ifw::fnd::datatype::DataType target_data_type, uint32_t *target_buffer_size)

std::string	GetImageDir ()
	Get the name of the image output folder.

std::string	PackParameters (const ifw::core::utils::param::ParameterSet &parameters)
	Serialise the parameters contained in the parameter set.

void	UnpackParameters (const std::string &parameters, ifw::core::utils::param::ParameterSet &par_set)
	Unpack the serialised parameters and store the information in the provided parameter set object.

std::vector< std::string >	get_call_stack (int max_frames=64)

Variables
DB key names updated in the OLDB by a Data Pubslisher.
const std::string	DB_NODE_PUB_ID = "id"

const std::string	DB_NODE_PUB_NAME = "name"

const std::string	DB_NODE_ADAPTER = "adapter"

const std::string	DB_NODE_PUB_START = "start"

const std::string	DB_NODE_PUB_STATUS = "status"

const std::string	DB_NODE_PUB_FRAMES_HANDLED = "frames_handled"

const std::string	DB_NODE_PUB_VOLUME_HANDLED = "volume_handled"

const std::string	DB_NODE_PUB_NB_OF_FILES_STORED = "nb_of_files_stored"

const std::string	DB_NODE_PUB_FILES_STORED = "files_stored"

Detailed Description

Copyright: ESO - European Southern Observatory

Enumeration Type Documentation

◆ TriggerType

enum class ifw::ccf::common::TriggerType

strong

Enumerator
SIGNAL
ABS_TIME
CUSTOM
NOT_USED

Function Documentation

◆ CheckIfReqSupported()

void ifw::ccf::common::CheckIfReqSupported ( const std::string & request )

◆ ConvertImage()

template<class SRC_IM_TYPE , class TRG_IM_TYPE >

void ifw::ccf::common::ConvertImage	(	SRC_IM_TYPE *	image_buffer,
		uint32_t	pixels,
		TRG_IM_TYPE **	target_buf,
		uint32_t *	target_buf_size )

Convert the given image from one pixel type to another. A buffer is allocated internally, which must be free'd by the user.q

◆ get_call_stack()

std::vector< std::string > ifw::ccf::common::get_call_stack ( int max_frames = 64 )

◆ GetCfg()

ifw::ccf::common::Config & ifw::ccf::common::GetCfg ( )

inline

Return reference to the singleton instance of the configuration.

◆ GetHostAddress()

std::string ifw::ccf::common::GetHostAddress ( )

Find the host IP address to send frames back to. This uses the getifaddrs() function to get all network interfaces of the local system, and loops through them until the first IP4 interface which has the flag IFF_UP but NOT the flag IFF_LOOPBACK (ie localhost)

◆ GetHostAddress_()

std::string ifw::ccf::common::GetHostAddress_ ( )

◆ GetImageDir()

std::string ifw::ccf::common::GetImageDir ( )

Get the name of the image output folder.

◆ PackParameters()

std::string ifw::ccf::common::PackParameters ( const ifw::core::utils::param::ParameterSet & parameters )

Serialise the parameters contained in the parameter set.

◆ ParToIfwDataType()

ifw::fnd::datatype::DataType ifw::ccf::common::ParToIfwDataType ( const std::string & par )

Attempt to determine the native type of the parameter contained in the parameter object.

◆ PrepCplImage()

void ifw::ccf::common::PrepCplImage	(	const ifw::ccf::common::DataFrame &	frame,
		cpl_image **	image,
		ifw::fnd::datatype::DataType *	target_data_type,
		uint32_t *	target_buffer_size )

Create a CPL Image object from the image contained in the CCF Frame Object. As CPL only support int32, float and double, other pixel data types will be converted. Note: The user must perform a "cpl_image_delete()" on the allocated CPL Image object.

◆ StrParToDataType()

ifw::fnd::datatype::DataType ifw::ccf::common::StrParToDataType ( const std::string & par_name )

◆ UnpackParameters()

void ifw::ccf::common::UnpackParameters	(	const std::string &	parameters,
		ifw::core::utils::param::ParameterSet &	par_set )

Unpack the serialised parameters and store the information in the provided parameter set object.

Variable Documentation

◆ DB_NODE_ADAPTER

const std::string ifw::ccf::common::DB_NODE_ADAPTER = "adapter"

◆ DB_NODE_PUB_FILES_STORED

const std::string ifw::ccf::common::DB_NODE_PUB_FILES_STORED = "files_stored"

◆ DB_NODE_PUB_FRAMES_HANDLED

const std::string ifw::ccf::common::DB_NODE_PUB_FRAMES_HANDLED = "frames_handled"

◆ DB_NODE_PUB_ID

const std::string ifw::ccf::common::DB_NODE_PUB_ID = "id"

◆ DB_NODE_PUB_NAME

const std::string ifw::ccf::common::DB_NODE_PUB_NAME = "name"

◆ DB_NODE_PUB_NB_OF_FILES_STORED

const std::string ifw::ccf::common::DB_NODE_PUB_NB_OF_FILES_STORED = "nb_of_files_stored"

◆ DB_NODE_PUB_START

const std::string ifw::ccf::common::DB_NODE_PUB_START = "start"

◆ DB_NODE_PUB_STATUS

const std::string ifw::ccf::common::DB_NODE_PUB_STATUS = "status"

◆ DB_NODE_PUB_VOLUME_HANDLED

const std::string ifw::ccf::common::DB_NODE_PUB_VOLUME_HANDLED = "volume_handled"

Namespaces

Classes

Enumerations

Functions

Variables