Class IpcMessage
Represents an Ipc message.
Namespace: ABB.Robotics.Controllers.Messaging
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public class IpcMessageConstructors
IpcMessage()
Default constructor - creates a message with maximum capacity.
Declaration
public IpcMessage()IpcMessage(Int32)
Creates an Ipc message.
Declaration
public IpcMessage(int Capacity)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | Capacity | The capacity of the message data |
Fields
Cmd
Command
Declaration
public int CmdField Value
| Type | Description |
|---|---|
| Int32 |
Sender
Sender
Declaration
public int SenderField Value
| Type | Description |
|---|---|
| Int32 |
Status
Status
Declaration
public IpcReturnType StatusField Value
| Type | Description |
|---|---|
| IpcReturnType |
UserData
User information
Declaration
public int UserDataField Value
| Type | Description |
|---|---|
| Int32 |
UserDef
User defined value. Type short is only supported by the controller.
Declaration
public int UserDefField Value
| Type | Description |
|---|---|
| Int32 |
Properties
Capacity
Returns the total data capacity of the message.
Declaration
public int Capacity { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Data
Returns a reference to the data of the message
Declaration
public byte[] Data { get; }Property Value
| Type | Description |
|---|---|
| Byte[] |
Destination
The destination queue
Declaration
public int Destination { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Size
The size of the message data
Declaration
public int Size { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Type
The message type
Declaration
public int Type { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Methods
GetData()
Returns a copy of the data of the message.
Declaration
public byte[] GetData()Returns
| Type | Description |
|---|---|
| Byte[] | The data as a byte array |
SetData(Byte[])
Sets the data of the message.
Declaration
public void SetData(byte[] data)Parameters
| Type | Name | Description |
|---|---|---|
| Byte[] | data | The data to set |