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

#include <comAdptBase.hpp>

Inheritance diagram for ifw::ccf::common::ComAdptBase:

Public Member Functions
	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 void	InitialiseUser ()

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

virtual void	CheckConnectionUser (bool &connected)

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

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

virtual double	GetTheoreticFrameRateUser ()

virtual void	ConnectUser ()

virtual void	DisconnectUser ()

virtual bool	IsConnectedUser () const

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

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

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

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

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

virtual void	StartUser ()

virtual void	StopUser ()

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

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

virtual void	HandleSetupUser ()

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

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

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

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

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.

Protected Member Functions
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
bool	m_is_connected

AcqTrigger	m_acq_trigger

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

Detailed Description

Class to be used as parent for CCF Communication Adapters.

The adapter shall be used as parent class when implementing specific adapters. Methods to be provided by the specific implemented, have a name of the form "<action>User". Note, it may not be necessary to implement all 'user'/virtual methods.

Constructor & Destructor Documentation

◆ ComAdptBase()

ifw::ccf::common::ComAdptBase::ComAdptBase ( )

◆ ~ComAdptBase()

ifw::ccf::common::ComAdptBase::~ComAdptBase ( )

virtual

Member Function Documentation

◆ AddMetaDataUser()

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

virtual

Can be implmented to add additional meta-data, e.g. FITS keys, which should be written to the generated output data products.

◆ AdjustExpoTimeFrameRate()

void ifw::ccf::common::ComAdptBase::AdjustExpoTimeFrameRate ( )

protectedvirtual

◆ AutoConnect()

void ifw::ccf::common::ComAdptBase::AutoConnect	(	const uint8_t	attempts = 5,
		const double	timeout = 10 )

Check if a connection is established and is working. If yes, do nothing, else attempt to create it.

◆ CheckConnection()

void ifw::ccf::common::ComAdptBase::CheckConnection ( bool & connected )

Check if the connection to the device is OK.

◆ CheckConnectionUser()

void ifw::ccf::common::ComAdptBase::CheckConnectionUser ( bool & connected )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ CheckIfConnected()

void ifw::ccf::common::ComAdptBase::CheckIfConnected ( ) const

Check if the connection is established. If not, throw an exception.

◆ CheckStatus()

void ifw::ccf::common::ComAdptBase::CheckStatus	(	ifw::ccf::HwStatus &	status,
		std::string &	message )

Check the status of the device (health status).

◆ CheckStatusUser()

void ifw::ccf::common::ComAdptBase::CheckStatusUser	(	ifw::ccf::HwStatus &	status,
		std::string &	message )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ Connect()

void ifw::ccf::common::ComAdptBase::Connect ( )

◆ ConnectUser()

void ifw::ccf::common::ComAdptBase::ConnectUser ( )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, ifw::ccf::protocols::envision::ComAdptEnvision, and ifw::ccf::protocols::rtms::ComAdptRtms.

◆ Disconnect()

void ifw::ccf::common::ComAdptBase::Disconnect ( )

Disconnect from the device.

◆ DisconnectUser()

void ifw::ccf::common::ComAdptBase::DisconnectUser ( )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, ifw::ccf::protocols::envision::ComAdptEnvision, and ifw::ccf::protocols::rtms::ComAdptRtms.

◆ GetAcqTrigger()

AcqTrigger & ifw::ccf::common::ComAdptBase::GetAcqTrigger ( )

◆ GetAcqTriggerType()

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

◆ GetAllowLostFrames()

bool ifw::ccf::common::ComAdptBase::GetAllowLostFrames ( ) const

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

◆ GetDeviceAddress()

const std::string & ifw::ccf::common::ComAdptBase::GetDeviceAddress ( ) const

Return the address from the configuration.

◆ GetDeviceHeight()

const int16_t ifw::ccf::common::ComAdptBase::GetDeviceHeight ( ) const

Return the height of the data array from the configuration.

◆ GetDeviceProperty()

