Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoGenericMsg Class Reference

Description

Represents a data message containing generic data.

A generic message may contain either a raw byte buffer, or a kObject. If the content is a kObject, then the buffer contains the byte stream containing the serialized object, using the standard serialization schem (kDat6).

Inheritance diagram for GoGenericMsg:
Inheritance graph

Public Member Functions

k32s GoDataMsg_ArrayedCount (GoDataMsg message)
 Gets the count of the data messages (in an arrayed context). More...
 
k32s GoDataMsg_ArrayedIndex (GoDataMsg message)
 Gets the index of the data message (in an arrayed context). More...
 
kStatus GoDataMsg_SetArrayedCount (GoDataMsg message, k32s arrayedCount)
 Sets the count of the data messages (in an arrayed context). More...
 
kStatus GoDataMsg_SetArrayedIndex (GoDataMsg message, k32s arrayedIndex)
 Sets the index of the data message (in an arrayed context). More...
 
kStatus GoDataMsg_SetStreamStep (GoDataMsg message, GoDataStep streamStep)
 Sets the source of the data stream. More...
 
kStatus GoDataMsg_SetStreamStepId (GoDataMsg message, k32s streamStepId)
 Sets the identifier of the data stream from the source. More...
 
GoDataStep GoDataMsg_StreamStep (GoDataMsg message)
 Gets the source of the data stream. More...
 
k32s GoDataMsg_StreamStepId (GoDataMsg message)
 Gets the identifier of the data stream from the source. More...
 
GoDataMessageType GoDataMsg_Type (GoDataMsg message)
 Returns the message type for a data channel message given in a GoDataSet. More...
 
const void * GoGenericMsg_BufferData (GoGenericMsg msg)
 Returns a pointer to the raw buffer. More...
 
kSize GoGenericMsg_BufferSize (GoGenericMsg msg)
 Returns the size of the raw buffer. More...
 
kBool GoGenericMsg_IsObject (GoGenericMsg msg)
 Returns whether or not the content is an kObject. More...
 
kObject GoGenericMsg_Object (GoGenericMsg msg)
 Returns the kObject content, if available. More...
 
kStatus GoGenericMsg_SerializerStatus (GoGenericMsg msg)
 Returns the serializer status after deserializing kObject content. More...
 
k32u GoGenericMsg_UserType (GoGenericMsg msg)
 Gets the user defined data type. More...
 
kSize GoMeshMsg_AllocatedChannelDataCount (GoMeshMsg msg, GoMeshMsgChannelId id)
 Gets channel allocated data count. More...
 
kSize GoMeshMsg_ChannelCount (GoMeshMsg msg)
 Gets total channel count. More...
 
kArray1 GoMeshMsg_ChannelData (GoMeshMsg msg, GoMeshMsgChannelId id)
 Gets channel data buffer. More...
 
kType GoMeshMsg_ChannelDataType (GoMeshMsg msg, GoMeshMsgChannelId id)
 Gets channel data type. More...
 
k32u GoMeshMsg_ChannelFlag (GoMeshMsg msg, GoMeshMsgChannelId id)
 Gets channel flag. More...
 
GoMeshMsgChannelState GoMeshMsg_ChannelState (GoMeshMsg msg, GoMeshMsgChannelId id)
 Gets channel state. More...
 
GoMeshMsgChannelType GoMeshMsg_ChannelType (GoMeshMsg msg, GoMeshMsgChannelId id)
 Gets channel type. More...
 
kBool GoMeshMsg_HasData (GoMeshMsg msg)
 Gets hasData. More...
 
kSize GoMeshMsg_MaxUserChannelCount (GoMeshMsg msg)
 Gets maximum user channel count. More...
 
kPoint3d64f GoMeshMsg_Offset (GoMeshMsg msg)
 Gets offset. More...
 
kPoint3d64f GoMeshMsg_Range (GoMeshMsg msg)
 Gets range. More...
 
Go3dTransform64f GoMeshMsg_Transform (GoMeshMsg msg)
 Gets transform. More...
 
kSize GoMeshMsg_UsedChannelDataCount (GoMeshMsg msg, GoMeshMsgChannelId id)
 Gets channel used data count. More...
 
kSize GoMeshMsg_UserChannelCount (GoMeshMsg msg)
 Gets user channel count. More...
 

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