camcom 1.0.0-pre2
 
Loading...
Searching...
No Matches
camcom::server::MockAdapter Class Reference
Inheritance diagram for camcom::server::MockAdapter:
camcom::common::AdapterBase

Public Member Functions

 MockAdapter ()
 
std::map< std::string, common::ParameterConnect () override
 
void Disconnect () override
 
common::CheckResult CheckConnection () const override
 
bool IsConnected () const override
 
std::string GetProtocol () const override
 Get the protocol name used by this adapter.
 
common::BasicParams GetBasicParams () const override
 Get basic camera parameters in standardized units. Adapters read their native parameters and convert to common units.
 
void ReceiveFrame (bool &received_frame, uint64_t max_size, std::span< uint8_t > &data, common::FrameInfo &frame_info) override
 
common::Parameter Read (const std::string &name) override
 Read a single parameter from the camera.
 
std::vector< common::ParameterRead (const std::vector< std::string > &names) override
 Read multiple parameters from the camera.
 
void Write (const common::Parameter &param) override
 Write a single parameter to the camera.
 
void Write (const std::vector< common::Parameter > &params) override
 
std::vector< common::ParameterScan () override
 Scan all available parameters from the camera Re-scans the device parameter space, updates the namespace repository, and returns all discovered parameters.
 
common::AcquisitionState GetAcquisitionState () const override
 Get the current acquisition state.
 
void StartAcquisition (std::optional< int64_t > frame_count=std::nullopt) override
 Start frame acquisition.
 
void StopAcquisition () override
 Stop frame acquisition.
 
void addParam (const std::string &name, common::Parameter param)
 
bool is_connected () const
 
bool is_acquisition_running () const
 
const std::map< std::string, common::Parameter > & get_written_params () const
 
- Public Member Functions inherited from camcom::common::AdapterBase
 AdapterBase ()
 
virtual ~AdapterBase ()
 
virtual void Initialise (const ReceiveCfg &cfg)
 
virtual void Write (const std::vector< Parameter > &parameters)=0
 Write multiple parameters to the camera.
 
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}
 

Constructor & Destructor Documentation

◆ MockAdapter()

camcom::server::MockAdapter::MockAdapter ( )
inline

Member Function Documentation

◆ addParam()

void camcom::server::MockAdapter::addParam ( const std::string & name,
common::Parameter param )
inline

◆ CheckConnection()

common::CheckResult camcom::server::MockAdapter::CheckConnection ( ) const
inlineoverridevirtual

◆ Connect()

std::map< std::string, common::Parameter > camcom::server::MockAdapter::Connect ( )
inlineoverridevirtual

◆ Disconnect()

void camcom::server::MockAdapter::Disconnect ( )
inlineoverridevirtual

◆ get_written_params()

const std::map< std::string, common::Parameter > & camcom::server::MockAdapter::get_written_params ( ) const
inline

◆ GetAcquisitionState()

common::AcquisitionState camcom::server::MockAdapter::GetAcquisitionState ( ) const
inlineoverridevirtual

Get the current acquisition state.

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

Implements camcom::common::AdapterBase.

◆ GetBasicParams()

common::BasicParams camcom::server::MockAdapter::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::server::MockAdapter::GetProtocol ( ) const
inlineoverridevirtual

Get the protocol name used by this adapter.

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

Implements camcom::common::AdapterBase.

◆ is_acquisition_running()

bool camcom::server::MockAdapter::is_acquisition_running ( ) const
inline

◆ is_connected()

bool camcom::server::MockAdapter::is_connected ( ) const
inline

◆ IsConnected()

bool camcom::server::MockAdapter::IsConnected ( ) const
inlineoverridevirtual

◆ Read() [1/2]

common::Parameter camcom::server::MockAdapter::Read ( const std::string & name)
inlineoverridevirtual

Read a single parameter from the camera.

Parameters
nameName of the parameter to read
Returns
Parameter object with current value from camera
Exceptions
std::runtime_errorif parameter not found or read fails

Implements camcom::common::AdapterBase.

◆ Read() [2/2]

std::vector< common::Parameter > camcom::server::MockAdapter::Read ( const std::vector< std::string > & names)
inlineoverridevirtual

Read multiple parameters from the camera.

Parameters
namesVector of parameter names to read
Returns
Vector of Parameter objects with current values from camera
Exceptions
std::runtime_errorif any parameter not found or read fails

Implements camcom::common::AdapterBase.

◆ ReceiveFrame()

void camcom::server::MockAdapter::ReceiveFrame ( bool & received_frame,
uint64_t max_size,
std::span< uint8_t > & data,
common::FrameInfo & frame_info )
inlineoverridevirtual

◆ Scan()

std::vector< common::Parameter > camcom::server::MockAdapter::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::server::MockAdapter::StartAcquisition ( std::optional< int64_t > frame_count = std::nullopt)
inlineoverridevirtual

Start frame acquisition.

Parameters
frame_countNumber 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::server::MockAdapter::StopAcquisition ( )
inlineoverridevirtual

Stop frame acquisition.

Implements camcom::common::AdapterBase.

◆ Write() [1/2]

void camcom::server::MockAdapter::Write ( const common::Parameter & parameter)
inlineoverridevirtual

Write a single parameter to the camera.

Parameters
parameterParameter object containing name, value, and type to write
Exceptions
std::runtime_errorif parameter not found or write fails

Implements camcom::common::AdapterBase.

◆ Write() [2/2]

void camcom::server::MockAdapter::Write ( const std::vector< common::Parameter > & params)
inlineoverride

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