ISnpReaderSkipToChromosome Method |
This moves the cursor to the current/next SNP item containing the given
chromosome number (i.e. Current.Chromosome == chromosomeNumber),
or beyond the end of the enumerator if none exist.
This is useful when traversing sorted SNP sequences and we need to
jump to a specific chromosome number.
The enumerator should be positioned at or after the first item and at or before the last item.
Namespace: Bio.IOAssembly: Bio.Core (in Bio.Core.dll) Version: 2.0.0.1 (2.0.0.1)
Syntax bool SkipToChromosome(
int chromosomeNumber
)
Function SkipToChromosome (
chromosomeNumber As Integer
) As Boolean
bool SkipToChromosome(
int chromosomeNumber
)
abstract SkipToChromosome :
chromosomeNumber : int -> bool
Parameters
- chromosomeNumber
- Type: SystemInt32
The chromosome number for the Snpitem to move to.
Return Value
Type:
BooleanTrue if the cursor was moved to a SnpItem with the given chromosome number.
False if no subsequent SnpItems exist with given chromosome number.
If returning true, the Current item will have given chromosome number.
Exceptions Exception | Condition |
---|
InvalidOperationException |
The enumerator is positioned before the first element of the collection or after the last element.
|
See Also