SegmentGroupSegment

<< Click to Display Table of Contents >>

Navigation:  Support > Reconfigurable Rulebook > Definition Objects >

SegmentGroupSegment

Description

A SegmentGroupSegment object (sometimes simply called a Segment) controls how shots are labeled and scored during the segment of the match. It also specifies what capabilities the athlete has over the EST Target.

A SegmentGroupSegment is a sub-object of SegmentGroup.

Default

Design

Name

Value Type

Description

SegmentName

String

A unique name given to this segment.

A value is required, following the Value Inheritance Rules. Value may be an empty string ("").

NumberOfShots

Number.

The expected number of shots to be fired during this segment. The value -1 indicates shots are expected and an unlimited number of shots could be fired (i.e. sighters). The value 0 indicates not shots are expected.

If NumberOfShots > 0, once the athlete has fired NumberOfShots the target automatically advances to the next SegmentGroupSegment in the SegmentGroup.Segments list.

A value greater than or equal to -1 is required, following the Value Inheritance Rules. Value must be 0 or -1 if this SegmentGroupSegment is the last object in the SegmentGroup.Segments list.

StageLabel

String

The stage label that is applied to each shot that is fired during this segment. Stage labels are usually represented by a single character ('P', 'S', 'K'). They are used to map shots to Singulars.

A value is required, following the Value Inheritance Rules. Value may not be an empty string ("").

TargetDef

No longer used. Replaced with TargetCollectionIndex

String formatted as a Set Name.

The TARGET definition to use to score the shot and to display to the athlete or spectators.

As a member of SegmentGroup.Segments list: Not required, if missing or empty string uses value from SegmentGroup.DefaultSegment.

SegmentGroup.DefaultSegment: Not required, if missing or empty string uses value from RangeScript.DefaultSegment.

RangeScript.DefaultSegment: Required and may not be empty string ("").

TargetCollectionIndex

Int

The index value, into the specified TARGET COLLECTION to use as the current TARGET definition.

A value is not required, following the Value Inheritance Rules. The default value is 0.

TargetHeight

Number

Integer value, measured in millimeters, indicating how high the center of the aiming bull should be moved to. The maximum and minimum values are controlled by the EST Target.

This value is ignored if "TargetLift" is listed in AthleteHasControl. If "TargetLiftDefault" listed in AthleteHasControl then the target is moved to the height listed here, then the athlete has control to move it.

A value is required, following the Value Inheritance Rules. Value may be an increment of 100.

AthleteHasControl

List of strings.

List of capabilities the athlete has permission to control on the EST Target. Each value must be one of the following.

TargetLight

TargetLift or a Target Lift Function

ShotPresentation

"TargetLight" allows the athlete to control the illumination of the target light.

"TargetLift" allows the athlete to control the height of the target. See Target Lift Function for how this value interacts and has priority over the attribute TargetHeight.

"ShotPresentation" allows the athlete to control how many and which shots to display within the athlete monitor. It overrides any value set in the segment's Show field.

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

NextSegments

List of strings.

List of other SegmentGroupSegments identified by the SegmentName that the athlete has the option to advance to next.

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

ShotAttributes

List of strings.

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

SIGHTER

STOP

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

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

AbbreviatedFormat

String

The name of the AbbreviatedFormat to use to display scores to the athlete on the monitor.

A value is not required, following the Value Inheritance Rules. If missing, an empty string, or is invalid, defaults to the first AbbreviatedFormat in this COURSE OF FIRE AbbreviatedFormats list.

Show

SegmentShow

Indicates what type of shots to display within the Athlete EST Monitor or Spectator EST Display.

A value is not required, following the Value Inheritance Rules. If missing defaults to displaying all shots.

Special

List of strings.

Unique display mode considerations. Values must be on of the following (or an empty list).

GroupMode

ShotCalling

A value is not required. Defaults to an empty list.

StringSize

Integer

The number of shots in a string, used for displaying shots purposes only.

A value is not required, following the Value Inheritance Rules. Default value is 10.

TapeAdvance

Integer

When set, advances the tape feed on the target this number of millimeters at the start of the Segment.

A value is not required, following the Value Inheritance Rules. The default value is 0.

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)