Allows retrieving and manipulating modifiers of a military symbol, without having to worry whether the properties are encoded in the symbol code or in textual modifiers. More...

Inheritance diagram for Luciad.Symbology.Military.MilitarySymbol:

Public Types
enum	Affiliation { Pending , Unknown , AssumedFriend , Friend , AssumedNeutral , Neutral , Suspect , Hostile , ExercisePending , ExerciseUnknown , ExerciseAssumedFriend , ExerciseFriend , ExerciseAssumedNeutral , ExerciseNeutral , Joker , Faker }
	The affiliation of a military symbol. More...

enum	Modifier { Affiliation , Status , OrderOfBattle , Sector1 , Sector2 , StandardIdentity1 , StandardIdentity2 , Echelon , Mobility , Leadership , HqTaskForceDummy , Quantity , ReinforcedOrReduced , StaffComments , AdditionalInformation , EvaluationRating , CombatEffectiveness , SignatureEquipment , HigherFormation , Hostile , IffSif , MobilityIndicator , UniqueDesignation , TypeLabel , DateTimeGroup , AltitudeDepth , LocationLabel , SpeedLabel , SpecialHeadquarters , PlatformType , TeardownTime , CommonIdentifier , EffectiveTime , MovementDirection , Country , TrackNumber , Name , PositionAndMovement , Capacity , HeadquartersElement , InstallationComposition , SpecialDesignator , GuardedUnit , TargetDesignator , TargetNumberExtension , Attitude , Length , Width }
	Enumeration type for all available MIL-STD 2525 and APP-6 symbol modifiers. More...

Public Member Functions
Luciad.Symbology.Military.MilitarySymbol	CopyAndChangeCode (string newCode)
	Creates a new military symbol based on the given code. More...

Luciad.Models.Features.Feature	CopyToFeature (Luciad.Models.Features.Feature feature, Luciad.Geometries.Geometry geometry)
	Creates a new feature based on this military symbol and the given feature. More...

void	Dispose ()

Luciad.Symbology.Military.MilitarySymbol.Affiliation	GetAffiliation ()
	Returns the affiliation of this symbol. More...

System.Collections.Generic.IList< string >	GetPossibleValues (Luciad.Symbology.Military.MilitarySymbol.Modifier modifier)
	Returns the possible values for a given modifier, if applicable. More...

string	GetValue (Luciad.Symbology.Military.MilitarySymbol.Modifier modifier)
	Returns the value for the given modifier. More...

void	PutValue (Luciad.Symbology.Military.MilitarySymbol.Modifier modifier, string value)
	Sets the given (modifier,value) pair. More...

void	ResetValue (Luciad.Symbology.Military.MilitarySymbol.Modifier modifier)
	Resets the value associated with the given modifier. More...

Luciad.Drawing.IIcon	ToIcon (Luciad.Symbology.Military.MilitarySymbolStyle style)
	Creates an icon based on this military symbol and the given style. More...

Static Public Member Functions
static Luciad.Symbology.Military.MilitarySymbol	Create (Luciad.Models.Features.Feature feature)
	Creates an editable military symbol based on the given Feature. More...

static Luciad.Symbology.Military.MilitarySymbol	Create (Luciad.Symbology.Military.MilitarySymbology.Standard standard, string sidc)

Properties
string	Code `[get]`

System.Collections.Generic.IList< Luciad.Symbology.Military.MilitarySymbol.Modifier >	Modifiers `[get]`

Luciad.Symbology.Military.MilitarySymbologyNode	Node `[get]`

System.Collections.Generic.IList< Luciad.Symbology.Military.MilitarySymbol.Modifier >	SIDCModifiers `[get]`

Luciad.Symbology.Military.MilitarySymbology.Standard	Standard `[get]`

System.Collections.Generic.IList< Luciad.Symbology.Military.MilitarySymbol.Modifier >	TextModifiers `[get]`

Detailed Description

Allows retrieving and manipulating modifiers of a military symbol, without having to worry whether the properties are encoded in the symbol code or in textual modifiers.

