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

Description

Represents a data message containing a set of range data.

Note
Supported with G1
Inheritance diagram for GoRangeMsg:
Inheritance graph

Public Member Functions

k32s GoDataMsg_ArrayedCount (GoDataMsg message)
 Gets the count of the data messages (in an arrayed context). More...
 
k32s GoDataMsg_ArrayedIndex (GoDataMsg message)
 Gets the index of the data message (in an arrayed context). More...
 
kStatus GoDataMsg_SetArrayedCount (GoDataMsg message, k32s arrayedCount)
 Sets the count of the data messages (in an arrayed context). More...
 
kStatus GoDataMsg_SetArrayedIndex (GoDataMsg message, k32s arrayedIndex)
 Sets the index of the data message (in an arrayed context). More...
 
kStatus GoDataMsg_SetStreamStep (GoDataMsg message, GoDataStep streamStep)
 Sets the source of the data stream. More...
 
kStatus GoDataMsg_SetStreamStepId (GoDataMsg message, k32s streamStepId)
 Sets the identifier of the data stream from the source. More...
 
GoDataStep GoDataMsg_StreamStep (GoDataMsg message)
 Gets the source of the data stream. More...
 
k32s GoDataMsg_StreamStepId (GoDataMsg message)
 Gets the identifier of the data stream from the source. More...
 
GoDataMessageType GoDataMsg_Type (GoDataMsg message)
 Returns the message type for a data channel message given in a GoDataSet. More...
 
k16sGoRangeMsg_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...
 

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