ISnpReaderSkipToChromosomePosition Method (Int32, Int32) |
This moves the cursor to the current/next SNP item containing the given
chromosome number and position
(i.e. Current.Chromosome == chromosomeNumber and Current.Position == position),
or beyond the end of the enumerator if none exist.
The enumerator should be positioned at or after the first item and at
or before the last item.
NOTE: This is useful when traversing sorted SNP sequences and need to jump to a
specific chromosome number+position.
Namespace: Bio.IOAssembly: Bio.Core (in Bio.Core.dll) Version: 2.0.0.1 (2.0.0.1)
Syntax bool SkipToChromosomePosition(
int chromosomeNumber,
int position
)
Function SkipToChromosomePosition (
chromosomeNumber As Integer,
position As Integer
) As Boolean
bool SkipToChromosomePosition(
int chromosomeNumber,
int position
)
abstract SkipToChromosomePosition :
chromosomeNumber : int *
position : int -> bool
Parameters
- chromosomeNumber
- Type: SystemInt32
The chromosome number for the Snpitem to move to. - position
- Type: SystemInt32
The position within chromosome number for the Snpitem to move to.
Return Value
Type:
BooleanReturns true if a SnpItem with given chromosome number and position is found.
If end of file is reached before this they are found, it returns false.
If returning true, the Current item will have given chromosome number and position.
Exceptions Exception | Condition |
---|
InvalidOperationException |
The enumerator is positioned before the first element of the collection or after the last element.
|
See Also