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

Description

Represents health information from a single sensor.

Inherits kObject.

Public Member Functions

GoIndicatorGoHealthMsg_At (GoHealthMsg msg, kSize index)
 Gets the health indicator at the specified index. More...
 
kSize GoHealthMsg_Count (GoHealthMsg msg)
 Count of health indicators in this message. More...
 
GoIndicatorGoHealthMsg_Find (GoHealthMsg msg, k32u id)
 Finds the health indicator with the matching ID. More...
 
GoDataSource GoHealthMsg_Source (GoHealthMsg msg)
 Gets the health source. More...
 

Member Function Documentation

GoIndicator * GoHealthMsg_At ( GoHealthMsg  msg,
kSize  index 
)

Gets the health indicator at the specified index.

Parameters
msgMessage object.
indexIndicator index.
Returns
Indicator pointer.
kSize GoHealthMsg_Count ( GoHealthMsg  msg)

Count of health indicators in this message.

Parameters
msgMessage object.
Returns
Count of indicators.
GoIndicator * GoHealthMsg_Find ( GoHealthMsg  msg,
k32u  id 
)

Finds the health indicator with the matching ID.

Returns kNULL if not found.

Parameters
msgMessage object.
idIndicator index.
Returns
Indicator pointer.
GoDataSource GoHealthMsg_Source ( GoHealthMsg  msg)

Gets the health source.

Parameters
msgMessage object.
Returns
Health source.

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