Class LogixEnum<TEnum, TValue>

Namespace

L5Sharp

Assembly

L5Sharp.dll

A base class for all logix enumeration types.

public abstract class LogixEnum<TEnum, TValue> : IEquatable<LogixEnum<TEnum, TValue>>, IComparable<LogixEnum<TEnum, TValue>> where TEnum : LogixEnum<TEnum, TValue> where TValue : IEquatable<TValue>, IComparable<TValue>

Type Parameters

TEnum

The type that is inheriting from this class.

TValue

The type of the inner value.

Inheritance

object

LogixEnum<TEnum, TValue>

Implements

IEquatable<LogixEnum<TEnum, TValue>>

IComparable<LogixEnum<TEnum, TValue>>

Derived

CaptureSizeType

ConnectionPriority

ConnectionType

DataFormat

DataTypeClass

DataTypeFamily

ElectronicKeying

ExternalAccess

Function

Instruction

ModuleCategory

OnlineEditType

Operator

PassThroughOption

PenType

ProductionTrigger

ProgramType

Radix

RoutineType

RungType

SamplesType

Scope

SFCExecutionControl

SFCLastScan

SFCRestartPosition

SheetOrientation

SheetSize

TagType

TagUsage

TaskEventTrigger

TaskType

TransmissionType

TriggerOperation

TriggerTargetType

TriggerType

Use

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

This code was taken from https://github.com/ardalis/SmartEnum and modified to suit needs of this library. Wanted to remove and external dependencies and not rely on other packages. This class provided some base functionality for working with a logix enum type. This includes methods for retrieving all enums of a specified type, and parsing enums from a name or value.

Constructors

LogixEnum(string, TValue)

Creates an enumeration with the specified name and value.

protected LogixEnum(string name, TValue value)

Parameters

name string

The common name of the enumeration option.

value TValue

The corresponding value of the enumeration option.

Exceptions

ArgumentNullException

name or value are null.

Properties

Name

The display name of the enumeration type.

public string Name { get; }

Property Value

string

A string common enumeration field name.

Value

The value of the enumeration type.

public TValue Value { get; }

Property Value

TValue

A value of the specified enumeration type.

Methods

All()

Returns all enumeration options for the specified enumeration type.

public static IEnumerable<TEnum> All()

Returns

IEnumerable<TEnum>

An IEnumerable<T> containing all enumeration values of the specified type.

CompareTo(LogixEnum<TEnum, TValue>)

Compares this instance to a specified LogixEnum<TEnum, TValue> and returns an indication of their relative values.

public virtual int CompareTo(LogixEnum<TEnum, TValue> other)

Parameters

other LogixEnum<TEnum, TValue>

An LogixEnum<TEnum, TValue> value to compare to this instance.

Returns

int

A signed number indicating the relative values of this instance and other.

Equals(LogixEnum<TEnum, TValue>?)

Returns a value indicating whether this instance is equal to a specified LogixEnum<TEnum, TValue> value.

public virtual bool Equals(LogixEnum<TEnum, TValue>? other)

Parameters

other LogixEnum<TEnum, TValue>

An LogixEnum<TEnum, TValue> value to compare to this instance.

Returns

bool

true if other has the same value as this instance; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

FromName(string, bool)

Gets the item associated with the specified name.

public static TEnum FromName(string name, bool ignoreCase = false)

Parameters

name string

The name of the item to get.

ignoreCase bool

true to ignore case during the comparison; otherwise, false.

Returns

TEnum

The item associated with the specified name. If the specified name is not found, throws a KeyNotFoundException.

Exceptions

ArgumentException

name is null.

KeyNotFoundException

name does not exist.

See Also

TryFromName(string?, out TEnum?)

TryFromName(string?, bool, out TEnum?)

FromValue(TValue)

Gets an item associated with the specified value.

public static TEnum FromValue(TValue value)

Parameters

value TValue

The value of the item to get.

Returns

TEnum

The first item found that is associated with the specified value. If the specified value is not found, throws a KeyNotFoundException.

Exceptions

KeyNotFoundException

value does not exist.

See Also

FromValue(TValue, TEnum)

TryFromValue(TValue?, out TEnum?)

FromValue(TValue, TEnum)

Gets an item associated with the specified value.

public static TEnum FromValue(TValue value, TEnum defaultValue)

Parameters

value TValue

The value of the item to get.

defaultValue TEnum

The value to return when item not found.

Returns

TEnum

The first item found that is associated with the specified value. If the specified value is not found, returns defaultValue.

See Also

FromValue(TValue)

TryFromValue(TValue?, out TEnum?)

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

TryFromName(string?, bool, out TEnum?)

Gets the item associated with the specified name.

public static bool TryFromName(string? name, bool ignoreCase, out TEnum? result)

Parameters

name string

The name of the item to get.

ignoreCase bool

true to ignore case during the comparison; otherwise, false.

result TEnum

When this method returns, contains the item associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized.

Returns

bool

true if the LogixEnum<TEnum, TValue> contains an item with the specified name; otherwise, false.

Exceptions

ArgumentException

name is null.

See Also

FromName(string, bool)

