SegmentGroupCommand

<< Click to Display Table of Contents >>

Navigation:  Support > Reconfigurable Rulebook > Definition Objects >

SegmentGroupCommand

Description

A SegmentGroupCommand object (sometimes simply called a Command) specifies the state of the EST Targets and Monitors for the current command. It also lists the text of the range officer's commands and notes for the ROs.

A SegmentGroupCommand is a sub-object of RangeScripts, and SegmentGroup. In SegmentGroup a SegmentGroupCommand object is in the field DefaultCommand, and the list Commands.

In general, if a field is not listed in the Commands list, then it is pulled from SegmentGroup.DefaultCommand. If it is not listed there, then it is pulled from RangeScripts.DefaultCommand.  See each field for specifics.

Design

Name

Value Type

Description

Command

String

The text of the command the Chief Range Officer gives during this Command.

Value is not required, defaults to an empty string. Does not follow the Value Inheritance Rules.

Notes

String

Text to display to the Range Officers during this Command.

Value is not required, defaults to an empty string. Does not follow the Value Inheritance Rules.

Fade

Number

Number of seconds to keep Command shown in the EST Monitor. After which the command text fades out.

A value of 0 indicates not to display the text in the EST Monitor.

A value of -1 indicates never to remove the value.

Must be greater than or equal to -1.

A value is required, following the Value Inheritance Rules. Value must be greather than or equal to -1.

Timer

String formatted as a Time.

The Time to set the range timer. Any value greater than 0:00:00.0 will create a count-down timer. Any value that is negative or equal to 0:00:00.0 will create a count-up timer.

Value is not required, defaults to an empty string. Does not follow the Value Inheritance Rules.

TimerCommand

String

Command issued to the timer to start, stop, pause, or display the local clock. Must be one of the following:

START

PAUSE

RESUME

STOP

CLOCK

NONE

Value is not required, defaults to NONE. Does not follow the Value Inheritance Rules.

OccuresAt

String formatted as a Time.

This command is automatically issued when the range timer reaches this value.

Value is not required, defaults to an empty string, which will not enable any automation. Does not follow the Value Inheritance Rules.

GreenLight

String formatted as a Light Enabled

Indicates if the GreenLight should be on, off, or dimmed. Some ESTs do not have this capability.

A value is required, following the Value Inheritance Rules.

RedLight

String formatted as a Light Enabled

Indicates if the RedLight should be on, off, or dimmed. Some ESTs do not have this capability.

A value is required, following the Value Inheritance Rules.

TargetLight

String formatted as a Light Enabled

Indicates if the TargetLight should be on, off, or dimmed. Some ESTs do not have this capability.

A value is required, following the Value Inheritance Rules..

ShotAttributes

List of strings.

Attributes that are assign to each shot fired during this command. Must be one of the following:

FIRED BEFORE COMMAND START

FIRED AFTER COMMAND STOP

This list does not override the ShotAttributes from the current SegmentGroupSegment, instead they are appended to each other and both are applied.

Field is required as part of the RangeScript.DefaultCommand dictionary, but may be an empty list. Otherwise, see List Inheritance Rules for default value calculations.

DisplayEvent

String formatted as a Display Event.

A Display Event is a transitional moment in a competition. When used, it keys an automated change to the Spectator Display.

A value is not required, following the Value Inheritance Rules. If not included or has a value of NONE uses the last known good value of DisplayEvent from a previous Command. If there is no last known good value returns "Default".

Continue

Integer

Number of seconds to wait before advancing to the next Command (or the Command indicated by NextCommandIndex). This field works independent of the Range Timer.

Only works if the Target and Monitor pair is in Practice Mode. Generally used to automate advancing Commands in practice that would otherwise be controlled by the Range Officer

Value of 0 means to advance to the next command immediately.

Value of -1 means to not advance. This is also the default value.

A value is not required, following the Value Inheritance Rules. Defaults to -1.

NextCommandIndex

Integer

The index of the command, within the current SegmentGroup to advance to next using the Continue attribute. Useful if you want to go back a few commands to repeat a loop.

Value of -1 means to advance to the next command regardless of current index value.

A value is not required, following the Value Inheritance Rules. Defaults to -1.

Comment

String

Internal documentation comments. All text is ignored by the system.

 


 

Note:

The Reconfigurable Rulebook and functionality will be implemented with the release of Orion Scoring System v. 3.0 (TBA)