GoPxL SDK
GoPxLSdk::GoSystem Class Reference

Description

Represents a single Gocator system.

A Gocator system may have multiple sensors/devices.

Public Types

enum  State { State::Ready, State::Running, State::Conflict }
 

Public Member Functions

kIpAddress Address () const
 Gets the ipAddress used in Connect(). More...
 
GoRestClientClient ()
 Returns a reference to the client. More...
 
void Connect ()
 Connects to a system. More...
 
k32u ControlPort () const
 Gets the port used in Connect(). More...
 
void Disconnect ()
 Disconnects from a system. More...
 
 GoSystem ()=default
 GoSystem default constructor. More...
 
 GoSystem (const kIpAddress &address, k16u port=GO_PXL_SDK_DEFAULT_CONTROL_PORT)
 Constructs a GoSystem object with the given IP address and control port number. More...
 
bool IsConnected ()
 Checks if the system is connected or not. More...
 
State RunningState ()
 Gets the system's current state. More...
 
ResourcePath SensorPath (SerialNum serialNum)
 Given a sensor's serial number, returns its resource path. More...
 
void SetAddress (const kIpAddress &ipAddress)
 Sets the ipAddress used in Connect(). More...
 
void SetControlPort (k16u port)
 Sets the port used in Connect(). More...
 
void Start ()
 Starts the device. More...
 
void Stop ()
 Stops the device. More...
 
 ~GoSystem ()=default
 GoSystem destructor. More...
 

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