An Event defines a real world event in a marksmanship competition. Includes events, stages, series, and strings. Does not includes individual shots (as these are Singulars).
public abstract class Event : IReconfigurableRulebookObject,
IGetResultListFormatDefinition, IGetRankingRuleDefinition, IGetRankingRuleDefinitionList| Event | Initializes a new instance of the Event class |
| Calculation | The method to use to calculate the score of this event from the children. Must be one of the following: * SUM (may have CalculationVariables of type CalculationVariablesString) * AVERAGE (may have CalculationVariables of type CalculationVariableInteger) |
| CalculationVariables | Additional information needed for the Event Calculation score. The type of data is dependent on the Calculation type. |
| Children | The children of this event identified by the EventName. The score for this event is added together from the scores of the children. |
| Comment | Internal documentation comments. All text is ignored by the system. |
| Derivation | Indicates if the Event's children are derived or explicit |
| EventName | A unique name given to this Event. |
| EventStyleMapping | EventStyleSelection determines how the resulting Result COF is mapped to a EVENT STYLE. |
| EventType | The type of event. Must be one of the following: * NONE * EVENT * STAGE * SERIES * STRING * SINGULAR |
| ExternalToEventTree | Indicates if this Event is outside of the Event Tree. |
| IsATopLevelStageStyle |
Helper method to identify Events that define a StageStyleMapping.
When an Event defines a StageStyleMapping, it means that all descendent shots fired within that Event will have been fired on the same target and withing the same STAGE STYLE. This method returns a list of EventComposites that have defined StageStyleMappings, and thus have distinct STAGE STYLES. |
| RankingRuleDef |
The recommended Ranking Rules defintion to use when displaying a ranking list for this Event.
EKA NOTE: We may have to make this an object, as depending on the Score Formate (e.g. Integer
vs Decimal) we would have different RankingRuleDef.
|
| RankingRuleMapping | A mapping of RankingRuleDef to use to sort scores from this Event, based on the ScoreConfigName. |
| ResultListFormatDef | The recommended Result List Format defintion to use when displaying a result list for this Event. |
| ScoreFormat | The score format to use to display scores for this Event. The possible values are learned from the Score Format Collection. |
| StageStyleMapping |
StageStyleSelection determines how the resulting Result COF is mapped to a STAGE STYLE.
When an Event defines a StageStyleMapping, it means that all descendent shots fired within that Event will have been fired on the same target and withing the same STAGE STYLE. This method returns a list of EventComposites that have defined StageStyleMappings, and thus have distinct STAGE STYLES. |
| TargetCollectionIndex |
Specifies the *expected* TargetDef to use during this Event. Specifically, this is the zero based index into the
CourseOfFire.TargetCollectionDef.TargetCollections.TargetDefs array.
This value has no precise programmatic control. Instead it is used as a helper to more easily learn which TARGET this Event is being shot on. Programmatically, the SegmentGroupSegment, in the range script controls the selected TARGET (via its TargetCollectionIndex). The definition's author is responsible for composing values that are consistent. This value may only be seet on Event with EventType Stage. All children on a Event, of EventType Stage are assumed to use the same TargetCollectionIndex. Value must be between 0 and n - 1, where n is the number of TargetDefs in the TARGET COLLECTION definition. The special value of -9999 means not to set a value. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetCompiledEvents |
If the fields EventName and Values require interpretation, GetCompiledEvents
interpres them and returns a new list of TieBreakingRules cooresponding to the interpretation.
If interpretation is not required, then it returns a list of one tie breaking rule, itself.
Will always return a clone copy of the event, so the original is not modified by the caller. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetRankingRuleDefinitionAsync |
Retreives the RankingRule Definition referenced by the instantiating class.
|
| GetRankingRuleDefinitionListAsync | Retreives the RankingRule Definition referenced by the instantiating class. Key is the set name, value is the definition. |
| GetResultListFormatDefinitionAsync | Retreives the ResultListFormat Definition referenced by the instantiating class. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ShouldSerializeCalculationVariables | |
| ShouldSerializeRankingRuleMapping | |
| ToString | (Overrides ObjectToString) |