com.bruxton.sidx
Class Temperature

java.lang.Object
  com.bruxton.sidx.Temperature

public class Temperature
extends java.lang.Object

Responsible for managing the sensor temperature. Each instance of Camera can own one instance of the class. The user of SIDX should not create the object. It should be obtained by using getTemperature function of Camera object.

Method Summary

double	get() Obtain the measured sensor temperature, in Celsius.
double	getMaximum() Obtain the maximum legal range for the sensor temperature settings in Celsius.
double	getMinimum() Obtain the minimum legal range for the sensor temperature settings in Celsius.
boolean	getRangeValid() Return if the temperature range is valid.
double	getSetpoint() Obtain the desire temperature setting in Celsius.
boolean	isLocked() Report if the sensor temperature is locked to the setpoint.
boolean	isLockedByHardware() Report if the information of sensor temperature lock state is provided by the hardware.
void	powerOffCooling() Set the camera system in power off cooling mode.
void	powerOnCooling() Set the camera system in power on cooling mode.
void	setSetpoint(double temperature) Set the desire temperature setting in Celsius.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

powerOnCooling

public void powerOnCooling()
                    throws Exception

Set the camera system in power on cooling mode. The feature may/may not be supported depending on the type of the camera.

Throws:

Exception

powerOffCooling

public void powerOffCooling()
                     throws Exception

Set the camera system in power off cooling mode. The feature may/may not be supported depending on the type of the camera.

Throws:

Exception

get

public double get()
           throws Exception

Obtain the measured sensor temperature, in Celsius.

Returns:

the measured sensor temperature, in Celsius.

Throws:

Exception

isLocked

public boolean isLocked()
                 throws Exception

Report if the sensor temperature is locked to the setpoint. If the returned value is true, it means that the sensor temperature is locked to the setpoint. Otherwise not.

Returns:

the lock state of the sensor temperature.

Throws:

Exception

isLockedByHardware

public boolean isLockedByHardware()
                           throws Exception

Report if the information of sensor temperature lock state is provided by the hardware. If the returned value is true, it means that the sensor temperature lock state information is provided by the hardware. Otherwise not.

Returns:

the status whether the information of the sensor temperature lock state is provided by the hardware.

Throws:

Exception

setSetpoint

public void setSetpoint(double temperature)
                 throws Exception

Set the desire temperature setting in Celsius.

Parameters:

temperature - the desire temperature setting to set in Celsius.

Throws:

Exception

getSetpoint

public double getSetpoint()
                   throws Exception

Obtain the desire temperature setting in Celsius.

Returns:

the desire temperature setting in Celsius.

Throws:

Exception

getMaximum

public double getMaximum()
                  throws Exception

Obtain the maximum legal range for the sensor temperature settings in Celsius.

Returns:

the maximum legal range for the sensor temperature settings in Celsius.

Throws:

Exception

getMinimum

public double getMinimum()
                  throws Exception

Obtain the minimum legal range for the sensor temperature settings in Celsius.

Returns:

the minimum legal range for the sensor temperature settings in Celsius.

Throws:

Exception

getRangeValid

public boolean getRangeValid()
                      throws Exception

Return if the temperature range is valid.

Returns:

true if the temperature range is valid.

Throws:

Exception