template<class TYPE >

TYPE ifw::ccf::common::ComAdptBase::GetDeviceProperty ( const std::string & property )

inline

Retrieve a property of the device, e.g. the width of the detector chip. If not available from the device, it is taken from the configuration.

◆ GetDeviceResolution()

const int8_t ifw::ccf::common::ComAdptBase::GetDeviceResolution ( ) const

Return the resolution of the data elements from the configuration.

◆ GetDeviceWidth()

const int16_t ifw::ccf::common::ComAdptBase::GetDeviceWidth ( ) const

Return the width of the data array from the configuration.

◆ GetFrameCounter()

uint64_t ifw::ccf::common::ComAdptBase::GetFrameCounter ( ) const

Return the internal frame counter.

◆ GetHostAddress()

const std::string & ifw::ccf::common::ComAdptBase::GetHostAddress ( )

virtual

Return the address of the host (network interface) used for communicating with the device.

◆ GetId()

const std::string & ifw::ccf::common::ComAdptBase::GetId ( ) const

Get the ID of the associated device.

◆ GetIsSimAdapter()

bool ifw::ccf::common::ComAdptBase::GetIsSimAdapter ( ) const

Return the Simulation Adapter Flag.

◆ GetLostFramesCount()

uint64_t ifw::ccf::common::ComAdptBase::GetLostFramesCount ( ) const

Return the number of lost frames currently registered.

◆ GetMaxFrameRate()

double ifw::ccf::common::ComAdptBase::GetMaxFrameRate ( ) const

Get Maximim frame rate (Hz).

◆ GetNameMapping()

const NameMapping & ifw::ccf::common::ComAdptBase::GetNameMapping ( ) const

◆ GetProtocol()

const std::string & ifw::ccf::common::ComAdptBase::GetProtocol ( ) const

Return the communication protocol used.

◆ GetTheoreticFrameRate()

double ifw::ccf::common::ComAdptBase::GetTheoreticFrameRate ( )

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

◆ GetTheoreticFrameRateUser()

double ifw::ccf::common::ComAdptBase::GetTheoreticFrameRateUser ( )

virtual

Specific implementation of the algorithm to estimate the theoretic frame rate. Need normally not to be provided for specific Communication Adapters. See also "GetTheoreticFrameRate()".

Reimplemented in ifw::ccf::protocols::aravis::ComAdptAravis.

◆ GetTimeForLastFrame()

double ifw::ccf::common::ComAdptBase::GetTimeForLastFrame ( ) const

◆ HandleParPostRead()

void ifw::ccf::common::ComAdptBase::HandleParPostRead ( ifw::core::utils::param::Parameter & par )

Invoked before reading a parameter from the device, in case speciel handling is needed.

◆ HandleParPostReadUser()

void ifw::ccf::common::ComAdptBase::HandleParPostReadUser ( ifw::core::utils::param::Parameter & par )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ HandleParPostWrite()

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

Invoked after writing to the device in case additional processing and downloading of parameters is needed.

◆ HandleParPostWriteUser()

void ifw::ccf::common::ComAdptBase::HandleParPostWriteUser ( ifw::core::utils::param::Parameter & par )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ HandleParPreWrite()

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

Invoked before writing a parameter to the device if specific handling is required, e.g. converting the value to the device representation.

◆ HandleParPreWriteUser()

void ifw::ccf::common::ComAdptBase::HandleParPreWriteUser ( ifw::core::utils::param::Parameter & par )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ HandleSetup()

void ifw::ccf::common::ComAdptBase::HandleSetup ( )

Method invoked to handle set up parameters to be written to the device. Is invoked when a Setup Request is received.

◆ HandleSetupUser()

void ifw::ccf::common::ComAdptBase::HandleSetupUser ( )

virtual

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

Reimplemented in ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ HasDeviceProperty()

bool ifw::ccf::common::ComAdptBase::HasDeviceProperty	(	const std::string &	property,
		std::string &	value )

