Class vicon_transformer::ViconReceiver

class ViconReceiver : public vicon_transformer::Receiver

Receive frames from a running Vicon system.

This assumes that a compatible Vicon software (e.g. Vicon Tracker) is set up and running on the specified host.

Public Functions

ViconReceiver(const std::string &host_name, const ViconReceiverConfig &config, std::shared_ptr<spdlog::logger> logger = nullptr)
Parameters:
  • host_name – Host name or IP address of the Vicon PC.

  • configReceiver configuration.

  • logger – A logger instance used for logging output. If not set, a logger with name “ViconReceiver” used.

~ViconReceiver()
bool is_connected() const

Check if connected to a Vicon server.

void connect()

Connect to the Vicon server on the specified host.

void disconnect()

Disconnect from the Vicon server.

void print_info() const

Print some info about the server configuration.

virtual ViconFrame read() override

Get a new frame from the Vicon system.

void print_latency_info() const

Print detailed latency information.

ViconReceiver(const std::string &host_name, const ViconReceiverConfig &config, std::shared_ptr<spdlog::logger> logger = nullptr)
Parameters:
  • host_name – Host name or IP address of the Vicon PC.

  • configReceiver configuration.

  • logger – A logger instance used for logging output. If not set, a logger with name “ViconReceiver” used.

~ViconReceiver()
bool is_connected() const

Check if connected to a Vicon server.

void connect()

Connect to the Vicon server on the specified host.

void disconnect()

Disconnect from the Vicon server.

void print_info() const

Print some info about the server configuration.

virtual ViconFrame read() override

Get a new frame from the Vicon system.

void print_latency_info() const

Print detailed latency information.