| SequenceRange Class |
A SequenceRange holds the data necessary to represent a region within
a sequence defined by its start and end index without necessarily holding
any of the sequence item data. At a minimum and ID, start index, and end
index are required. Additional metadata can be stored as well using a
generic key value pair.
Inheritance HierarchyNamespace: Bio
Assembly: Bio.Core (in Bio.Core.dll) Version: 2.0.0.1 (2.0.0.1)
SyntaxThe SequenceRange type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SequenceRange |
Default constructor that does not set any fields.
|
| SequenceRange(String, Int64, Int64) |
Data constructor that sets the most commonly used fields.
Note that if the end value is less than start value then the end values is assigned to the start value.
|
Properties| Name | Description | |
|---|---|---|
 | End |
The end index of the range. This index must be non-negative and
it will be enforced to always be greater than or equal to the Start index.
|
| ID |
A string identifier of the sequence range.
|
| Length |
The length of the range, which can be zero. This result is the
difference of the End and Start index.
|
| Metadata |
Optional additional data to store along with the ID and indices of
the range. Metadata must be stored with a string key name.
|
| ParentSeqRanges |
Gets the sequence ranges from which this sequence range is obtained.
This property will be filled by the operations like Merge, Intersect etc.
|
| Start |
The beginning index of the range. This index must be non-negative and
it will be enforced to always be less than or equal to the End index.
|
Methods| Name | Description | |
|---|---|---|
| CompareTo(Object) |
Compares two sequence ranges.
|
| CompareTo(ISequenceRange) |
Compares two sequence ranges.
|
| Equals |
Overrides the equal method
(Overrides ObjectEquals(Object).) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode |
Overrides hash function for a particular type.
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
Converts ID, Start, End of the sequence to string.
(Overrides ObjectToString.) |
Operators| Name | Description | |
|---|---|---|
  | Equality |
Override equal operator
|
| GreaterThan |
Override greater than operator
|
| Inequality |
Override not equal operator
|
| LessThan |
Override less than operator
|
See Also