Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoRangeMsg Class Reference

Description

Represents a data message containing a set of range data.

Inherits kObject.

Public Member Functions

k16s * GoRangeMsg_At (GoRangeMsg msg, kSize index)
 Gets a pointer to Range data. More...
 
kSize GoRangeMsg_Count (GoRangeMsg msg)
 Gets the count of Range data in this message. More...
 
k32u GoRangeMsg_Exposure (GoRangeMsg msg)
 Gets the exposure. More...
 
GoDataSource GoRangeMsg_Source (GoRangeMsg msg)
 Gets the Range source. More...
 
k32s GoRangeMsg_ZOffset (GoRangeMsg msg)
 Gets the Range z-offset, in micrometers. More...
 
k32u GoRangeMsg_ZResolution (GoRangeMsg msg)
 Gets the Range z-resolution, in nanometers. More...
 

Member Function Documentation

k16s * GoRangeMsg_At ( GoRangeMsg  msg,
kSize  index 
)

Gets a pointer to Range data.

Parameters
msgMessage object.
indexRange array index.
Returns
Range pointer.
kSize GoRangeMsg_Count ( GoRangeMsg  msg)

Gets the count of Range data in this message.

Parameters
msgMessage object.
Returns
Count of Range data.
k32u GoRangeMsg_Exposure ( GoRangeMsg  msg)

Gets the exposure.

Parameters
msgMessage object.
Returns
Exposure in uS.
GoDataSource GoRangeMsg_Source ( GoRangeMsg  msg)

Gets the Range source.

Parameters
msgMessage object.
Returns
Range source.
k32s GoRangeMsg_ZOffset ( GoRangeMsg  msg)

Gets the Range z-offset, in micrometers.

Parameters
msgMessage object.
Returns
Z offset (um).
k32u GoRangeMsg_ZResolution ( GoRangeMsg  msg)

Gets the Range z-resolution, in nanometers.

Parameters
msgMessage object.
Returns
Z resolution (nm).

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