DataRecord Struct Reference

#include <gclib.hpp>

Classes
struct	Amp
	Holds amplifier-specific data record fields. Provided by DataRecord.amp(). More...
struct	Axis
	Holds axis-specific data record fields. Provided by DataRecord.axis(). More...
struct	CoordinatedMove
	Holds coordinated move specific data record fields. Provided by DataRecord.coordinated_move(). More...

Public Types
enum	EthernetStatus {   HandleFree = HANDLE_FREE ,   UdpSlave = UDP_SLAVE ,   TcpSlave = TCP_SLAVE ,   UdpMaster = UDP_MASTER ,   TcpMaster = TCP_MASTER ,   EstablishingUdp = ESTABLISHING_UDP ,   EstablishingTcp = ESTABLISHING_TCP }

Public Member Functions
	DataRecord (gclib_data_record_handle h)
uint16_t	sample ()
bool	input (size_t index)
bool	output (size_t index)
std::bitset< 8 >	input_bank (size_t index)
std::bitset< 8 >	output_bank (size_t index)
uint8_t	error_code ()
uint32_t	contour_segment_count ()
uint16_t	contour_buffer_available ()
bool	thread_running (size_t thread)
EthernetStatus	ethernet_status (char handle)
std::vector< uint8_t >	bytes ()
	Get data record as raw bytes.
Amp	amp (size_t amp)
	Get an instance of DataRecord.Amp, which provides amplifier-specific data record fields.
Axis	axis (char axis)
	Get an instance of DataRecord.Axis, which provides axis-specific data record fields.
CoordinatedMove	coordinated_move (char plane)
	Get an instance of DataRecord.CoordinatedMove, which provides CM-specific data record fields.

Detailed Description

Definition at line 115 of file gclib.hpp.

Member Enumeration Documentation

EthernetStatus

enum EthernetStatus

Enumerator
HandleFree
UdpSlave
TcpSlave
UdpMaster
TcpMaster
EstablishingUdp
EstablishingTcp

Definition at line 117 of file gclib.hpp.

Constructor & Destructor Documentation

DataRecord()

DataRecord ( gclib_data_record_handle h )

inline

Definition at line 116 of file gclib.hpp.

Member Function Documentation

sample()

uint16_t sample ( )

inline

Definition at line 200 of file gclib.hpp.

input()

bool input ( size_t index )

inline

Note

Inputs are active low, meaning this function returns true if current is NOT flowing.

Parameters

index

The index of the input to check. Note that index 0 corresponds to @IN[1].

Returns

true if input is active.

Definition at line 208 of file gclib.hpp.

output()

bool output ( size_t index )

inline

Parameters

index

The index of the output to check. Note that index 0 corresponds to @OUT[1].

Returns

true if output is active.

Definition at line 213 of file gclib.hpp.

input_bank()

std::bitset< 8 > input_bank ( size_t index )

inline

Definition at line 214 of file gclib.hpp.

output_bank()

std::bitset< 8 > output_bank ( size_t index )

inline

Definition at line 215 of file gclib.hpp.

error_code()

uint8_t error_code ( )

inline

Definition at line 216 of file gclib.hpp.

contour_segment_count()

uint32_t contour_segment_count ( )

inline

Definition at line 217 of file gclib.hpp.

contour_buffer_available()

uint16_t contour_buffer_available ( )

inline

Definition at line 218 of file gclib.hpp.

thread_running()

bool thread_running ( size_t thread )

inline

Definition at line 219 of file gclib.hpp.

ethernet_status()

EthernetStatus ethernet_status ( char handle )

inline

Parameters

handle

The ethernet handle to check, A - H.

Definition at line 223 of file gclib.hpp.

bytes()

std::vector< uint8_t > bytes ( )

inline

Get data record as raw bytes.

Useful if your device has a nonstandard data record.

Definition at line 229 of file gclib.hpp.

amp()

Amp amp ( size_t amp )

inline

Get an instance of DataRecord.Amp, which provides amplifier-specific data record fields.

Definition at line 234 of file gclib.hpp.

axis()

Axis axis ( char axis )

inline

Get an instance of DataRecord.Axis, which provides axis-specific data record fields.

Definition at line 235 of file gclib.hpp.

coordinated_move()

CoordinatedMove coordinated_move ( char plane )

inline

Get an instance of DataRecord.CoordinatedMove, which provides CM-specific data record fields.

Definition at line 236 of file gclib.hpp.

---

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

• gclib.hpp