This structure includes:
A COURSE OF FIRE should only describe an event that can be completed with one outing to the range. In other words, an athlete should be able to complete the course of fire with one trip to the range. A multi-day event is the combination of two or more COURSE OF FIRE, that is defined outside of this type.
public class CourseOfFire : Definition,
IGetTargetCollectionDefinition, IGetAttributeDefinition| AbbreviatedFormats | A list of AbbreviatedFormats. |
| COFType | |
| Comment |
Internal documentation comments. All text is ignored by the system.
(Inherited from Definition) |
| CommonName |
A human readable short name for this Definition. If no specific value
is given, then the ProperName portion of the SetName is returned instead.
(Inherited from Definition) |
| DefaultAttributeDef | The default Attribute Value to use to determine a user's Attribute Value Appellation when shooting this course of fire. |
| DefaultCompareType | The default Result Engine Compare Type to use when calculating Rank Deltas. |
| DefaultEventAndStageStyleMappingDef | The default Event and Stage Style Mapping file to use. |
| DefaultExpectedDiameter | The default expected diameter of the bullet shot at the target. |
| DefaultScoringDiameter | The default bullet diameter to use for scoring, measured in mm. |
| DefaultTargetCollectionName | The name of the Target Collection to use as the default when creating a new Course of Fire. Must be a value specified in the TargetCollectionDef. |
| Deprecated |
If true, the major version of this Definition will be marked Discontinued in the future.
The author should put in .Comments additional information on when it will be deprecated. (Inherited from SparseDefinition) |
| Description |
A human readable description of this Definition. May be verbose.
(Inherited from Definition) |
| Discipline |
The high level shooting discipline that uses this Definition.
(Inherited from Definition) |
| Discontinued |
If true, the major version of this Definition is no longer in use and should not be referenced. Other major versions
of this same Definition may still be in use (e.g. v1.0 vs v2.0).
(Inherited from SparseDefinition) |
| Events | A list of Events that make up this COURSE OF FIRE. These are the composite events, those that are made up of other child events. |
| HierarchicalName |
HierarchicalName is namespace:properName
(Inherited from Definition) |
| JSONVersion |
The Version string of the JSON document.
(Inherited from Definition) |
| ModifiedAt |
The date and time this definition version was uploaded to the Rest API.
(Inherited from SparseDefinition) |
| Owner |
The Orion license account number of who owns, and is responsible for, this desciption.
There is often a one to one relationship between the Owner and namespace of a Definition.
(Inherited from Definition) |
| RangeScripts | Range command script with Paper Targets or EST Configuration. |
| ScoreConfigDefault | The default ScoreConfig to use, within the ScoreFormatCollection. |
| ScoreFormatCollectionDef | Formatted as a SetName, the ScoreFormatCollectionDef to use to display results to athletes and spectators. |
| SetName |
A SetName is a unique identifier for a Defintion file within a definition type. It has three parts, the version number, namespace, and propername.
(Inherited from SparseDefinition) |
| Singulars | A list of Singulars that make up this COURSE OF FIRE. These are the singular events, those that are not made up of other events. Almost always represents a singular shot. |
| SpecificationMessages | (Inherited from Definition) |
| Subdiscipline |
The subdiscipline (under the value of Discipline) to categorize this Definition.
The value of a "Subdiscipline" field may be any text string. However, there is a list of common subdisciplines and tags that should be used as appropriate.
(Inherited from Definition) |
| Tags |
The tag or tags to categorize this Definition with.
The value of a "Tags" field may be any text string. However, there is a list of common subdisciplines and tags that should be used as appropriate.
(Inherited from Definition) |
| TargetCollectionDef | Formatted as a SetName, the TargetCollectionDef to use to score shots. The specific TARGET definition to use is calculated with the SegementGroupSegment.TargetSetIndex. Required. |
| Type |
The Definition Type
(Inherited from SparseDefinition) |
| Version |
The precise version number of this Definition. Note, the version number listed in the SetName is often
a reference to either the latest Major release. Version always provides both the Major and Minor release numbers and is not a reference.
(Inherited from SparseDefinition) |
| ConvertValues | (Overrides DefinitionConvertValues) |
| 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) |
| GetAttributeDefinitionAsync | Retreives the Attribute Definition referenced by the instantiating class. |
| GetDefaultTargetDefinition | Helper function to return the SetName of a DefaultTargetDefinition given a collectionName |
| GetDefinitionVersion |
Returns the Version of the Definition as an object DefinitionVersion.
the string varation is returned with the property .Version
(Inherited from SparseDefinition) |
| GetEventAndStageStyleMappingDefinitionAsync | |
| GetFileName |
Returns the file name for this Definition. It should be stored in a directory named after the definition type.
(Inherited from Definition) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetHierarchicalName |
Returns the value of .HierarchicalName as an HierarchicalName object.
(Inherited from Definition) |
| GetMeetsSpecificationAsync | (Overrides DefinitionGetMeetsSpecificationAsync) |
| GetRelativePath |
Definitions, by commonality, are saved to file system in a standard relative directory structure. This method
returns that standard relative path.
(Inherited from Definition) |
| GetScoreFormatCollectionDefinitionAsync | |
| GetSetName |
Returns a SetName object based on the Definitions Version and HierrchcialName
If originalSetName is true, returns the setname as was loaded, usually with v1.0, or v0.0
If false, returns the Version based on the version in the file
(Inherited from Definition) |
| GetTargetCollectionDefinitionAsync | Retreives the Target Collection Definition referenced by the instantiating class. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsVersionUpdateAvaliableAsync |
Checks to see if there is a newer minor version of the Definition file avaliable through the Rest API
(Inherited from Definition) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| SaveToFile(DirectoryInfo) |
Helper method to save the Definition file to local storage.
Will save the definition file under [definitionDirectory]/DEFINITIONS/[Definition Type]/[SetName].json (Inherited from Definition) |
| SaveToFile(FileInfo) |
Helper method to save the Definition to file
(Inherited from Definition) |
| SerializeToJson |
Returns this Definition as a json serialized string.
(Inherited from Definition) |
| SetDefaultValues |
Method to set default values on a new Definition. Implementation specific for each definition type.
(Overrides DefinitionSetDefaultValues) |
| ToString | Returns a string that represents the current object. (Inherited from SparseDefinition) |