Class HardwareVersion

This class represents the hardware version number of an XBee device.

Inheritance

System.Object

HardwareVersion

Implements

System.IEquatable<HardwareVersion>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: XBeeLibrary.Core.Models

Assembly: XBeeLibrary.Core.dll

Syntax

public class HardwareVersion : IEquatable<HardwareVersion>

Properties

Description

The Hardware version description.

Declaration

public string Description { get; }

Property Value

Type	Description
System.String

Value

The Hardware version numeric value.

Declaration

public int Value { get; }

Property Value

Type	Description
System.Int32

Methods

Equals(Object)

Returns whether this object is equal to the given one.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	Object to compare if it is equal to the caller one.

Returns

Type	Description
System.Boolean	true if the caller/this object is equal to obj, false otherwise.

Overrides

System.Object.Equals(System.Object)

Equals(HardwareVersion)

Returns whether this HardwareVersion is equal to the given one.

Declaration

public bool Equals(HardwareVersion other)

Parameters

Type	Name	Description
HardwareVersion	other	HardwareVersion to compare if it is equal to the caller one.

Returns

Type	Description
System.Boolean	true if the caller/this object is equal to other, false otherwise.

Get(Int32)

Gets the HardwareVersion object associated to the given numeric value.

Declaration

public static HardwareVersion Get(int value)

Parameters

Type	Name	Description
System.Int32	value	Numeric value of the HardwareVersion retrieve.

Returns

Type	Description
HardwareVersion	The HardwareVersion associated to the specified value, null if there is not any HardwareVersion with the value.

Get(Int32, String)

Gets the HardwareVersion object associated to the specified numeric value and description.

Declaration

public static HardwareVersion Get(int value, string description)

Parameters

Type	Name	Description
System.Int32	value	Numeric value of the HardwareVersion retrieve.
System.String	description	Description of the HardwareVersion retrieve.

Returns

Type	Description
HardwareVersion	The HardwareVersion associated to the given value and description

Exceptions

Type	Condition
System.ArgumentNullException	if description is null.
System.ArgumentException	if value < 0 or Length of description is lower than 1.

GetHashCode()

Returns the Hash code of this object.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	The Hash code of this object.

Overrides

System.Object.GetHashCode()

ToString()

Returns a string representation of this object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string representation of this object.

Overrides

System.Object.ToString()

Implements

System.IEquatable<T>