The modifiers of a military symbol are partly encoded in its symbol code (e.g. the MIL-STD 2525b symbology encodes the affiliation in the second digit of the symbol code) and partly encoded as additional metadata called text modifiers (usually a key-value map). This class exposes all these modifiers and a generic way to retrieve and set modifier values. Example usages

            // 1) create a MIL-STD 2525b "rescue" symbol based on the code from the specification or a MilitarySymbologyNode
            var standard = MilitarySymbology.Standard.MilStd2525b;
            MilitarySymbol codedRescueSymbol = MilitarySymbol.Create(standard, "G*G*GPAR--****X");
            // codedRescueSymbol has properties for all applicable code and text modifiers.
            // Mask characters have been replaced from the symbol code. Hence, the following statement is true:
            Assert.True(codedRescueSymbol.Code == "GUG-GPAR------X");
 
            // 2) query the available modifiers
            Console.WriteLine("available modifiers:");
 
            foreach (MilitarySymbol.Modifier modifier in codedRescueSymbol.Modifiers)
            {
                Console.WriteLine(modifier); // this outputs, among others, MilitarySymbol.Modifier.Affiliation and "AdditionalInformation".
            }
 
            // 3) query the possible values of the MilitarySymbol.Modifier.Affiliation modifier
            codedRescueSymbol.GetPossibleValues(MilitarySymbol.Modifier.Affiliation); // returns an array containing, among others, the value "Friend"
 
            // 4) change the MilitarySymbol.Modifier.Affiliation modifier.
            codedRescueSymbol.PutValue(MilitarySymbol.Modifier.Affiliation, "Friend");
            // The properties of a MilitarySymbol object are read-write and immediately update the values for the code and
            // text modifiers. The MilitarySymbol.Modifier.Affiliation modifier is encoded in the symbol code, so the following statement is true:
            Assert.True(codedRescueSymbol.Code == "GFG-GPAR------X");
 
            // 5) change the "additional information" modifier.
            codedRescueSymbol.PutValue(MilitarySymbol.Modifier.AdditionalInformation, "This is an example symbol.");
            // the "additional information" modifier is stored as a text modifier

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol.

Member Enumeration Documentation

◆ Affiliation

enum Luciad.Symbology.Military.MilitarySymbol.Affiliation

The affiliation of a military symbol.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation.

Enumerator
Pending	A track which has not been subjected to the identification process. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::Pending.
Unknown	An evaluated track which has not been identified. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::Unknown.
AssumedFriend	A track which is assumed to be a friend because of its characteristics, behavior, or origin. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::AssumedFriend.
Friend	A track belonging to a declared friendly nation. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::Friend.
AssumedNeutral	A track which is assumed to be neither supporting nor opposing friendly forces because of its characteristics, behavior, or origin. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::AssumedNeutral.
Neutral	A track or contact whose characteristics, behavior, origin, or nationality indicate that it is neither supporting nor opposing friendly forces. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::Neutral.
Suspect	A track which is potentially hostile because of its characteristics, behavior, origin, or nationality. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::Suspect.
Hostile	A track declared to belong to any opposing nation, party, group, or entity, which by virtue of its behavior or information collected on it such as characteristics, origin or nationality contributes to the threat to friendly forces. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::Hostile.
ExercisePending	A friendly track acting as not being subjected to the identification process. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::ExercisePending.
ExerciseUnknown	A friendly track acting as a evaluated, but non-identified track for exercise purposes. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::ExerciseUnknown.
ExerciseAssumedFriend	A friendly track acting as an assumed friend for exercise purposes. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::ExerciseAssumedFriend.
ExerciseFriend	A friendly track acting as a friend for exercise purposes. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::ExerciseFriend.
ExerciseAssumedNeutral	A friendly track acting as assumed to be neither a supporting nor opposing track for exercise purposes. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::ExerciseAssumedNeutral.
ExerciseNeutral	A friendly track acting as neutral for exercise purposes. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::ExerciseNeutral.
Joker	A friendly track acting as a suspect for exercise purposes. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::Joker.
Faker	A friendly track acting as a hostile for exercise purposes. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Affiliation::Faker.

◆ Modifier

enum Luciad.Symbology.Military.MilitarySymbol.Modifier

Enumeration type for all available MIL-STD 2525 and APP-6 symbol modifiers.

Refer to the respective standard specifications for a detailed description of the symbol modifiers. Use MilitarySymbol to find out which modifiers are applicable to a specific symbol. Depending on the standard, a specific modifier needs its value to be encoded in the SIDC code (we call this an SIDC modifier) or as a separate value (we call this a text modifier).

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier.

