GoSurfaceIntensityMsg Class Reference

Description

Represents a data message containing a surface intensity array.

Inheritance diagram for GoSurfaceIntensityMsg:

Public Member Functions
GoDataMessageType	GoDataMsg_Type (GoDataMsg message)
	Returns the message type for a data channel message given in a GoDataSet. More...
k32u	GoSurfaceIntensityMsg_Exposure (GoSurfaceIntensityMsg msg)
	Gets the exposure. More...
kSize	GoSurfaceIntensityMsg_Length (GoSurfaceIntensityMsg msg)
	Gets the length of the surface (row count). More...
k8u *	GoSurfaceIntensityMsg_RowAt (GoSurfaceIntensityMsg msg, kSize index)
	Gets a pointer to a surface intensity row. More...
GoDataSource	GoSurfaceIntensityMsg_Source (GoSurfaceIntensityMsg msg)
	Gets the profile source. More...
k32s	GoSurfaceIntensityMsg_SurfaceId (GoSurfaceIntensityMsg msg)
	Gets the surface ID. More...
kSize	GoSurfaceIntensityMsg_Width (GoSurfaceIntensityMsg msg)
	Gets the width of the surface (column count). More...
k32s	GoSurfaceIntensityMsg_XOffset (GoSurfaceIntensityMsg msg)
	Gets the surface x-offset, in micrometers. More...
k32u	GoSurfaceIntensityMsg_XResolution (GoSurfaceIntensityMsg msg)
	Gets the surface x-resolution, in nanometers. More...
k32s	GoSurfaceIntensityMsg_YOffset (GoSurfaceIntensityMsg msg)
	Gets the surface y-offset, in micrometers. More...
k32u	GoSurfaceIntensityMsg_YResolution (GoSurfaceIntensityMsg msg)
	Gets the surface y-resolution, in nanometers. More...

Member Function Documentation

GoDataMessageType GoDataMsg_Type ( GoDataMsg  message )

inherited

Returns the message type for a data channel message given in a GoDataSet.

Parameters

message

A data channel message.

Returns

A GoDataMessageType value.

k32u GoSurfaceIntensityMsg_Exposure

(

GoSurfaceIntensityMsg

msg

)

Gets the exposure.

Parameters

msg	Message object.

Returns

Exposure in uS.

kSize GoSurfaceIntensityMsg_Length

(

GoSurfaceIntensityMsg

msg

)

Gets the length of the surface (row count).

Parameters

msg	Message object.

Returns

Surface length.

k8u * GoSurfaceIntensityMsg_RowAt	(	GoSurfaceIntensityMsg	msg,
		kSize	index
	)

Gets a pointer to a surface intensity row.

Parameters

msg	Message object.
index	Surface intensity row index.

Returns

Data pointer.

GoDataSource GoSurfaceIntensityMsg_Source

(

GoSurfaceIntensityMsg

msg

)

Gets the profile source.

Parameters

msg	Message object.

Returns

Profile source.

k32s GoSurfaceIntensityMsg_SurfaceId

(

GoSurfaceIntensityMsg

msg

)

Gets the surface ID.

Parameters

msg	Message object.

Returns

Surface ID.

kSize GoSurfaceIntensityMsg_Width

(

GoSurfaceIntensityMsg

msg

)

Gets the width of the surface (column count).

Parameters

msg	Message object.

Returns

Surface width;

k32s GoSurfaceIntensityMsg_XOffset

(

GoSurfaceIntensityMsg

msg

)

Gets the surface x-offset, in micrometers.

Parameters

msg	Message object.

Returns

X offset (um).

k32u GoSurfaceIntensityMsg_XResolution

(

GoSurfaceIntensityMsg

msg

)

Gets the surface x-resolution, in nanometers.

Parameters

msg	Message object.

Returns

X resolution (nm).

k32s GoSurfaceIntensityMsg_YOffset

(

GoSurfaceIntensityMsg

msg

)

Gets the surface y-offset, in micrometers.

Parameters

msg	Message object.

Returns

Y offset (um).

k32u GoSurfaceIntensityMsg_YResolution

(

GoSurfaceIntensityMsg

msg

)

Gets the surface y-resolution, in nanometers.

Parameters

msg	Message object.

Returns

Y resolution (nm).

---

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

• Messages/GoDataTypes.h