TryFromName(string?, out TEnum?)

TryFromName(string?, out TEnum?)

Gets the item associated with the specified name.

public static bool TryFromName(string? name, out TEnum? result)

Parameters

name string

The name of the item to get.

result TEnum

When this method returns, contains the item associated with the specified name, if the key is found; otherwise, null. This parameter is passed uninitialized.

Returns

bool

true if the LogixEnum<TEnum, TValue> contains an item with the specified name; otherwise, false.

Exceptions

ArgumentException

name is null.

See Also

FromName(string, bool)

TryFromName(string?, bool, out TEnum?)

TryFromValue(TValue?, out TEnum?)

Gets an item associated with the specified value.

public static bool TryFromValue(TValue? value, out TEnum? result)

Parameters

value TValue

The value of the item to get.

result TEnum

When this method returns, contains the item associated with the specified value, if the value is found; otherwise, null. This parameter is passed uninitialized.

Returns

bool

true if the LogixEnum<TEnum, TValue> contains an item with the specified name; otherwise, false.

See Also

FromValue(TValue)

FromValue(TValue, TEnum)

Operators

operator ==(LogixEnum<TEnum, TValue>, LogixEnum<TEnum, TValue>)

Performs equality check on the provided LogixEnum<TEnum, TValue> types.

public static bool operator ==(LogixEnum<TEnum, TValue> left, LogixEnum<TEnum, TValue> right)

Parameters

left LogixEnum<TEnum, TValue>

An instance of the enumeration to check.

right LogixEnum<TEnum, TValue>

An instance of the enumeration to check.

Returns

bool

true if the types are equal; otherwise, false.

explicit operator LogixEnum<TEnum, TValue>(TValue)

public static explicit operator LogixEnum<TEnum, TValue>(TValue value)

Parameters

value TValue

Returns

LogixEnum<TEnum, TValue>

operator >(LogixEnum<TEnum, TValue>, LogixEnum<TEnum, TValue>)

Compares this instance to a specified LogixEnum<TEnum, TValue> and returns an indication if left is greater than right.

public static bool operator >(LogixEnum<TEnum, TValue> left, LogixEnum<TEnum, TValue> right)

Parameters

left LogixEnum<TEnum, TValue>

An instance of LogixEnum<TEnum, TValue> to compare.

right LogixEnum<TEnum, TValue>

An instance of LogixEnum<TEnum, TValue> to compare.

Returns

bool

true if left is greater than right.

operator >=(LogixEnum<TEnum, TValue>, LogixEnum<TEnum, TValue>)

Compares this instance to a specified LogixEnum<TEnum, TValue> and returns an indication if left is greater than or equal to right.

public static bool operator >=(LogixEnum<TEnum, TValue> left, LogixEnum<TEnum, TValue> right)

Parameters

left LogixEnum<TEnum, TValue>

An instance of LogixEnum<TEnum, TValue> to compare.

right LogixEnum<TEnum, TValue>

An instance of LogixEnum<TEnum, TValue> to compare.

Returns

bool

true if left is greater than or equal to right.

implicit operator TValue(LogixEnum<TEnum, TValue>)

Implicitly converts the provided LogixEnum<TEnum, TValue> to the underlying value.

public static implicit operator TValue(LogixEnum<TEnum, TValue> logixEnum)

Parameters

logixEnum LogixEnum<TEnum, TValue>

The enumeration type.

Returns

TValue

A value representing the

operator !=(LogixEnum<TEnum, TValue>, LogixEnum<TEnum, TValue>)

Performs equality check on the provided LogixEnum<TEnum, TValue> types.

public static bool operator !=(LogixEnum<TEnum, TValue> left, LogixEnum<TEnum, TValue> right)

Parameters

left LogixEnum<TEnum, TValue>

An instance of the enumeration to check.

right LogixEnum<TEnum, TValue>

An instance of the enumeration to check.

Returns

bool

true if the types are NOT equal; otherwise, false.

operator <(LogixEnum<TEnum, TValue>, LogixEnum<TEnum, TValue>)

Compares this instance to a specified LogixEnum<TEnum, TValue> and returns an indication if left is less than right.

public static bool operator <(LogixEnum<TEnum, TValue> left, LogixEnum<TEnum, TValue> right)

Parameters

left LogixEnum<TEnum, TValue>

An instance of LogixEnum<TEnum, TValue> to compare.

right LogixEnum<TEnum, TValue>

An instance of LogixEnum<TEnum, TValue> to compare.

Returns

bool

true if left is less than right.

operator <=(LogixEnum<TEnum, TValue>, LogixEnum<TEnum, TValue>)

Compares this instance to a specified LogixEnum<TEnum, TValue> and returns an indication if left is less than or equal to right.

public static bool operator <=(LogixEnum<TEnum, TValue> left, LogixEnum<TEnum, TValue> right)

Parameters

left LogixEnum<TEnum, TValue>

An instance of LogixEnum<TEnum, TValue> to compare.

right LogixEnum<TEnum, TValue>

An instance of LogixEnum<TEnum, TValue> to compare.

Returns

bool

true if left is less than or equal to right.