Milsymbol SIDC: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
== Milsymbol SIDC Utility == | == Milsymbol SIDC Utility == | ||
The "SIDCUtils" class in namespace "TPG.GDK.CommonCore.MilSym", provides methods for updating the SIDC with standard identity, tactical status, amplifiers, headquarters/task force dummy. | The "SIDCUtils" class in namespace "TPG.GDK.CommonCore.MilSym", provides methods for updating the SIDC with standard identity, tactical status, amplifiers, headquarters/task force dummy. It also provides methods for retrieving the standard identity, tactical status, amplifiers, and headquarters/task force dummy, from a SIDC. | ||
=== Utility methods === | === Utility methods === | ||
Line 12: | Line 12: | ||
// Update standard identity in sidc. | // Update standard identity in sidc. | ||
string SetStandardIdentity(string sidc, StandardIdentity standardIdentity) | string SetStandardIdentity(string sidc, StandardIdentity standardIdentity) | ||
// Get standard identity from sidc. | |||
StandardIdentity GetStandardIdentity(string sidc) | |||
// Update tactcal status in sidc. | // Update tactcal status in sidc. | ||
string SetStatus(string sidc, TacticalStatus tacticalStatus) | string SetStatus(string sidc, TacticalStatus tacticalStatus) | ||
/// Update amplifier in sidc. | // Get tactcal status from sidc. | ||
TacticalStatus GetStatus(string sidc) | |||
// Update amplifier in sidc. | |||
string SetAmplifier(string sidc, Echelon echelon) | string SetAmplifier(string sidc, Echelon echelon) | ||
/// Update headquarters/task force dummy in sidc. | // Get amplifier from sidc. | ||
Echelon GetAmplifier(string sidc) | |||
// Update headquarters/task force dummy in sidc. | |||
string SetHeadquartersTaskForceDummy(string sidc, HeadquartersTaskForceDummy headquartersTaskForceDummy) | string SetHeadquartersTaskForceDummy(string sidc, HeadquartersTaskForceDummy headquartersTaskForceDummy) | ||
// Get headquarters/task force dummy from sidc. | |||
HeadquartersTaskForceDummy GetHeadquartersTaskForceDummy(string sidc) | |||
</source> | </source> | ||
Line 30: | Line 42: | ||
var sidc = ...; | var sidc = ...; | ||
sidc = SIDCUtils.SetAmplifier(sidc, Echelon.Brigade); | sidc = SIDCUtils.SetAmplifier(sidc, Echelon.Brigade); | ||
// Get amplifier | |||
var sidc = ...; | |||
var amplifier = SIDCUtils.GetAmplifier(sidc); | |||
// Update standard identity | // Update standard identity | ||
var sidc = ...; | var sidc = ...; | ||
sidc = SIDCUtils.SetStandardIdentity(sidc, StandardIdentity.Friendly); | sidc = SIDCUtils.SetStandardIdentity(sidc, StandardIdentity.Friendly); | ||
// Get standard identity | |||
var sidc = ...; | |||
var standardIdentity = SIDCUtils.GetStandardIdentity(sidc); | |||
// Update tactical status | // Update tactical status | ||
var sidc = ...; | var sidc = ...; | ||
sidc = SIDCUtils.SetStatus(sidc, TacticalStatus.Planned); | sidc = SIDCUtils.SetStatus(sidc, TacticalStatus.Planned); | ||
// Get tactical status | |||
var sidc = ...; | |||
var tacticalStatus = SIDCUtils.GetStatus(sidc); | |||
// Update headquarters/task force dummy | // Update headquarters/task force dummy | ||
var sidc = ...; | var sidc = ...; | ||
sidc = SIDCUtils.SetHeadquartersTaskForceDummy(sidc, HeadquartersTaskForceDummy.Headquarters); | sidc = SIDCUtils.SetHeadquartersTaskForceDummy(sidc, HeadquartersTaskForceDummy.Headquarters); | ||
// Get headquarters/task force dummy | |||
var sidc = ...; | |||
var hq = SIDCUtils.GetHeadquartersTaskForceDummy(sidc); | |||
// Clean sidc | // Clean sidc |
Latest revision as of 13:50, 25 April 2025
Milsymbol SIDC Utility
The "SIDCUtils" class in namespace "TPG.GDK.CommonCore.MilSym", provides methods for updating the SIDC with standard identity, tactical status, amplifiers, headquarters/task force dummy. It also provides methods for retrieving the standard identity, tactical status, amplifiers, and headquarters/task force dummy, from a SIDC.
Utility methods
// Removes standard identity, tactcal status, amplifiers and headquarters/task force dummy from sidc, so that it can be used for lookup in GDK.
string CleanSIDC(string sidc)
// Check if sidc is APP6D sidc.
bool IsSIDC(string sidc)
// Update standard identity in sidc.
string SetStandardIdentity(string sidc, StandardIdentity standardIdentity)
// Get standard identity from sidc.
StandardIdentity GetStandardIdentity(string sidc)
// Update tactcal status in sidc.
string SetStatus(string sidc, TacticalStatus tacticalStatus)
// Get tactcal status from sidc.
TacticalStatus GetStatus(string sidc)
// Update amplifier in sidc.
string SetAmplifier(string sidc, Echelon echelon)
// Get amplifier from sidc.
Echelon GetAmplifier(string sidc)
// Update headquarters/task force dummy in sidc.
string SetHeadquartersTaskForceDummy(string sidc, HeadquartersTaskForceDummy headquartersTaskForceDummy)
// Get headquarters/task force dummy from sidc.
HeadquartersTaskForceDummy GetHeadquartersTaskForceDummy(string sidc)
Examples of Usage
These examples show how to use the utility methods.
// Update amplifier
var sidc = ...;
sidc = SIDCUtils.SetAmplifier(sidc, Echelon.Brigade);
// Get amplifier
var sidc = ...;
var amplifier = SIDCUtils.GetAmplifier(sidc);
// Update standard identity
var sidc = ...;
sidc = SIDCUtils.SetStandardIdentity(sidc, StandardIdentity.Friendly);
// Get standard identity
var sidc = ...;
var standardIdentity = SIDCUtils.GetStandardIdentity(sidc);
// Update tactical status
var sidc = ...;
sidc = SIDCUtils.SetStatus(sidc, TacticalStatus.Planned);
// Get tactical status
var sidc = ...;
var tacticalStatus = SIDCUtils.GetStatus(sidc);
// Update headquarters/task force dummy
var sidc = ...;
sidc = SIDCUtils.SetHeadquartersTaskForceDummy(sidc, HeadquartersTaskForceDummy.Headquarters);
// Get headquarters/task force dummy
var sidc = ...;
var hq = SIDCUtils.GetHeadquartersTaskForceDummy(sidc);
// Clean sidc
var sidc = ...;
sidc = SIDCUtils.CleanSIDC(sidc);
// Check if sidc is APP6D
var sidc = ...;
var isSidc = SIDCUtils.IsSIDC(sidc);