Package no.marec.api.korona
Interface Channel
public interface Channel
A channel in a
Ping
.-
Method Summary
Modifier and TypeMethodDescriptionint
The first valid sample index.int
The number of this channel.int
One past the last valid sample index.double
The frequency in Hz.double
getLogSv
(int sampleIndex) Gets (logarithmic) Sv value for a sample.double
getSv
(int sampleIndex) Gets (linear) sv value for a sample.void
setLogSv
(int sampleIndex, double logSv) Sets (logarithmic) Sv value for a sample.void
setSv
(int sampleIndex, double sv) Sets (linear) sv for a sample.
-
Method Details
-
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 sampleIndex) Gets (linear) sv value for a sample.Requirement:
getBeginSampleIndex()
≤ sampleIndex <getEndSampleIndex()
.- Parameters:
sampleIndex
- the sample index- Returns:
- (linear) sv
-
setSv
void setSv(int sampleIndex, double sv) Sets (linear) sv for a sample.Requirement:
getBeginSampleIndex()
≤ sampleIndex <getEndSampleIndex()
.- Parameters:
sampleIndex
- the sample indexsv
- (linear) sv
-
getLogSv
double getLogSv(int sampleIndex) Gets (logarithmic) Sv value for a sample.Requirement:
getBeginSampleIndex()
≤ sampleIndex <getEndSampleIndex()
.- Parameters:
sampleIndex
- the sample index- Returns:
- (logarithmic) Sv
-
setLogSv
void setLogSv(int sampleIndex, double logSv) Sets (logarithmic) Sv value for a sample.Requirement:
getBeginSampleIndex()
≤ sampleIndex <getEndSampleIndex()
.- Parameters:
sampleIndex
- the sample indexlogSv
- (logarithmic) Sv
-