SPI Common Extensions Manual

Extended SPI Concepts
SPI Common Extensions Manual427508-001
2-8
Command Modifiers
Command Modifiers
Some commands allow one or more command modifiers. A command modifier
characterizes or assigns properties to a command. Command modifiers can be
required or optional, depending on the destination-subsystem implementation of the
modifiers. Command modifiers can also be subsystem-specific.
SUB (Subordinate) Command Modifier
The token ZCOM-TKN-SUB is called the subordinate or SUB command modifier. You
can use it in an object hierarchy to apply a command to an object, its subordinates, or
both. The modifier can appear only once in a command message.
The possible values for the token ZCOM-TKN-SUB are:
This example demonstrates the behavior of the SUB modifier.
Assume this hierarchy of object types and corresponding objects:
LINEs A B C
PUs D E F G H
LUs K,L,M N,O,P Q,R S,T,U X,Y,Z
A STOP command issued to the LINE object type can have these results:
ZCOM-VAL-SUB-ALL The command is applied to the named object and all of its
subordinates.
ZCOM-VAL-SUB-NONE The command is applied to the named object but does not
affect its subordinates.
ZCOM-VAL-SUB-ONLY The command is not applied to the named object but is applied
to all of its subordinates.
ZCOM-OBJ-objtype The command is applied to any subordinate of the named
object that is of this type.
Note. A command issued with a SUB modifier behaves as if it were issued individually to each
qualifying object, with this restriction: the SPI rules governing ZSPI-TKN-ALLOW-TYPE take
precedence in the processing of the modifier. For instance, if a command issued with ZSPI-
TKN-ALLOW-TYPE set to the default of ZSPI-VAL-NORM-ONLY encounters a warning or an
error, processing stops whether or not additional objects meet the criteria of the SUB modifier.
Objects Named in
STOP Command SUB Modifier Value Objects Stopped
A ZCOM-VAL-SUB-NONE A
A ZCOM-VAL-SUB-ALL A,D,E,K,L,M,N,O,P
A ZCOM-VAL-SUB-ONLY D,E,K,L,M,N,O,P
AZCOM-OBJ-PUD,E
A ZCOM-OBJ-LU K,L,M,N,O,P
A and B ZCOM-OBJ-PU D,E,F,G