Simulation Communication Adapter, implementing an in-application simulation. More...

#include <comAdptSim.hpp>

Inheritance diagram for ifw::ccf::control::ComAdptSim:

Public Member Functions
	ComAdptSim ()

virtual	~ComAdptSim ()

virtual void	InitialiseUser () override

virtual void	SetDeviceAddressUser (const std::string &address) override

virtual void	CheckConnectionUser (bool &connected) override

virtual void	CheckStatusUser (ifw::ccf::HwStatus &status, std::string &message) override

virtual void	ConnectUser () override

virtual void	DisconnectUser () override

virtual void	ReadUser (const std::string &name, ifw::core::utils::param::Parameter &par) override

virtual void	ReceiveUser (ifw::ccf::common::DataFrame &frame, bool &frame_received, const double timeout, bool &timed_out) override

virtual void	ScanUser (std::vector< ifw::core::utils::param::Parameter > &pars) override

virtual void	StartUser () override

virtual void	StopUser () override

virtual void	WriteUser (const ifw::core::utils::param::Parameter &par) override

virtual void	HandleSetupUser () override

virtual void	HandleParPreWriteUser (ifw::core::utils::param::Parameter &par) override

virtual void	HandleParPostWriteUser (ifw::core::utils::param::Parameter &par) override

virtual void	HandleParPostReadUser (ifw::core::utils::param::Parameter &par) override

Public Member Functions inherited from ifw::ccf::common::ComAdptBase
	ComAdptBase ()

virtual	~ComAdptBase ()

const std::string &	GetDeviceAddress () const
	Return the address from the configuration.

const int16_t	GetDeviceWidth () const
	Return the width of the data array from the configuration.

const int16_t	GetDeviceHeight () const
	Return the height of the data array from the configuration.

const int8_t	GetDeviceResolution () const
	Return the resolution of the data elements from the configuration.

const std::string &	GetId () const
	Get the ID of the associated device.

double	GetMaxFrameRate () const
	Get Maximim frame rate (Hz).

void	SetHostAdddress (const std::string &host_address)
	Set the address of the host (network interface) used for communication.

virtual const std::string &	GetHostAddress ()
	Return the address of the host (network interface) used for communicating with the device.

void	SetIsSimAdapter (const bool is_sim)
	Set the Simulation Adapter Flag.

bool	GetIsSimAdapter () const
	Return the Simulation Adapter Flag.

const std::string &	GetProtocol () const
	Return the communication protocol used.

template<class TYPE >
TYPE	GetDeviceProperty (const std::string &property)

bool	HasDeviceProperty (const std::string &property, std::string &value)

double	GetTheoreticFrameRate ()
	Render the theoritic, possible achievable frame rate (frame/s).

void	Initialise (const bool re_init=false)

void	SetDeviceAddress (const std::string &address)
	Set the internal address, e.g. URI, used for communicating with the device.

void	CheckConnection (bool &connected)
	Check if the connection to the device is OK.

void	CheckStatus (ifw::ccf::HwStatus &status, std::string &message)
	Check the status of the device (health status).

bool	IsConnected () const
	Returns true if the connection to the device is established and valid.

void	CheckIfConnected () const
	Check if the connection is established. If not, throw an exception.

void	Connect ()

void	AutoConnect (const uint8_t attempts=5, const double timeout=10)

void	Disconnect ()
	Disconnect from the device.

void	WriteDeviceProps ()

virtual void	WriteDevicePropsUser ()

void	WriteDefaultSetup ()

virtual void	WriteDefaultSetupUser ()

void	SetIsConnected (const bool connected)

bool	GetAllowLostFrames () const
	Return flag (cfg par) indicating if lost frames shall be ignored silently.

uint64_t	IncLostFramesCount ()
	Increment the counter of lost frames. The new value is returned.

void	SetLostFramesCount (const int64_t count)

uint64_t	GetLostFramesCount () const
	Return the number of lost frames currently registered.

uint64_t	GetFrameCounter () const
	Return the internal frame counter.