Check if a given device property is defined, e.g. the width or height of the chip. Returns true if property exists and sets the value (as a string) in the "value" parameter. It is checked as follows for the given property:

Invoke user provided method to retrieve/generate property.
Check if defined in the device namespace, by invoking the <adapter>.Scan() method.
Check if defined as a source/device property.

Ignore and try to get the value from the cfg.

◆ HasDevicePropertyUser()

bool ifw::ccf::common::ComAdptBase::HasDevicePropertyUser	(	const std::string &	property,
		std::string &	value )

virtual

Specific implementation of the algorithm to check for a specific device property. Need normally not to be provided for specific Communication Adapters. See also "HasDeviceProperty()".

◆ HasNameMapping()

bool ifw::ccf::common::ComAdptBase::HasNameMapping ( const std::string & name ) const

Return true if a mapping is defined in the Device Name Mapping for the given name.

◆ IncLostFramesCount()

uint64_t ifw::ccf::common::ComAdptBase::IncLostFramesCount ( )

Increment the counter of lost frames. The new value is returned.

◆ Initialise()

void ifw::ccf::common::ComAdptBase::Initialise ( const bool re_init = false )

Method encapsulating the user specific implementations. The method is invoked when the object is instantiated.

◆ InitialiseUser()

void ifw::ccf::common::ComAdptBase::InitialiseUser ( )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, ifw::ccf::protocols::envision::ComAdptEnvision, ifw::ccf::protocols::rtms::ComAdptRtms, and ifw::ccf::protocols::rtms_llnetio::ComAdptRtms.

◆ IsConnected()

bool ifw::ccf::common::ComAdptBase::IsConnected ( ) const

Returns true if the connection to the device is established and valid.

◆ IsConnectedUser()

bool ifw::ccf::common::ComAdptBase::IsConnectedUser ( ) const

virtual

Specific implementation of the algorithm to determine if a connection to the device is established. See also "IsConnected()".

Reimplemented in ifw::ccf::common::test::ComAdptTest, and ifw::ccf::protocols::aravis::ComAdptAravis.

◆ MapParForDevice()

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

Map the parameter to the device name, applying the Device Name Mapping. If the parameter is not defined, the mapped parameter will be the same as the internal parameter.

◆ MapParFromDevice()

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

Map a parameter name, received from the device, applying the Device Name Mapping. If the parameter is not defined, the mapped parameter will be the same as the internal parameter.

◆ Read() [1/4]

std::string ifw::ccf::common::ComAdptBase::Read ( const std::string & name )

Read a parameter from the device and return it. The name may be mapped from the device to the internal level representation, if defined in the Device Name Mapping.

◆ Read() [2/4]

template<class TYPE >

TYPE ifw::ccf::common::ComAdptBase::Read ( const std::string & name )

inline

Template method to read a parameter, taking care of the conversion to the desired user representation.

◆ Read() [3/4]

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

Read a parameter from the device. The name may be mapped from the device to the internal level representation, if defined in the Device Name Mapping.

◆ Read() [4/4]

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

Read a set of parametera from the device. The names may be mapped from the device to the internal level representation, if defined in the Device Name Mapping.

◆ ReadMutableSetupPars()

void ifw::ccf::common::ComAdptBase::ReadMutableSetupPars ( )

Read setup parameters from the camera device, which may mutate.

◆ ReadUser() [1/2]

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

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ ReadUser() [2/2]

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

virtual

Specific implementation of the algorithm to read multiple parameters from the device. Need normally not to be provided for specific Communication Adapters. See also "Read(multiple)".

◆ Receive()

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

Method to receive a frame from the device. Only entire frames are handled. See also "ReceiveUser()".

Parameters

[out]	frame	Frame object, which will contain the frames, if one received.
[out]	frame_received	Indicates if a frame was received.
[in]	timeout	Timeout in seconds to apply, waiting for the next frame.
[out]	timed_out	Indicates if the request for a frame timed out.

