horiba::communication::Communicator Class Reference

Interface representing a communication channel with the ICL. More...

#include <communicator.h>

Inheritance diagram for horiba::communication::Communicator:

Public Member Functions
virtual	~Communicator ()=default
virtual void	open ()=0
	Opens the communication channel with the ICL.
virtual void	close ()=0
	Closes the communication channel with the ICL.
virtual bool	is_open ()=0
	Checks if the communication channel is open or not.
virtual Response	request_with_response (const Command &command)=0
	Sends a command to the ICL and returns the response.

Detailed Description

Interface representing a communication channel with the ICL.

Constructor & Destructor Documentation

~Communicator()

virtual horiba::communication::Communicator::~Communicator ( )

virtualdefault

Member Function Documentation

close()

virtual void horiba::communication::Communicator::close ( )

pure virtual

Closes the communication channel with the ICL.

Implemented in horiba::communication::WebSocketCommunicator.

is_open()

virtual bool horiba::communication::Communicator::is_open ( )

pure virtual

Checks if the communication channel is open or not.

Returns

True if the communication channel is open, false otherwise

Implemented in horiba::communication::WebSocketCommunicator.

open()

virtual void horiba::communication::Communicator::open ( )

pure virtual

Opens the communication channel with the ICL.

Implemented in horiba::communication::WebSocketCommunicator.

request_with_response()

virtual Response horiba::communication::Communicator::request_with_response ( const Command & command )

pure virtual

Sends a command to the ICL and returns the response.

Parameters

command

The command for the ICL

Returns

The response from the ICL

Implemented in horiba::communication::WebSocketCommunicator.

---

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

• /Users/runner/work/cpp-sdk/cpp-sdk/include/horiba_cpp_sdk/communication/communicator.h