SignalReference Structure

Represents a signal that can be referenced by its constituent components.

Inheritance Hierarchy

SystemObject
SystemValueType
GSF.Units.EESignalReference

Namespace: GSF.Units.EE
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

C++

JavaScript

Copy

public struct SignalReference : IEquatable<SignalReference>, 
	IComparable<SignalReference>

Public Structure SignalReference
	Implements IEquatable(Of SignalReference), IComparable(Of SignalReference)

public value class SignalReference : IEquatable<SignalReference>, 
	IComparable<SignalReference>

[<SealedAttribute>]
type SignalReference = 
    struct
        inherit ValueType
        interface IEquatable<SignalReference>
        interface IComparable<SignalReference>
    end

JavaScript supports the use of structures, but not the declaration of new ones.

View Source

The SignalReference type exposes the following members.

Constructors

	Name	Description
	SignalReference	Creates a new SignalReference.

Top

Methods

	Name	Description
	CompareTo(Object)	Compares the current object with another object of the same type.
	CompareTo(SignalReference)	Compares the current object with another object of the same type.
	Equals(Object)	Indicates whether the current object is equal to another object of the same type. (Overrides ValueTypeEquals(Object))
	Equals(SignalReference)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Returns the hash code for this SignalReference. (Overrides ValueTypeGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	ToString	Returns a String that represents the current SignalReference. (Overrides ValueTypeToString)
	ToString(String, SignalKind)	Returns a String that represents the specified acronym and SignalKind.
	ToString(String, SignalKind, Int32)	Returns a String that represents the specified acronym, SignalKind and index.

Top

Operators

	Name	Description
	Equality(SignalReference, SignalReference)	Compares two SignalReference values for equality.
	GreaterThan(SignalReference, SignalReference)	Returns true if left SignalReference value is greater than right SignalReference value.
	GreaterThanOrEqual(SignalReference, SignalReference)	Returns true if left SignalReference value is greater than or equal to right SignalReference value.
	Inequality(SignalReference, SignalReference)	Compares two SignalReference values for inequality.
	LessThan(SignalReference, SignalReference)	Returns true if left SignalReference value is less than right SignalReference value.
	LessThanOrEqual(SignalReference, SignalReference)	Returns true if left SignalReference value is less than or equal to right SignalReference value.

Top

Fields

	Name	Description
	Acronym	Gets or sets the acronym of this SignalReference.
	CellIndex	Gets or sets the cell index, if applicable, of this SignalReference.
	Index	Gets or sets the signal index of this SignalReference.
	Kind	Gets or sets the SignalKind of this SignalReference.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF.Units.EE Namespace