A class that stores a numeric range. More...

Inherits IFormattable.

Public Member Functions
	NumericRange (int begin)
	Initializes the object with a begin index. More...

	NumericRange (int begin, int end)
	Initializes the object with a begin and end indexes. More...

bool	EnsureValid (object value)
	Ensures the bounds are valid values for the object passed in. More...

bool	EnsureValid (int count)
	Ensures the bounds are valid values for a collection with the specified length. More...

override bool	Equals (object obj)
	Returns true if the objects are equal. More...

override int	GetHashCode ()
	Returns a suitable hash code for the object. More...

override string	ToString ()
	Returns the string representation of the object. More...

string	ToString (string format, IFormatProvider formatProvider)
	Formats the numeric range as a string. More...

StatusCode	UpdateRange (ref object dst, object src)
	Applies the multidimensional index range. More...

StatusCode	ApplyRange (ref object value)
	Applys the index range to an array value. More...

Static Public Member Functions
static bool	operator== (NumericRange value1, NumericRange value2)
	Returns true if the objects are equal. More...

static bool	operator!= (NumericRange value1, NumericRange value2)
	Returns true if the objects are not equal. More...

static StatusCode	Validate (string textToParse, out NumericRange range)
	Parses a string representing a numeric range. More...

static NumericRange	Parse (string textToParse)
	Parses a string representing a numeric range. More...

Properties
int	Begin `[get, set]`
	The begining of the numeric range. More...

int	End `[get, set]`
	The end of the numeric range. More...

int	Count `[get]`
	The number of elements specified by the range. More...

int	Dimensions `[get]`
	Gets the number of dimensions in the range. More...

NumericRange[]	SubRanges `[get, set]`
	Gets or sets the sub ranges for multidimensional ranges. More...

bool	IsEmpty `[get]`
	Gets a value indicating whether this instance is null. More...

static NumericRange	Empty `[get]`
	An empty numeric range. More...

Detailed Description

A class that stores a numeric range.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.NumericRange.NumericRange ( int begin )

inline

Initializes the object with a begin index.

Parameters

begin The starting point of the range

Exceptions

ArgumentOutOfRangeException Thrown when the parameter is less than -1

UnifiedAutomation.UaBase.NumericRange.NumericRange	(	int	begin,
		int	end
	)

inline

Initializes the object with a begin and end indexes.

Parameters

begin	The end of the range
end	The beginning of the range

Member Function Documentation

StatusCode UnifiedAutomation.UaBase.NumericRange.ApplyRange ( ref object value )

inline

Applys the index range to an array value.

Replaces the value

Parameters

value The array to subset.

Returns: The reason for the failure if the range could not be applied.

bool UnifiedAutomation.UaBase.NumericRange.EnsureValid ( object value )

inline

Ensures the bounds are valid values for the object passed in.

Returns false if the object is not indexable or if the numeric range is out-of-bounds.

Parameters

value The value to check

bool UnifiedAutomation.UaBase.NumericRange.EnsureValid ( int count )

inline

Ensures the bounds are valid values for a collection with the specified length.

Returns false if the numeric range is out-of-bounds.

Parameters

count The value to check is within range

override bool UnifiedAutomation.UaBase.NumericRange.Equals ( object obj )

inline

Returns true if the objects are equal.

Parameters

obj	The object to test against this

override int UnifiedAutomation.UaBase.NumericRange.GetHashCode ( )

inline

Returns a suitable hash code for the object.

static bool UnifiedAutomation.UaBase.NumericRange.operator!=	(	NumericRange	value1,
		NumericRange	value2
	)

inlinestatic

Returns true if the objects are not equal.

Parameters

value1	The first value to compare
value2	The second value to compare

static bool UnifiedAutomation.UaBase.NumericRange.operator==	(	NumericRange	value1,
		NumericRange	value2
	)

inlinestatic

Returns true if the objects are equal.

Parameters

value1	The first value to compare
value2	The second value to compare

static NumericRange UnifiedAutomation.UaBase.NumericRange.Parse ( string textToParse )

inlinestatic

Parses a string representing a numeric range.

Parameters

textToParse The text to parse, prior to checking it is within the allowed range

Exceptions

StatusException Thrown when the numeric value of the parsed text is out of range

override string UnifiedAutomation.UaBase.NumericRange.ToString ( )

inline

Returns the string representation of the object.

string UnifiedAutomation.UaBase.NumericRange.ToString	(	string	format,
		IFormatProvider	formatProvider
	)

inline

Formats the numeric range as a string.

Parameters

format	(Unused) Always pass NULL/NOTHING
formatProvider	(Unused) Always pass NULL/NOTHING

Exceptions

FormatException Thrown when a non null/nothing is passed for either parameter

StatusCode UnifiedAutomation.UaBase.NumericRange.UpdateRange	(	ref object	dst,
		object	src
	)

inline

Applies the multidimensional index range.

static StatusCode UnifiedAutomation.UaBase.NumericRange.Validate	(	string	textToParse,
		out NumericRange	range
	)

inlinestatic

Parses a string representing a numeric range.

Parameters

textToParse	The text to parse, prior to checking it is within the allowed range
range	The parsed range.

Returns: The reason for any error.

Property Documentation

int UnifiedAutomation.UaBase.NumericRange.Begin

getset

The begining of the numeric range.

Exceptions

ArgumentOutOfRangeException Thrown when the value is less than -1, or when the value is greater than the end

int UnifiedAutomation.UaBase.NumericRange.Count

get

The number of elements specified by the range.

int UnifiedAutomation.UaBase.NumericRange.Dimensions

get

Gets the number of dimensions in the range.

The number of dimensions.

NumericRange UnifiedAutomation.UaBase.NumericRange.Empty

staticget

An empty numeric range.

int UnifiedAutomation.UaBase.NumericRange.End

getset

The end of the numeric range.

Exceptions

ArgumentOutOfRangeException Thrown when the value is less than -1 or when the end is less than the beginning

bool UnifiedAutomation.UaBase.NumericRange.IsEmpty

get

Gets a value indicating whether this instance is null.

true if this instance is null; otherwise, false.

NumericRange [] UnifiedAutomation.UaBase.NumericRange.SubRanges

getset

Gets or sets the sub ranges for multidimensional ranges.

The sub ranges.

The documentation for this struct was generated from the following file:

C:/work/uasdknet/src/UaBase/BuiltIn/NumericRange.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation