IFlagPriorityProvider Interface
Finds and compares priorities of Flag instances.
public interface IFlagPriorityProviderMethods
Section titled “Methods”IFlagPriorityProvider.ComparePriorities(Flag, Flag) Method
Section titled “IFlagPriorityProvider.ComparePriorities(Flag, Flag) Method”Compares two instances of Flag based on their respective priorities.
int ComparePriorities(HAKOM.TSM.Net.Api.Flags.Flag left, HAKOM.TSM.Net.Api.Flags.Flag right);Parameters
Section titled “Parameters”left Flag
The Flag to compare right with.
right Flag
The Flag that is being compared to left.
Returns
Section titled “Returns”System.Int32
0 if both flags have the same priority, -1 if left has a lower priority, 1 otherwise.
IFlagPriorityProvider.GetPriority(Flag) Method
Section titled “IFlagPriorityProvider.GetPriority(Flag) Method”Returns the priority for the given flag.
int GetPriority(HAKOM.TSM.Net.Api.Flags.Flag flag);Parameters
Section titled “Parameters”flag Flag
The Flag to resolve the priority value for.
Returns
Section titled “Returns”System.Int32
The priority of the given Flag.
IFlagPriorityProvider.HighestPriorityFlag(Flag[]) Method
Section titled “IFlagPriorityProvider.HighestPriorityFlag(Flag[]) Method”Returns the Flag with the highest priority of the ones given in flags.
HAKOM.TSM.Net.Api.Flags.Flag HighestPriorityFlag(params HAKOM.TSM.Net.Api.Flags.Flag[] flags);Parameters
Section titled “Parameters”The list of Flags to go through.
Returns
Section titled “Returns”Flag
The flag within flags with the highest priority
IFlagPriorityProvider.HighestPriorityFlag(IEnumerable<Flag>) Method
Section titled “IFlagPriorityProvider.HighestPriorityFlag(IEnumerable<Flag>) Method”Returns the Flag with the highest priority of the ones given in flags.
HAKOM.TSM.Net.Api.Flags.Flag HighestPriorityFlag(System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag> flags);Parameters
Section titled “Parameters”flags System.Collections.Generic.IEnumerable<Flag>
The list of Flags to go through.
Returns
Section titled “Returns”Flag
The flag within flags with the highest priority
IFlagPriorityProvider.LowestPriorityFlag(Flag[]) Method
Section titled “IFlagPriorityProvider.LowestPriorityFlag(Flag[]) Method”Returns the Flag with the lowest priority of the ones given in flags.
HAKOM.TSM.Net.Api.Flags.Flag LowestPriorityFlag(params HAKOM.TSM.Net.Api.Flags.Flag[] flags);Parameters
Section titled “Parameters”The list of Flags to go through.
Returns
Section titled “Returns”Flag
The flag within flags with the lowest priority.
IFlagPriorityProvider.LowestPriorityFlag(IEnumerable<Flag>) Method
Section titled “IFlagPriorityProvider.LowestPriorityFlag(IEnumerable<Flag>) Method”Returns the Flag with the lowest priority of the ones given in flags.
HAKOM.TSM.Net.Api.Flags.Flag LowestPriorityFlag(System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag> flags);Parameters
Section titled “Parameters”flags System.Collections.Generic.IEnumerable<Flag>
The list of Flags to go through.
Returns
Section titled “Returns”Flag
The flag within flags with the lowest priority.
IFlagPriorityProvider.TryGetPriority(Flag, int) Method
Section titled “IFlagPriorityProvider.TryGetPriority(Flag, int) Method”Tries to return the correct priority priority for the given flag.
bool TryGetPriority(HAKOM.TSM.Net.Api.Flags.Flag flag, out int priority);Parameters
Section titled “Parameters”flag Flag
The Flag for which a priority is requested.
priority System.Int32
If successfully mapped, contains the priority of the given flag. Otherwise it should return 0.
Returns
Section titled “Returns”System.Boolean
True if the mapping can successfully map the given Flag to a priority value. False otherwise