Enumerator
Affiliation	Affiliation (SIDC modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Affiliation.
Status	Status (SIDC modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Status.
OrderOfBattle	Order Of Battle (SIDC modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::OrderOfBattle.
Sector1	Sector 1 (SIDC modifier). Applies only to APP-6C and APP-6D. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Sector1.
Sector2	Sector 2 (SIDC modifier). Applies only to APP-6C and APP-6D. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Sector2.
StandardIdentity1	Standard Identity 1 (SIDC modifier). Applies only to APP-6C and APP-6D. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::StandardIdentity1.
StandardIdentity2	Standard Identity 2 (SIDC modifier). Applies only to APP-6C and APP-6D. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::StandardIdentity2.
Echelon	Echelon (SIDC modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Echelon.
Mobility	Mobility (SIDC modifier). Applies only to APP-6C and APP-6D. The APP6 field(s): R Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Mobility.
Leadership	Leadership (SIDC modifier). Applies to APP-6D The APP6 field(s): D Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Leadership.
HqTaskForceDummy	Headquarters/Task Force/Dummy (SIDC modifier). Applies only to APP-6C and APP-6D. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::HqTaskForceDummy.
Quantity	The number of items present in an equipment symbol (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Quantity.
ReinforcedOrReduced	Whether or not a symbol is reinforced and/or reduced (test modifier). Possible values are 'R' for reinforced, 'D' for reduced, 'RD' for reinforced and reduced. The label will display (+), (-) and (土) respectively. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::ReinforcedOrReduced.
StaffComments	Staff comments for units, equipment and installations (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::StaffComments.
AdditionalInformation	Additional information for units, equipment and installations (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::AdditionalInformation.
EvaluationRating	Reliability and credibility rating for units, equipment, and installations (text modifier). Possible values consist of the following: Reliability rating: 'A' (completely reliable), 'B' (usually reliable), 'C' (fairly reliable), 'D' (not usually reliable) Credibility rating: '1' (confirmed by other sources), '2' (probably true), '3' (possibly true), '4' (doubtfully true), '5' (improbable), '6' (truth cannot be judged). Although both letters and numerals are used to indicate the evaluation of an item of information, they are independent of each other. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::EvaluationRating.
CombatEffectiveness	Unit effectiveness or installation capability (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::CombatEffectiveness.
SignatureEquipment	Signature for hostile equipment (text modifier). "!" indicates detectable electronic signatures. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::SignatureEquipment.
HigherFormation	Number or title of higher echelon command for a unit (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::HigherFormation.
Hostile	Hostile indicator for equipment. The letters "ENY" denote hostile symbols. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Hostile.
IffSif	IFF/SIF Identification modes and codes (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::IffSif.
MobilityIndicator	Mobility for equipment (SIDC modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::MobilityIndicator.
UniqueDesignation	Uniquely identifies a particular unit, equipment, or installation, or identifies the acquisition number when used with SIGINT symbology (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::UniqueDesignation.
TypeLabel	Type of equipment (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::TypeLabel.
DateTimeGroup	Date/time for units, equipment and installations (text modifier). Values are according to the Date/Time Group format "DDHHMMSSZMONYY". Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::DateTimeGroup.
AltitudeDepth	Altitude portion of GPS; flight level for aircraft; depth for submerged objects; height in feet of equipment or structures on the ground (text modifier for units, equipment, and installations). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::AltitudeDepth.
LocationLabel	A symbol's location in degrees, minutes, and seconds (or in UTM or other applicable display format) (text modifier for units, equipment, and installations). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::LocationLabel.
SpeedLabel	Velocity as set forth in MIL-STD-6040 (text modifier for units, equipment, and installations). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::SpeedLabel.
SpecialHeadquarters	The name of the special C2 headquarters (text modifier for units). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::SpecialHeadquarters.
PlatformType	Platform type (text modifier). Possible values are 'ELNOT' or 'CENOT'. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::PlatformType.
TeardownTime	Equipment teardown time in minutes (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::TeardownTime.
CommonIdentifier	Example: "Hawk" for Hawk SAM system (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::CommonIdentifier.
EffectiveTime	Effective time (text modifier). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::EffectiveTime.
MovementDirection	Direction of movement or intended movement of an object (text modifier for units, equipment, and installations). Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::MovementDirection.
Country	Country. For MIL-STD 2525b/c, this is an SIDC modifier, for other symbologies this is a text modifier with as possible value a three-letter code. The APP6 field(s): AC The MS2525 field(s): AS Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Country.
TrackNumber	Track number. Text modifier that applies to APP-6C air, maritime and space units. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::TrackNumber.
Name	Name. Text modifier that applies to APP-6C air, maritime and space units. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Name.
PositionAndMovement	Course [degrees] /Speed [knots] and/or Bearing [degrees] / Distance [nautical miles] Applies to APP-6C air, maritime and space units. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::PositionAndMovement.
Capacity	Capacity of installation displayed. Text modifier that applies to APP-6C land installations. The APP6 field(s): K Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Capacity.
HeadquartersElement	Headquarters element that is being represented, such as TOC, MAIN (text modifier). The APP6 field(s): AH Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::HeadquartersElement.
InstallationComposition	Component type of APP-6C land installations (text modifier). One of: Development Research Production Service Storage Utility The APP6 field(s): AI Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::InstallationComposition.
SpecialDesignator	Special designator (text modifier). One of 'NRT' or 'SIG'. The APP6 field(s): AR The MS2525 field(s): AR Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::SpecialDesignator.
GuardedUnit	Undefined or BG. The APP6 field(s): AQ The MS2525 field(s): AQ Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::GuardedUnit.
TargetDesignator	Used in Fire Support operations to uniquely designate targets in accordance with STANAG 2147. 6-character text modifier, where characters 1 and 2 are alphabetic, and characters 3-6 are numeric: 'AANNNN'. The MS2525 field(s): AP Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::TargetDesignator.
TargetNumberExtension	A sequentially assigned number identifying the individual elements in a target (STANAG 5519). A 2-3 character text modifier, where character 1 is a dash and characters 2-3 are numeric, from 1 through 15. It is applicable only to the “Point or Single Target” symbol, is conditional upon the presence of the Target Designator amplifier, and is visually displayed appended to the Target Number amplifier. The APP6 field(s): APX Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::TargetNumberExtension.
Attitude	Target attitude in degrees (text modifier). Defines the target orientation for rectangular target areas. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Attitude.
Length	Target length in meters (text modifier). Defines the total target length for rectangular target areas. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Length.
Width	Target width in meters (text modifier). Defines the total target width for rectangular target areas. Warning C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::Modifier::Width.

Member Function Documentation

◆ CopyAndChangeCode()

Luciad.Symbology.Military.MilitarySymbol Luciad.Symbology.Military.MilitarySymbol.CopyAndChangeCode ( string newCode )

inline

Creates a new military symbol based on the given code.

Modifiers of the current symbol are retained if they are still applicable and not overridden by the given code. For example, applying this function to an existing MIL-STD 2525b space track with code SUPP---—MYBEX by passing the code SFA*---—***** will return a new MIL-STD 2525b air track with code SFAP---—MYBEX.

newCode

code representing the new symbol type

a new military symbol of the given type, with the same modifiers as the current symbol (if not overridden)

luciad::InvalidArgumentException

when using an invalid code.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::copyAndChangeCode.

◆ CopyToFeature()

Luciad.Models.Features.Feature Luciad.Symbology.Military.MilitarySymbol.CopyToFeature	(	Luciad.Models.Features.Feature	feature,
		Luciad.Geometries.Geometry	geometry
	)

inline

Creates a new feature based on this military symbol and the given feature.

feature

the feature to apply the geometry to. The feature's data type should be the MilitaryDataModel::getSymbolType.

geometry

the geometry of the feature

a new military feature, or nullptr if the feature does not yet have a geometry

MilitaryDataModel

2020.1

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::copyToFeature.

◆ Create() [1/2]

Luciad.Symbology.Military.MilitarySymbol Luciad.Symbology.Military.MilitarySymbol.Create ( Luciad.Models.Features.Feature feature )

inlinestatic

Creates an editable military symbol based on the given Feature.

feature

the feature whose SIDC and modifiers should be used

a new symbol with the same SIDC and text modifiers as the given feature

MilitaryDataModel

luciad::InvalidArgumentException

if the military standard or code cannot be derived from the feature.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::create.

◆ Create() [2/2]

static Luciad.Symbology.Military.MilitarySymbol Luciad.Symbology.Military.MilitarySymbol.Create	(	Luciad.Symbology.Military.MilitarySymbology.Standard	standard,
		string	sidc
	)

inlinestatic

◆ Dispose()

void Luciad.Symbology.Military.MilitarySymbol.Dispose ( )

inline

◆ GetAffiliation()

Luciad.Symbology.Military.MilitarySymbol.Affiliation Luciad.Symbology.Military.MilitarySymbol.GetAffiliation ( )

inline

Returns the affiliation of this symbol.

This is a convenience method for directly retrieving the affiliation as an enum instance, as opposed to using getValue. the symbol's affiliation.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::getAffiliation.

◆ GetPossibleValues()

System.Collections.Generic.IList< string > Luciad.Symbology.Military.MilitarySymbol.GetPossibleValues ( Luciad.Symbology.Military.MilitarySymbol.Modifier modifier )

inline

Returns the possible values for a given modifier, if applicable.

modifier

the modifier whose values to return

the possible values for a given modifier, or std::nullopt if the possible values cannot be enumerated.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::getPossibleValues.

◆ GetValue()

string Luciad.Symbology.Military.MilitarySymbol.GetValue ( Luciad.Symbology.Military.MilitarySymbol.Modifier modifier )

inline

Returns the value for the given modifier.

Accepts both SIDC and text modifiers.

modifier

the modifier for which the value needs to be returned

the value associated to the given modifier (or std::nullopt if no value is associated with it)

luciad::InvalidArgumentException

when the modifier is invalid (the modifier is not part of the symbology).

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::getValue.

◆ PutValue()

void Luciad.Symbology.Military.MilitarySymbol.PutValue	(	Luciad.Symbology.Military.MilitarySymbol.Modifier	modifier,
		string	value
	)

inline

Sets the given (modifier,value) pair.

Accepts both SIDC and text modifiers. Multi-valued modifiers should be specified by joining the values with a colon character. For instance "value1" and "value2" should be combined as "value1:value2".

modifier

the key that identifies the text modifier

value

the value that will be associated with the text modifier

luciad::InvalidArgumentException

when the modifier is invalid (the modifier is not part of the symbology or the value is not part of the acceptable values).

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::putValue.

◆ ResetValue()

void Luciad.Symbology.Military.MilitarySymbol.ResetValue ( Luciad.Symbology.Military.MilitarySymbol.Modifier modifier )

inline

Resets the value associated with the given modifier.

If the modifier denotes an SIDC modifier, the value is reset to the default value, while for text modifiers, the associated value is simply removed (if any).

modifier

the key that identifies the text modifier.

luciad::InvalidArgumentException

when the modifier is invalid (the modifier is not part of the symbology).

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::resetValue.

◆ ToIcon()

Luciad.Drawing.IIcon Luciad.Symbology.Military.MilitarySymbol.ToIcon ( Luciad.Symbology.Military.MilitarySymbolStyle style )

inline

Creates an icon based on this military symbol and the given style.

Once this military symbol icon is created, its luciad::Image can be easily obtained using an luciad::IIconPainter. The following snippet shows an example:

style

the styling settings for visualizing this military symbol.

this military symbol icon.

luciad::LogicException

when this military symbol is not an MilitarySymbologyNode::SymbolType::Icon.

luciad::NullArgumentException

when passing nullptr for the style.

2023.0

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MilitarySymbol::toIcon.

Property Documentation

◆ Code

string Luciad.Symbology.Military.MilitarySymbol.Code

get

◆ Modifiers

System.Collections.Generic.IList<Luciad.Symbology.Military.MilitarySymbol.Modifier> Luciad.Symbology.Military.MilitarySymbol.Modifiers

get

◆ Node

Luciad.Symbology.Military.MilitarySymbologyNode Luciad.Symbology.Military.MilitarySymbol.Node

get

◆ SIDCModifiers

System.Collections.Generic.IList<Luciad.Symbology.Military.MilitarySymbol.Modifier> Luciad.Symbology.Military.MilitarySymbol.SIDCModifiers

get

◆ Standard

Luciad.Symbology.Military.MilitarySymbology.Standard Luciad.Symbology.Military.MilitarySymbol.Standard

get

◆ TextModifiers

System.Collections.Generic.IList<Luciad.Symbology.Military.MilitarySymbol.Modifier> Luciad.Symbology.Military.MilitarySymbol.TextModifiers

get

Public Types

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ Affiliation

◆ Modifier

Member Function Documentation

◆ CopyAndChangeCode()

◆ CopyToFeature()

◆ Create() [1/2]

◆ Create() [2/2]

◆ Dispose()

◆ GetAffiliation()

◆ GetPossibleValues()

◆ GetValue()

◆ PutValue()

◆ ResetValue()

◆ ToIcon()

Property Documentation

◆ Code

◆ Modifiers

◆ Node

◆ SIDCModifiers

◆ Standard

◆ TextModifiers