A class that stores a numeric range.
More...
Inherits IFormattable.
A class that stores a numeric range.
UnifiedAutomation.UaBase.NumericRange.NumericRange |
( |
int |
begin | ) |
|
|
inline |
Initializes the object with a begin index.
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.
Initializes the object with a begin and end indexes.
- Parameters
-
begin | The end of the range |
end | The beginning of the range |
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
-
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.
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.
Returns a suitable hash code for the object.
Returns true if the objects are not equal.
Returns true if the objects are not equal.
- Parameters
-
value1 | The first value to compare |
value2 | The second value to compare |
Returns true if the objects are equal.
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.
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.
Returns the string representation of the object.
string UnifiedAutomation.UaBase.NumericRange.ToString |
( |
string |
format, |
|
|
IFormatProvider |
formatProvider |
|
) |
| |
|
inline |
Formats the numeric range as a string.
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.
int UnifiedAutomation.UaBase.NumericRange.Begin |
|
getset |
The begining of the numeric range.
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.
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.
An empty numeric range.
An empty numeric range.
int UnifiedAutomation.UaBase.NumericRange.End |
|
getset |
The end of the numeric range.
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:
- D:/work/uasdknet_master/src/UaBase/BuiltIn/NumericRange.cs