xfCommand

<< Click to Display Table of Contents >>

 

xfCommand

Organizes a structure of Commands, which can contain one or more Command Units, or actions.

Properties of the xfCommand object

Property

Data Type

Description

CheckInterlock

Boolean

Requests an update on the interlock status

CommandMode

Number

Type of Command to execute. This property is used by the Faceplate Screen to place a Command object, mode or favorite Commands, as well as by the Screen object to execute a Jog-type Command. Possible values for this property are 0: Default, 1: Mode, 2: Favorite, or 3: Jog

CommandType

Text

Free text indicating the sub-type of a Command

CurrentState

Variant

Reference to the current value

Interlocked

Boolean

Interlock situation, based on the interlock status of child objects of type xfInterlockGroup

TabOrder

Number

Reference to the order on a window

UserInfo1 and UserInfo2

Variant

Free usage fields

 

This object contains a Cmd context, which can be called from any child object for direct linking using the Context method.

 

Functionality

The CommandMode property has the following behavior:

1: Indicates that on the Faceplate Screen a button must be placed to control the operation mode, such as Manual or Automatic

2: Indicates that on the Faceplate Screen a Favorite command button, that is, a highlighted one

3: Indicates that this is a jog command, that is, it operates alongside the application to send a start command when the button is pressed and an end command when the button is released

 

The AuthorizedGroups property is checked hierarchically on levels PlantFolder, CommandFolder, and Command, and the most restrictive condition is considered. If it is not specified, then the upper levels must be considered, according to the next example.

PlantFolder: "Engineering"

CommandFolder: "Managers;Supervisors"

Command1: "Operators"

Command2: ""

 

In the previous example, an operator cannot execute a command on Command2, but they can execute on Command1.

Was this page useful?