For Babelfish Release 1.11.1.3

SegmentGroupSegment Class

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.

Definition

Namespace: Scopos.BabelFish.DataModel.Definitions
Assembly: BabelFish (in BabelFish.dll) Version: 1.11.1.4+b1da393815f6638555a663d9a94167ecabea5695
C#
public class SegmentGroupSegment : IReconfigurableRulebookObject
Inheritance
Object    SegmentGroupSegment
Implements
IReconfigurableRulebookObject

Constructors

SegmentGroupSegment Public Constructor

Properties

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

Does follow the value inheritance rules.

AthleteHasControl Values must be one of TargetLight TargetLift TargetLiftDefault TargetLift(min, max) TargetLift('PosOne(height)', 'PosTwo(height)', 'PosThree(height)') ShotPresentation Pause (Need to figure out what this does on the Monitor.) Series (Need to figure out what this does on the Monitor, might be a function, e.g. Series() .) Group (Need to figure out what this does on the Monitor.) AdvancedSettings (Need to figure out what this does on the Monitor.) !AdvancedSettings (Need to figure out what this does on the Monitor.) Series(INFORMAL) Deprecated, needs to be removed. Commands: Not required, missing or null uses DefaultCommand.AthleteHasControl DefaultCommand: Required with default value of [ ]

Does follow the value inheritance rules.

Comment Internal documentation comments. All text is ignored by the system.
NextSegments List of other SegmentGroupSegments identified by the SegmentName that the athlete has the option to advance to next. Commands: Not required, missing or null uses DefaultCommand.NextSegments DefaultCommand: Required with default value of [ ]

Does follow the list inheritance rules.

NumberOfShots 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. Segments: Required DefaultSegments: Ignored

Does follow the value inheritance rules.

Parent 
SegmentName A unique name given to this segment. Segments: Required and must be unique DefaultSegment: Ignored

Does not follow the value inheritance rules.

ShotAttributes A list of ShotAttributes that should decorate a Shot if fired during this SegmentGroupSegment.
  • SIGHTER
  • STOP
  • CONSTANT (see below for meaning)

If an item is prepended with "!" (example "!SIGHTER") then it is removed from the inherited list.

If CONSTANT is included, then all inherited values are ignored.

Does follow the list inheritance rules.

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

Does follow the value inheritance rules.

Special Unique display mode specifics for this segement.
  • GroupMode
  • ShotCalling
  • CONSTANT (see below for meaning)

If an item is prepended with "!" (example "!ShotCalling") then it is removed from the inherited list.

If CONSTANT is included, then all inherited values are ignored.

Does follow the list inheritance rules.

StageLabel 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. Segments: Not required. If missing or "" uses DefaultSegment.StageLabel DefaultSegment: Required

Does follow the value inheritance rules.

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

Does follow the value inheritance rules.

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

Does not follow the value inheritance rules.

TargetCollectionIndex Specifies the TargetDef to use during this Segment. Specifically, this is the index into the CourseOfFire.TargetCollectionDef.TargetCollections.TargetDefs array.

Does follow the value inheritance rules.

TargetHeight Commands: Not required, missing or value of -9999 uses DefaultCommand.TargetHeight DefaultCommand: Required with default value 0

Does follow the value inheritance rules.

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetAbbreviatedFormat 
GetAthleteHasControl 
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetNextSegments Returns the calculated list of NextSegments, based on this Segment, the DefaultSegment, and the RangeSCript's DefaultSegment, and of course the list inheritance rules.
GetNumberOfShots 
GetSegmentName 
GetShotAttributes Returns the calculated list of ShotAttributes, based on this Segment, the DefaultSegment, and the RangeSCript's DefaultSegment, and of course the list inheritance rules.
GetShow 
GetSpecial 
GetStageLabel 
GetStringSize 
GetTapeAdvance 
GetTargetCollectionIndex 
GetTargetHeight 
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ShouldSerializeNextSegments Newtonsoft helper method to determine if the property NextSegments should be serialized.
ShouldSerializeShotAttributes Newtonsoft helper method to determine if the property ShotAttributes should be serialized.
ShouldSerializeShow Newtonsoft helper method to determine if the property Show should be serialized.
ShouldSerializeSpecial Newtonsoft helper method to determine if the property Special should be serialized.
ToStringReturns a string that represents the current object.
(Overrides ObjectToString)

See Also