Object PmaCommMsg (Communication message)
Description:
See:
PmaCommMsg - Deatiled object description
The object serves to the definition of the format and data of one communication message.
No other
Pma objects can be created in this object.
The
PmaCommMsg object can be created only in the
PmaComm object (if the selected protocol supports the usage of the
PmaCommMsg object). There can be even more
PmaCommMsg objects in the
PmaComm object.
This object
adds variables into the calculation of the application size, which influences the
basic runtime licence type/size (see:
Licences for PROMOTIC runtime environment).
This object inherits properties, methods and events of the
PmaObject object.
Properties and methods of this object:
| AutoRunEnabled | Enable/disable the automated transmissions |
|---|
| AutoRunPeriod | The period of automated transmissions |
|---|
| GetCount | Returns the number of transmissions |
|---|
| GetReady | Detects whether the PmaCommMsg object is ready to transfer the message |
|---|
| LastErr | Error number of the last communication message transfer |
|---|
| LastTextErr | Text error description of last communication message transfer |
|---|
| ReadVars | Access to variables on the "Data-received" tab |
|---|
| Run | Command for transferring the message (only for messages of the Master type) |
|---|
| WriteVars | Access to variables on the "Data-sent" tab |
|---|
Properties and methods inherited from the PmaObject object:
| AddEvent | Registers a function into selected event |
|---|
| GetInfo | Returns the Info object with the specified name |
|---|
| GetOwnedByIndex | Returns the subobject defined by its index |
|---|
| GetOwnedByName | Returns reference to the subobject defined by its name |
|---|
| GetOwnedByType | Array of references to the subobjects |
|---|
| GetOwnedNum | Returns number of subobjects in the object |
|---|
| GetPar | Reading the value of the Pma object parameter (or its parents) |
|---|
| GetPathName | Object name with the path to this object |
|---|
| GetPermission | Returns permission of corresponding operation from object |
|---|
| Methods | Access to designer's methods of this object |
|---|
| Name | Object name (without the path) |
|---|
| Parent | Returns reference to the parent Pma object |
|---|
| Pm | Returns reference to the Pma object or to its implementation subobject |
|---|
| RemoveEvent | Un-registers the function in the specified event |
|---|
| Root | Returns reference to the root application object PmaRoot |
|---|
Events inherited from the PmaObject object:
| onStart | Is triggered for each object in the runtime only once at the beginning |
|---|
| onStop | Is triggered for each Pma object in the runtime mode only once at the stop of the application |
|---|
Configuration tabs:
| Object | General information about the object |
|---|
| Events | Definition of object events algorithms |
|---|
| Parameters | Definition of the communication message parameters |
|---|
| Data-sent | List of variables for the write |
|---|
| Data-received | List of variables for the read |
|---|
Related objects:
| PmVar | (Variable) Object represents one data item of the object |
|---|
History:
Pm9.00.00: Object name changed:
PmCommMsg ->
PmaCommMsg