double	GetTimeForLastFrame () const

void	ResetLostFramesCount ()
	Reset the lost frames counter.

void	Read (const std::string &name, ifw::core::utils::param::Parameter &par)

void	Read (const std::vector< std::string > &names, std::vector< ifw::core::utils::param::Parameter > &pars)

std::string	Read (const std::string &name)

template<class TYPE >
TYPE	Read (const std::string &name)

void	Write (const ifw::core::utils::param::Parameter &par)

void	Write (const std::vector< ifw::core::utils::param::Parameter > &pars)

template<class TYPE >
void	Write (const std::string &name, const TYPE &value)

void	Receive (ifw::ccf::common::DataFrame &frame, bool &frame_received, const double timeout, bool &timed_out)

void	Scan (std::vector< ifw::core::utils::param::Parameter > &pars)
	Scan the address of the associated device and store the parameters in the vector.

void	Start ()
	Start the image acquisition in the device.

void	Stop ()
	Stop the image acquisition in the device.

void	HandleSetup ()

void	HandleParPreWrite (ifw::core::utils::param::Parameter &par)

void	HandleParPostWrite (ifw::core::utils::param::Parameter &par)

void	HandleParPostRead (ifw::core::utils::param::Parameter &par)
	Invoked before reading a parameter from the device, in case speciel handling is needed.

void	MapParForDevice (ifw::core::utils::param::Parameter &par) const

void	MapParFromDevice (ifw::core::utils::param::Parameter &par) const

bool	HasNameMapping (const std::string &name) const
	Return true if a mapping is defined in the Device Name Mapping for the given name.

virtual void	SetAcqTrigger (const AcqTrigger &acq_trigger)

AcqTrigger &	GetAcqTrigger ()

ifw::ccf::common::TriggerType	GetAcqTriggerType () const

virtual bool	HasDevicePropertyUser (const std::string &property, std::string &value)

virtual double	GetTheoreticFrameRateUser ()

virtual bool	IsConnectedUser () const

virtual void	ReadUser (const std::vector< std::string > &names, std::vector< ifw::core::utils::param::Parameter > &pars)

virtual void	AddMetaDataUser (ifw::ccf::common::DataFrame &frame)

virtual void	WriteUser (const std::vector< ifw::core::utils::param::Parameter > &pars)

void	ReadMutableSetupPars ()
	Read setup parameters from the camera device, which may mutate.

const NameMapping &	GetNameMapping () const

virtual void	SetAcqTriggerUser ()
	Specific implementation of the algorithm to trigger an acquisition.

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::common::ComAdptBase
virtual void	AdjustExpoTimeFrameRate ()

Protected Member Functions inherited from ifw::ccf::Base
void	SetClassName (const std::string &class_name)
	Set the name of the class in question.

Protected Attributes inherited from ifw::ccf::common::ComAdptBase
bool	m_is_connected

AcqTrigger	m_acq_trigger

Detailed Description

Simulation Communication Adapter, implementing an in-application simulation.

For now only file (FITS cube) based simulation is provided. For an explanation of the methods, consult ifw::ccf::common::ComAdptBase".

Constructor & Destructor Documentation

◆ ComAdptSim()

ifw::ccf::control::ComAdptSim::ComAdptSim ( )

◆ ~ComAdptSim()

ifw::ccf::control::ComAdptSim::~ComAdptSim ( )

virtual

Member Function Documentation

◆ CheckConnectionUser()

void ifw::ccf::control::ComAdptSim::CheckConnectionUser ( bool & connected )

overridevirtual

Specific implementation of the connection check algorithm. See also "CheckConnection()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ CheckStatusUser()

void ifw::ccf::control::ComAdptSim::CheckStatusUser	(	ifw::ccf::HwStatus &	status,
		std::string &	message )

overridevirtual

Specific implementation of the status check algorithm. See also "CheckStatus()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ ConnectUser()

void ifw::ccf::control::ComAdptSim::ConnectUser ( )

