📄 missioncontainer.java
字号:
* @return friendly label for the specified channel */ String getMissionLabel(int channel) throws OneWireException, OneWireIOException; // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - // - Mission Results // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /** * Returns the time, in milliseconds, that the mission began. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @return time, in milliseconds, that the mission began */ long getMissionTimeStamp(int channel) throws OneWireException, OneWireIOException; /** * Returns the amount of time, in milliseconds, before the first sample * occurred. If rollover disabled, or datalog didn't fill up, this * will be 0. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @return time, in milliseconds, before first sample occurred */ long getFirstSampleOffset(int channel) throws OneWireException, OneWireIOException; /** * Returns the amount of time, in seconds, between samples taken * by this missioning device. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @return time, in seconds, between sampling */ int getMissionSampleRate(int channel) throws OneWireException, OneWireIOException; /** * Returns the number of samples taken for the specified channel * during the current mission. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @return number of samples taken for the specified channel */ int getMissionSampleCount(int channel) throws OneWireException, OneWireIOException; /** * Returns the total number of samples taken for the specified channel * during the current mission. This number can be more than the actual * sample count if rollover is enabled and the log has been filled. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @return number of samples taken for the specified channel */ public int getMissionSampleCountTotal(int channel) throws OneWireException, OneWireIOException; /** * Returns the value of each sample taken by the current mission. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @param sampleNum the sample number to return, between <code>0</code> and * <code>(getMissionSampleCount(channel)-1)</code> * @return the value of the specified sample on the specified channel */ double getMissionSample(int channel, int sampleNum) throws OneWireException, OneWireIOException; /** * Returns the time, in milliseconds, that each sample was taken by the * current mission. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @param sampleNum the sample number to return, between <code>0</code> and * <code>(getMissionSampleCount(channel)-1)</code> * @return the sample's timestamp, in milliseconds */ long getMissionSampleTimeStamp(int channel, int sampleNum) throws OneWireException, OneWireIOException; // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - // - Mission Resolution and Range // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /** * Returns all available resolutions for the specified mission channel. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @return all available resolutions for the specified mission channel. */ double[] getMissionResolutions(int channel) throws OneWireException, OneWireIOException; /** * Returns the currently selected resolution for the specified * channel. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @return the currently selected resolution for the specified channel. */ double getMissionResolution(int channel) throws OneWireException, OneWireIOException; /** * Sets the selected resolution for the specified channel. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @param resolution the new resolution for the specified channel. */ void setMissionResolution(int channel, double resolution) throws OneWireException, OneWireIOException; // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - // - Mission Alarms // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /** * Indicates whether or not the specified channel of this missioning device * has mission alarm capabilities. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @return true if the device has mission alarms for the specified channel. */ boolean hasMissionAlarms(int channel); /** * Returns true if the specified channel's alarm value of the specified * type has been triggered during the mission. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @param alarmType valid value: <code>ALARM_HIGH</code> or * <code>ALARM_LOW</code> * @return true if the alarm was triggered. */ boolean hasMissionAlarmed(int channel, int alarmType) throws OneWireException, OneWireIOException; /** * Returns true if the alarm of the specified type has been enabled for * the specified channel. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @param alarmType valid value: <code>ALARM_HIGH</code> or * <code>ALARM_LOW</code> * @return true if the alarm of the specified type has been enabled for * the specified channel. */ boolean getMissionAlarmEnable(int channel, int alarmType) throws OneWireException, OneWireIOException; /** * Enables/disables the alarm of the specified type for the specified channel * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @param alarmType valid value: <code>ALARM_HIGH</code> or * <code>ALARM_LOW</code> * @param enable if true, alarm is enabled. */ void setMissionAlarmEnable(int channel, int alarmType, boolean enable) throws OneWireException, OneWireIOException; /** * Returns the threshold value which will trigger the alarm of the * specified type on the specified channel. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @param alarmType valid value: <code>ALARM_HIGH</code> or * <code>ALARM_LOW</code> * @return the threshold value which will trigger the alarm */ double getMissionAlarm(int channel, int alarmType) throws OneWireException, OneWireIOException; /** * Sets the threshold value which will trigger the alarm of the * specified type on the specified channel. * * @param channel the mission channel, between <code>0</code> and * <code>(getNumberOfMissionChannels()-1)</code> * @param alarmType valid value: <code>ALARM_HIGH</code> or * <code>ALARM_LOW</code> * @param threshold the threshold value which will trigger the alarm */ void setMissionAlarm(int channel, int alarmType, double threshold) throws OneWireException, OneWireIOException;}
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -