ccf::common Namespace Reference

Namespaces
	fits
	test

Classes
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...
struct	DeviceProperty
struct	DeviceInfo
class	Config
class	DataFrame
	Frame class used to store the data and metadata for one frames received from the camera. More...
class	InternalDb
	DB implementing the utils::bat::DbInterface; used for internal/test purposes. More...
class	Db
	Interface to the OLDB and Pub/Sub. More...
class	DcsClient
	Used to implement CCF Control client applications. More...
class	FrameQueue
	The FrameQueue class implements a queue, to manage a set of CCF DataFrame instances as a ring buffer. More...
class	NameMapping
	Implements a name mapping service, based on a Name Mapping File to be loaded and installed. More...
class	PublisherStatus
	Class used by a Publisher to handle its own publisher status. More...
class	PubBase
	Class for implementing CCF Data Publishers. 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...
class	FrameStatistics
	Class used by the threads to store info for generating performance statistics. More...

Functions
std::string	GetHostAddress_ ()
void	_CheckIfReqSupported (const std::string &request)
std::string	GetHostAddress ()
Config &	GetCfg ()
	Return reference to the singleton instance of the configuration. More...
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 ccf::common::DataFrame &frame, cpl_image **image, ccf::DataTypes *target_data_type, uint32_t *target_buffer_size)
Setup &	GetSetup ()
std::string	GetImageDir ()
	Get the name of the image output folder. More...
std::string	PackParameters (const core::utils::param::ParameterSet &parameters)
	Serialise the parameters contained in the parameter set. More...
void	UnpackParameters (const std::string &parameters, core::utils::param::ParameterSet &par_set)
	Unpacke the serialised parameters and store the information in the provided parameter set object. More...

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

Function Documentation

_CheckIfReqSupported()

void ccf::common::_CheckIfReqSupported

(

const std::string &

request

)

ConvertImage()

template<class SRC_IM_TYPE , class TRG_IM_TYPE >

void 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

GetCfg()

Config& ccf::common::GetCfg ( )

inline

Return reference to the singleton instance of the configuration.

GetHostAddress()

std::string 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 ccf::common::GetHostAddress_

(

)

GetImageDir()

std::string ccf::common::GetImageDir

(

)

Get the name of the image output folder.

GetSetup()

Setup& ccf::common::GetSetup ( )

inline

PackParameters()

std::string ccf::common::PackParameters

(

const core::utils::param::ParameterSet &

parameters

)

Serialise the parameters contained in the parameter set.

PrepCplImage()

void ccf::common::PrepCplImage	(	const ccf::common::DataFrame &	frame,
		cpl_image **	image,
		ccf::DataTypes *	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.

UnpackParameters()

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

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

Variable Documentation

DB_NODE_ADAPTER

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

DB_NODE_PUB_FILES_STORED

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

DB_NODE_PUB_FRAMES_HANDLED

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

DB_NODE_PUB_ID

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

DB_NODE_PUB_NAME

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

DB_NODE_PUB_NB_OF_FILES_STORED

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

DB_NODE_PUB_START

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

DB_NODE_PUB_STATUS

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

DB_NODE_PUB_VOLUME_HANDLED

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