Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups Pages
Public Member Functions
GoStampMsg Class Reference
Data Channel

## Description

Represents a message containing a set of acquisition stamps.

Inheritance diagram for GoStampMsg:

## Public Member Functions
GoDataMessageType | GoDataMsg_Type (GoDataMsg message)
| Returns the message type for a data channel message given in a GoDataSet. More...
GoStamp * | GoStampMsg_At (GoStampMsg msg, kSize index)
| Gets the stamp at the specified index. More...
kSize | GoStampMsg_Count (GoStampMsg msg)
| Returns the number of stamps contained in this message. More...
GoDataSource | GoStampMsg_Source (GoStampMsg msg)
| Gets the stamp source. 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.

GoStamp * GoStampMsg_At | ( | GoStampMsg | msg,
|  | kSize | index
| ) |  |

Gets the stamp at the specified index.

Parameters

  msg | Message object.
  index | Stamp index.

Returns
  Stamp pointer.

kSize GoStampMsg_Count | ( | GoStampMsg | msg | ) |

Returns the number of stamps contained in this message.

Parameters

  msg | Message object.

Returns
  Count of stamps.

GoDataSource GoStampMsg_Source | ( | GoStampMsg | msg | ) |

Gets the stamp source.

Parameters

  msg | Message object.

Returns
  Stamp source.

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

- Messages/GoDataTypes.h