Promotic

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:
AutoRunEnabledEnable/disable the automated transmissions
AutoRunPeriodThe period of automated transmissions
GetCountReturns the number of transmissions
GetReadyDetects whether the PmaCommMsg object is ready to transfer the message
LastErrError number of the last communication message transfer
LastTextErrText error description of last communication message transfer
ReadVarsAccess to variables on the "Data-received" tab
RunCommand for transferring the message (only for messages of the Master type)
WriteVarsAccess to variables on the "Data-sent" tab
Properties and methods inherited from the PmaObject object:
AddEventRegisters a function into selected event
GetInfoReturns the Info object with the specified name
GetOwnedByIndexReturns the subobject defined by its index
GetOwnedByNameReturns reference to the subobject defined by its name
GetOwnedByTypeArray of references to the subobjects
GetOwnedNumReturns number of subobjects in the object
GetParReading the value of the Pma object parameter (or its parents)
GetPathNameObject name with the path to this object
GetPermissionReturns permission of corresponding operation from object
MethodsAccess to designer's methods of this object
NameObject name (without the path)
ParentReturns reference to the parent Pma object
PmReturns reference to the Pma object or to its implementation subobject
RemoveEventUn-registers the function in the specified event
RootReturns reference to the root application object PmaRoot
Events of this object:
onBeginOfTransferIs triggered always before transmitting the Master message starts
onDataReceiveIs triggered after the successful data reading
onEndOfTransferIs triggered after the transfer of the whole message
Events inherited from the PmaObject object:
onStartIs triggered for each object in the runtime only once at the beginning
onStopIs triggered for each Pma object in the runtime mode only once at the stop of the application
Configuration tabs:
ObjectGeneral information about the object
EventsDefinition of object events algorithms
ParametersDefinition of the communication message parameters
Data-sentList of variables for the write
Data-receivedList 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
Pm8.00.07: New configurators AutoRun transfer enabled and Transfer period [ms]. For communication by this object, in common cases, is not necessary call the Run method in the timer.
Pm8.00.01: New "AutoRun transfer enabled" configurator and a new the onBeginOfTransfer event allows to simplify the launching of periodical Master messages.
PROMOTIC 9.0.23 SCADA system documentation MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.