◆ ReceiveUser()

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

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, ifw::ccf::protocols::envision::ComAdptEnvision, ifw::ccf::protocols::rtms::ComAdptRtms, and ifw::ccf::protocols::rtms_llnetio::ComAdptRtms.

◆ ResetLostFramesCount()

void ifw::ccf::common::ComAdptBase::ResetLostFramesCount ( )

Reset the lost frames counter.

◆ Scan()

void ifw::ccf::common::ComAdptBase::Scan ( std::vector< ifw::core::utils::param::Parameter > & pars )

Scan the address of the associated device and store the parameters in the vector.

◆ ScanUser()

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

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ SetAcqTrigger()

void ifw::ccf::common::ComAdptBase::SetAcqTrigger ( const AcqTrigger & acq_trigger )

virtual

◆ SetAcqTriggerUser()

void ifw::ccf::common::ComAdptBase::SetAcqTriggerUser ( )

virtual

Specific implementation of the algorithm to trigger an acquisition.

◆ SetDeviceAddress()

void ifw::ccf::common::ComAdptBase::SetDeviceAddress ( const std::string & address )

Set the internal address, e.g. URI, used for communicating with the device.

◆ SetDeviceAddressUser()

void ifw::ccf::common::ComAdptBase::SetDeviceAddressUser ( const std::string & address )

virtual

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

Reimplemented in ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ SetHostAdddress()

void ifw::ccf::common::ComAdptBase::SetHostAdddress ( const std::string & host_address )

Set the address of the host (network interface) used for communication.

◆ SetIsConnected()

void ifw::ccf::common::ComAdptBase::SetIsConnected ( const bool connected )

Method by which derived adapters can force the status to connected or not connected. To be used with care!

◆ SetIsSimAdapter()

void ifw::ccf::common::ComAdptBase::SetIsSimAdapter ( const bool is_sim )

Set the Simulation Adapter Flag.

◆ SetLostFramesCount()

void ifw::ccf::common::ComAdptBase::SetLostFramesCount ( const int64_t count )

◆ Start()

void ifw::ccf::common::ComAdptBase::Start ( )

Start the image acquisition in the device.

◆ StartUser()

void ifw::ccf::common::ComAdptBase::StartUser ( )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, ifw::ccf::protocols::envision::ComAdptEnvision, ifw::ccf::protocols::rtms::ComAdptRtms, and ifw::ccf::protocols::rtms_llnetio::ComAdptRtms.

◆ Stop()

void ifw::ccf::common::ComAdptBase::Stop ( )

Stop the image acquisition in the device.

◆ StopUser()

void ifw::ccf::common::ComAdptBase::StopUser ( )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, ifw::ccf::protocols::envision::ComAdptEnvision, ifw::ccf::protocols::rtms::ComAdptRtms, and ifw::ccf::protocols::rtms_llnetio::ComAdptRtms.

◆ Write() [1/3]

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

Write a parameter to the device. The name may be mapped from the internal to the device representation, if defined in the Device Name Mapping.

◆ Write() [2/3]

template<class TYPE >

void ifw::ccf::common::ComAdptBase::Write	(	const std::string &	name,
		const TYPE &	value )

inline

Template method to write a parameter, taking care of converting the user data into the internal type.

◆ Write() [3/3]

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

Write a set of parameters to the device. The name may be mapped from the internal to the device representation, if defined in the Device Name Mapping.

◆ WriteDefaultSetup()

void ifw::ccf::common::ComAdptBase::WriteDefaultSetup ( )

Write the default (init) setup to the device. The Communication Adapter is in charge of deciding which parameters to use.

◆ WriteDefaultSetupUser()

void ifw::ccf::common::ComAdptBase::WriteDefaultSetupUser ( )

virtual

Write the default (init) setup to the device. The Communication Adapter is in charge of deciding which parameters to use.

◆ WriteDeviceProps()

