Package no.marec.api.korona
Interface Channel
-
public interface ChannelA channel in aPing.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetBeginSampleIndex()The first valid sample index.intgetChannelNumber()The number of this channel.intgetEndSampleIndex()One past the last valid sample index.doublegetFrequency()The frequency in Hz.doublegetLogSv(int aSampleIndex)Gets (logarithmic) Sv value for a sample.doublegetSv(int aSampleIndex)Gets (linear) sv value for a sample.voidsetLogSv(int aSampleIndex, double aLogSv)Sets (logarithmic) Sv value for a sample.voidsetSv(int aSampleIndex, double aSv)Sets (linear) sv for a sample.
-
-
-
Method Detail
-
getChannelNumber
int getChannelNumber()
The number of this channel.- Returns:
- the channel number.
-
getFrequency
double getFrequency()
The frequency in Hz.- Returns:
- frequency in Hz.
-
getBeginSampleIndex
int getBeginSampleIndex()
The first valid sample index.- Returns:
- the first valid sample index.
-
getEndSampleIndex
int getEndSampleIndex()
One past the last valid sample index.- Returns:
- one past the last valid sample index.
-
getSv
double getSv(int aSampleIndex)
Gets (linear) sv value for a sample.Requirement:
getBeginSampleIndex()≤ aSampleIndex <getEndSampleIndex().- Parameters:
aSampleIndex- the sample index.- Returns:
- (linear) sv.
-
setSv
void setSv(int aSampleIndex, double aSv)Sets (linear) sv for a sample.Requirement:
getBeginSampleIndex()≤ aSampleIndex <getEndSampleIndex().- Parameters:
aSampleIndex- the sample index.aSv- (linear) sv.
-
getLogSv
double getLogSv(int aSampleIndex)
Gets (logarithmic) Sv value for a sample.Requirement:
getBeginSampleIndex()≤ aSampleIndex <getEndSampleIndex().- Parameters:
aSampleIndex- the sample index.- Returns:
- (logarithmic) Sv.
-
setLogSv
void setLogSv(int aSampleIndex, double aLogSv)Sets (logarithmic) Sv value for a sample.Requirement:
getBeginSampleIndex()≤ aSampleIndex <getEndSampleIndex().- Parameters:
aSampleIndex- the sample index.aLogSv- (logarithmic) Sv.
-
-