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

Description

Represents a data message containing a set of resampled profile arrays.

Inherits kObject.

Public Member Functions

k16s * GoResampledProfileMsg_At (GoResampledProfileMsg msg, kSize index)
 Gets a pointer to a resampled profile array. More...
 
kSize GoResampledProfileMsg_Count (GoResampledProfileMsg msg)
 Gets the count of resampled profile arrays in this message. More...
 
k32u GoResampledProfileMsg_Exposure (GoResampledProfileMsg msg)
 Gets the exposure. More...
 
GoDataSource GoResampledProfileMsg_Source (GoResampledProfileMsg msg)
 Gets the profile source. More...
 
kSize GoResampledProfileMsg_Width (GoResampledProfileMsg msg)
 Gets the count of points in each resampled profile array. More...
 
k32s GoResampledProfileMsg_XOffset (GoResampledProfileMsg msg)
 Gets the profile x-offset, in micrometers. More...
 
k32u GoResampledProfileMsg_XResolution (GoResampledProfileMsg msg)
 Gets the x-resolution, in nanometers. More...
 
k32s GoResampledProfileMsg_ZOffset (GoResampledProfileMsg msg)
 Gets the profile z-offset, in micrometers. More...
 
k32u GoResampledProfileMsg_ZResolution (GoResampledProfileMsg msg)
 Gets the profile z-resolution, in nanometers. More...
 

Member Function Documentation

k16s * GoResampledProfileMsg_At ( GoResampledProfileMsg  msg,
kSize  index 
)

Gets a pointer to a resampled profile array.

Parameters
msgMessage object.
indexProfile array index.
Returns
Data pointer.
kSize GoResampledProfileMsg_Count ( GoResampledProfileMsg  msg)

Gets the count of resampled profile arrays in this message.

Parameters
msgMessage object.
Returns
Count of profile arrays.
k32u GoResampledProfileMsg_Exposure ( GoResampledProfileMsg  msg)

Gets the exposure.

Parameters
msgMessage object.
Returns
Exposure in uS.
GoDataSource GoResampledProfileMsg_Source ( GoResampledProfileMsg  msg)

Gets the profile source.

Parameters
msgMessage object.
Returns
Profile source.
kSize GoResampledProfileMsg_Width ( GoResampledProfileMsg  msg)

Gets the count of points in each resampled profile array.

Parameters
msgMessage object.
Returns
Point count.
k32s GoResampledProfileMsg_XOffset ( GoResampledProfileMsg  msg)

Gets the profile x-offset, in micrometers.

Parameters
msgMessage object.
Returns
X offset (um).
k32u GoResampledProfileMsg_XResolution ( GoResampledProfileMsg  msg)

Gets the x-resolution, in nanometers.

Parameters
msgMessage object.
Returns
X resolution (nm).
k32s GoResampledProfileMsg_ZOffset ( GoResampledProfileMsg  msg)

Gets the profile z-offset, in micrometers.

Parameters
msgMessage object.
Returns
Z offset (um).
k32u GoResampledProfileMsg_ZResolution ( GoResampledProfileMsg  msg)

Gets the profile z-resolution, in nanometers.

Parameters
msgMessage object.
Returns
Z resolution (nm).

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