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

Description

Represents a data message containing a surface array.

Inherits kObject.

Public Member Functions

k32u GoSurfaceMsg_Exposure (GoSurfaceMsg msg)
 Gets the exposure. More...
 
kSize GoSurfaceMsg_Height (GoSurfaceMsg msg)
 Gets the height of the surface (row count). More...
 
k16s * GoSurfaceMsg_RowAt (GoSurfaceMsg msg, kSize index)
 Gets a pointer to a surface row. More...
 
GoDataSource GoSurfaceMsg_Source (GoSurfaceMsg msg)
 Gets the profile source. More...
 
k32u GoSurfaceMsg_SurfaceId (GoSurfaceMsg msg)
 Gets the surface ID. More...
 
kSize GoSurfaceMsg_Width (GoSurfaceMsg msg)
 Gets the width of the surface (column count). More...
 
k32s GoSurfaceMsg_XOffset (GoSurfaceMsg msg)
 Gets the surface x-offset, in micrometers. More...
 
k32u GoSurfaceMsg_XResolution (GoSurfaceMsg msg)
 Gets the surface x-resolution, in nanometers. More...
 
k32s GoSurfaceMsg_YOffset (GoSurfaceMsg msg)
 Gets the surface y-offset, in micrometers. More...
 
k32u GoSurfaceMsg_YResolution (GoSurfaceMsg msg)
 Gets the surface y-resolution, in nanometers. More...
 
k32s GoSurfaceMsg_ZOffset (GoSurfaceMsg msg)
 Gets the surface z-offset, in micrometers. More...
 
k32u GoSurfaceMsg_ZResolution (GoSurfaceMsg msg)
 Gets the surface z-resolution, in nanometers. More...
 

Member Function Documentation

k32u GoSurfaceMsg_Exposure ( GoSurfaceMsg  msg)

Gets the exposure.

Parameters
msgMessage object.
Returns
Exposure in uS.
kSize GoSurfaceMsg_Height ( GoSurfaceMsg  msg)

Gets the height of the surface (row count).

Parameters
msgMessage object.
Returns
Surface height.
k16s * GoSurfaceMsg_RowAt ( GoSurfaceMsg  msg,
kSize  index 
)

Gets a pointer to a surface row.

Parameters
msgMessage object.
indexSurface row index.
Returns
Row pointer.
GoDataSource GoSurfaceMsg_Source ( GoSurfaceMsg  msg)

Gets the profile source.

Parameters
msgMessage object.
Returns
Profile source.
k32u GoSurfaceMsg_SurfaceId ( GoSurfaceMsg  msg)

Gets the surface ID.

Parameters
msgMessage object.
Returns
Surface ID.
kSize GoSurfaceMsg_Width ( GoSurfaceMsg  msg)

Gets the width of the surface (column count).

Parameters
msgMessage object.
Returns
Surface width;
k32s GoSurfaceMsg_XOffset ( GoSurfaceMsg  msg)

Gets the surface x-offset, in micrometers.

Parameters
msgMessage object.
Returns
X offset (um).
k32u GoSurfaceMsg_XResolution ( GoSurfaceMsg  msg)

Gets the surface x-resolution, in nanometers.

Parameters
msgMessage object.
Returns
X resolution (nm).
k32s GoSurfaceMsg_YOffset ( GoSurfaceMsg  msg)

Gets the surface y-offset, in micrometers.

Parameters
msgMessage object.
Returns
Y offset (um).
k32u GoSurfaceMsg_YResolution ( GoSurfaceMsg  msg)

Gets the surface y-resolution, in nanometers.

Parameters
msgMessage object.
Returns
Y resolution (nm).
k32s GoSurfaceMsg_ZOffset ( GoSurfaceMsg  msg)

Gets the surface z-offset, in micrometers.

Parameters
msgMessage object.
Returns
Z offset (um).
k32u GoSurfaceMsg_ZResolution ( GoSurfaceMsg  msg)

Gets the surface z-resolution, in nanometers.

Parameters
msgMessage object.
Returns
Z resolution (nm).

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