overridevirtual

Specific implementation of the connection algorithm to connect to the device. See also "Connect()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ DisconnectUser()

void ifw::ccf::control::ComAdptSim::DisconnectUser ( )

overridevirtual

Specific implementation of the algorithm to disconnect from the device. See also "Disconnect()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ HandleParPostReadUser()

void ifw::ccf::control::ComAdptSim::HandleParPostReadUser ( ifw::core::utils::param::Parameter & par )

overridevirtual

Specific implementation of the algorithm to process a parameter after reading it from the device. See also "HandleParPostRead()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ HandleParPostWriteUser()

void ifw::ccf::control::ComAdptSim::HandleParPostWriteUser ( ifw::core::utils::param::Parameter & par )

overridevirtual

Specific implementation of the parameter processing after this is written to the device. See also "HandleParPostWrite()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ HandleParPreWriteUser()

void ifw::ccf::control::ComAdptSim::HandleParPreWriteUser ( ifw::core::utils::param::Parameter & par )

overridevirtual

Specific implementation of the parameter processing before this is written to the device. See also "HandleParPreWrite()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ HandleSetupUser()

void ifw::ccf::control::ComAdptSim::HandleSetupUser ( )

overridevirtual

Specific implementation of the handling of new setup parameters. See also "HandleSetup()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ InitialiseUser()

void ifw::ccf::control::ComAdptSim::InitialiseUser ( )

overridevirtual

Specific implementation of the adapter/device initialisation. See also "Initialise()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ ReadUser()

void ifw::ccf::control::ComAdptSim::ReadUser	(	const std::string &	name,
		ifw::core::utils::param::Parameter &	par )

overridevirtual

Specific implementation of the reading of single parameter from the device. See also "Read(single)".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ ReceiveUser()

void ifw::ccf::control::ComAdptSim::ReceiveUser	(	ifw::ccf::common::DataFrame &	frame,
		bool &	frame_received,
		const double	timeout,
		bool &	timed_out )

overridevirtual

Specific implementation of the frame reception. See also "Receive()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ ScanUser()

void ifw::ccf::control::ComAdptSim::ScanUser ( std::vector< ifw::core::utils::param::Parameter > & pars )

overridevirtual

Specific implementation of the scanning of the defined parameters in the device namespace. See also "Scan()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ SetDeviceAddressUser()

void ifw::ccf::control::ComAdptSim::SetDeviceAddressUser ( const std::string & address )

overridevirtual

Specific implementation of the handling of the device addresss/URI. See also "SetDeviceAddress()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ StartUser()

void ifw::ccf::control::ComAdptSim::StartUser ( )

overridevirtual

Specific implementation of the algorithm to start the image acquisition in the device. See also "Start()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ StopUser()

void ifw::ccf::control::ComAdptSim::StopUser ( )

overridevirtual

Specific implementation of the algorithm to stop the image acquisition in the device. See also "Stop()".

Reimplemented from ifw::ccf::common::ComAdptBase.

◆ WriteUser()

void ifw::ccf::control::ComAdptSim::WriteUser ( const ifw::core::utils::param::Parameter & par )

overridevirtual

Specific implementation of the algorithm to write single parameters to the device. See also "Write(single)".

Reimplemented from ifw::ccf::common::ComAdptBase.

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

control/src/include/ifw/ccf/control/comAdptSim.hpp
control/src/comAdptSim.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ComAdptSim()

◆ ~ComAdptSim()

Member Function Documentation

◆ CheckConnectionUser()

◆ CheckStatusUser()

◆ ConnectUser()

◆ DisconnectUser()

◆ HandleParPostReadUser()

◆ HandleParPostWriteUser()

◆ HandleParPreWriteUser()

◆ HandleSetupUser()

◆ InitialiseUser()

◆ ReadUser()

◆ ReceiveUser()

◆ ScanUser()

◆ SetDeviceAddressUser()

◆ StartUser()

◆ StopUser()

◆ WriteUser()