void ifw::ccf::common::ComAdptBase::WriteDeviceProps ( )

Write the Device Properties to the adapter (device). Only the Device Properties defined in the Device Name Mapping will be written to the device.

◆ WriteDevicePropsUser()

void ifw::ccf::common::ComAdptBase::WriteDevicePropsUser ( )

virtual

Write the device properties to the adapter (device). Default implementation: Only properties defined in the Device Name Mapping are written to the adapter/device Specific implementation.

◆ WriteUser() [1/2]

void ifw::ccf::common::ComAdptBase::WriteUser ( const ifw::core::utils::param::Parameter & par )

virtual

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

Reimplemented in ifw::ccf::common::test::ComAdptTest, ifw::ccf::protocols::envision_llnetio::ComAdptEnvision, ifw::ccf::control::ComAdptSim, ifw::ccf::protocols::aravis::ComAdptAravis, and ifw::ccf::protocols::envision::ComAdptEnvision.

◆ WriteUser() [2/2]

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

virtual

Specific implementation of the algorithm to write a set of parameters to the device. Need normally not to be provided for specific Communication Adapters. See also "Write(multiple)".

Member Data Documentation

◆ m_acq_trigger

AcqTrigger ifw::ccf::common::ComAdptBase::m_acq_trigger

protected

◆ m_is_connected

bool ifw::ccf::common::ComAdptBase::m_is_connected

protected

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

common/src/include/ifw/ccf/common/comAdptBase.hpp
common/src/comAdptBase.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ComAdptBase()

◆ ~ComAdptBase()

Member Function Documentation

◆ AddMetaDataUser()

◆ AdjustExpoTimeFrameRate()

◆ AutoConnect()

◆ CheckConnection()

◆ CheckConnectionUser()

◆ CheckIfConnected()

◆ CheckStatus()

◆ CheckStatusUser()

◆ Connect()

◆ ConnectUser()

◆ Disconnect()

◆ DisconnectUser()

◆ GetAcqTrigger()

◆ GetAcqTriggerType()

◆ GetAllowLostFrames()

◆ GetDeviceAddress()

◆ GetDeviceHeight()

◆ GetDeviceProperty()

◆ GetDeviceResolution()

◆ GetDeviceWidth()

◆ GetFrameCounter()

◆ GetHostAddress()

◆ GetId()

◆ GetIsSimAdapter()

◆ GetLostFramesCount()

◆ GetMaxFrameRate()

◆ GetNameMapping()

◆ GetProtocol()

◆ GetTheoreticFrameRate()

◆ GetTheoreticFrameRateUser()

◆ GetTimeForLastFrame()

◆ HandleParPostRead()

◆ HandleParPostReadUser()

◆ HandleParPostWrite()

◆ HandleParPostWriteUser()

◆ HandleParPreWrite()

◆ HandleParPreWriteUser()

◆ HandleSetup()

◆ HandleSetupUser()

◆ HasDeviceProperty()

◆ HasDevicePropertyUser()

◆ HasNameMapping()

◆ IncLostFramesCount()

◆ Initialise()

◆ InitialiseUser()

◆ IsConnected()

◆ IsConnectedUser()

◆ MapParForDevice()

◆ MapParFromDevice()

◆ Read() [1/4]

◆ Read() [2/4]

◆ Read() [3/4]

◆ Read() [4/4]

◆ ReadMutableSetupPars()

◆ ReadUser() [1/2]

◆ ReadUser() [2/2]

◆ Receive()

◆ ReceiveUser()

◆ ResetLostFramesCount()

◆ Scan()

◆ ScanUser()

◆ SetAcqTrigger()

◆ SetAcqTriggerUser()

◆ SetDeviceAddress()

◆ SetDeviceAddressUser()

◆ SetHostAdddress()

◆ SetIsConnected()

◆ SetIsSimAdapter()

◆ SetLostFramesCount()

◆ Start()

◆ StartUser()