ThermalCamera.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef IGNITION_RENDERING_THERMALCAMERA_HH_
#define IGNITION_RENDERING_THERMALCAMERA_HH_

#include <string>
#include "ignition/rendering/Camera.hh"

namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    /* \class ThermalCamera ThermalCamera.hh \
      * ignition/rendering/ThermalCamera.hh
     */
    class IGNITION_RENDERING_VISIBLE ThermalCamera :
      public virtual Camera
    {
      public: virtual ~ThermalCamera() { }

      public: virtual void SetAmbientTemperature(float _ambient) = 0;

      public: virtual float AmbientTemperature() const = 0;

      public: virtual void SetAmbientTemperatureRange(float _range) = 0;

      public: virtual float AmbientTemperatureRange() const = 0;

      public: virtual void SetMinTemperature(float _min) = 0;

      public: virtual float MinTemperature() const = 0;

      public: virtual void SetMaxTemperature(float _max) = 0;

      public: virtual float MaxTemperature() const = 0;

      public: virtual void SetLinearResolution(float _resolution) = 0;

      public: virtual float LinearResolution() const = 0;

      public: virtual float HeatSourceTemperatureRange() const = 0;

      public: virtual void SetHeatSourceTemperatureRange(float _range) = 0;

      public: virtual ignition::common::ConnectionPtr ConnectNewThermalFrame(
          std::function<void(const uint16_t *, unsigned int, unsigned int,
          unsigned int, const std::string &)>  _subscriber) = 0;
    };
  }
  }
}
#endif