camcom::common::TestAdapter Class Reference

Inheritance diagram for camcom::common::TestAdapter:

Public Member Functions
std::map< std::string, Parameter >	Connect () override
void	Disconnect () override
CheckResult	CheckConnection () const override
bool	IsConnected () const override
std::string	GetProtocol () const override
	Get the protocol name used by this adapter.
BasicParams	GetBasicParams () const override
	Get basic camera parameters in standardized units. Adapters read their native parameters and convert to common units.
void	ReceiveFrame (bool &, uint64_t, std::span< uint8_t > &, FrameInfo &) override
Parameter	Read (const std::string &) override
	Read a single parameter from the camera.
std::vector< Parameter >	Read (const std::vector< std::string > &) override
	Read multiple parameters from the camera.
void	Write (const Parameter &) override
	Write a single parameter to the camera.
void	Write (const std::vector< Parameter > &) override
	Write multiple parameters to the camera.
std::vector< Parameter >	Scan () override
	Scan all available parameters from the camera Re-scans the device parameter space, updates the namespace repository, and returns all discovered parameters.
AcquisitionState	GetAcquisitionState () const override
	Get the current acquisition state.
void	StartAcquisition (std::optional< int64_t >=std::nullopt) override
	Start frame acquisition.
void	StopAcquisition () override
	Stop frame acquisition.
Public Member Functions inherited from camcom::common::AdapterBase
	AdapterBase ()
virtual	~AdapterBase ()
virtual void	Initialise (const ReceiveCfg &cfg)
virtual NativeDocument	GetNativeParameterDocument () const
	Get native parameter document from camera (protocol-specific) For GenICam cameras, returns the XML register description. Default implementation returns empty NativeDocument (not supported).
void	SetAddress (const std::string &address)
	Set the camera address/URI for connection.
void	SetTimeout (double timeout_seconds)
	Set the connection timeout.

Additional Inherited Members
Static Public Member Functions inherited from camcom::common::AdapterBase
static std::string	ResolveAddress (const std::string &address, bool allow_device_id=false)
Protected Attributes inherited from camcom::common::AdapterBase
const std::chrono::duration< double_t >	m_connect_timeout {std::chrono::seconds(10)}
std::string	m_cam_address
std::chrono::duration< double_t >	m_timeout
bool	m_initialised {false}
std::chrono::time_point< std::chrono::system_clock >	m_time_last_stop {common::TimeNow()}
std::chrono::time_point< std::chrono::system_clock >	m_time_last_frame_recv {m_time_last_stop}
bool	m_waiting_for_frame {false}

Member Function Documentation

CheckConnection()

CheckResult camcom::common::TestAdapter::CheckConnection ( ) const

inlineoverridevirtual

Implements camcom::common::AdapterBase.

Connect()

std::map< std::string, Parameter > camcom::common::TestAdapter::Connect ( )

inlineoverridevirtual

Implements camcom::common::AdapterBase.

Disconnect()

void camcom::common::TestAdapter::Disconnect ( )

inlineoverridevirtual

Implements camcom::common::AdapterBase.

GetAcquisitionState()

AcquisitionState camcom::common::TestAdapter::GetAcquisitionState ( ) const

inlineoverridevirtual

Get the current acquisition state.

Returns

AcquisitionState with mode, remaining frames (if finite), and current FPS

Implements camcom::common::AdapterBase.

GetBasicParams()

BasicParams camcom::common::TestAdapter::GetBasicParams ( ) const

inlineoverridevirtual

Get basic camera parameters in standardized units. Adapters read their native parameters and convert to common units.

Returns

BasicParams struct with timing, geometry, and buffer info

Implements camcom::common::AdapterBase.

GetProtocol()

std::string camcom::common::TestAdapter::GetProtocol ( ) const

inlineoverridevirtual

Get the protocol name used by this adapter.

Returns

Protocol identifier string (e.g., "CamComSim", "GenICam", "CameraLink")

Implements camcom::common::AdapterBase.

IsConnected()

bool camcom::common::TestAdapter::IsConnected ( ) const

inlineoverridevirtual

Implements camcom::common::AdapterBase.

Read() [1/2]

Parameter camcom::common::TestAdapter::Read ( const std::string & name )

inlineoverridevirtual

Read a single parameter from the camera.

Parameters

name	Name of the parameter to read

Returns

Parameter object with current value from camera

Exceptions

std::runtime_error

if parameter not found or read fails

Implements camcom::common::AdapterBase.

Read() [2/2]

std::vector< Parameter > camcom::common::TestAdapter::Read ( const std::vector< std::string > & names )

inlineoverridevirtual

Read multiple parameters from the camera.

Parameters

names

Vector of parameter names to read

Returns

Vector of Parameter objects with current values from camera

Exceptions

std::runtime_error

if any parameter not found or read fails

Implements camcom::common::AdapterBase.

ReceiveFrame()

void camcom::common::TestAdapter::ReceiveFrame ( bool & , uint64_t , std::span< uint8_t > & , FrameInfo &  )

inlineoverridevirtual

Implements camcom::common::AdapterBase.

Scan()

std::vector< Parameter > camcom::common::TestAdapter::Scan ( )

inlineoverridevirtual

Scan all available parameters from the camera Re-scans the device parameter space, updates the namespace repository, and returns all discovered parameters.

Returns

Vector of all available parameters with current values

Implements camcom::common::AdapterBase.

StartAcquisition()

void camcom::common::TestAdapter::StartAcquisition ( std::optional< int64_t > frame_count = std::nullopt )

inlineoverridevirtual

Start frame acquisition.

Parameters

frame_count

Number of frames to acquire, or std::nullopt for continuous std::nullopt: Continuous mode (stream until StopAcquisition) value > 0: Finite mode (acquire exactly N frames then stop)

Implements camcom::common::AdapterBase.

StopAcquisition()

void camcom::common::TestAdapter::StopAcquisition ( )

inlineoverridevirtual

Stop frame acquisition.

Implements camcom::common::AdapterBase.

Write() [1/2]

void camcom::common::TestAdapter::Write ( const Parameter & parameter )

inlineoverridevirtual

Write a single parameter to the camera.

Parameters

parameter

Parameter object containing name, value, and type to write

Exceptions

std::runtime_error

if parameter not found or write fails

Implements camcom::common::AdapterBase.

Write() [2/2]

void camcom::common::TestAdapter::Write ( const std::vector< Parameter > & parameters )

inlineoverridevirtual

Write multiple parameters to the camera.

Parameters

parameters

Vector of Parameter objects to write

Exceptions

std::runtime_error

if any parameter not found or write fails

Implements camcom::common::AdapterBase.

---

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

• common/test/test_adapterBase.cpp