/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2012 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : include/ICLIO/PylonCameraOptions.h                     **
** Module : ICLIO                                                  **
** Authors: Viktor Richter                                         **
**                                                                 **
**                                                                 **
** Commercial License                                              **
** ICL can be used commercially, please refer to our website       **
** www.iclcv.org for more details.                                 **
**                                                                 **
** GNU General Public License Usage                                **
** Alternatively, this file may be used under the terms of the     **
** GNU General Public License version 3.0 as published by the      **
** Free Software Foundation and appearing in the file LICENSE.GPL  **
** included in the packaging of this file.  Please review the      **
** following information to ensure the GNU General Public License  **
** version 3.0 requirements will be met:                           **
** http://www.gnu.org/copyleft/gpl.html.                           **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
*********************************************************************/

#pragma once

#include <pylon/PylonIncludes.h>

#include <ICLUtils/Macros.h>
#include <ICLIO/PylonUtils.h>

namespace icl {
  namespace io{
    namespace pylon {
  
      /// This is a helper class for Pylon camera settings \ingroup GIGE_G
      class PylonCameraOptions {
        public:
          /// Constructor
          /**
          * @param camera The IPylonDevice to work with.
          * @param interu An Interruptable class that provides interruption
          * functionality for the passed camera.
          */
          PylonCameraOptions(Pylon::IPylonDevice* camera, Interruptable* interu);
  
          /// Destructor
          ~PylonCameraOptions();
  
          /// interface for the setter function for video device properties.
          virtual void setProperty(const std::string &property, const std::string &value);
          /// returns a list of properties, that can be set using setProperty.
          virtual std::vector<std::string> getPropertyList();
          /// checks if property is returned, implemented, available and of processable GenApi::EInterfaceType
          virtual bool supportsProperty(const std::string &property);
          /// get type of property.
          virtual std::string getType(const std::string &name);
          /// get information of a properties valid values.
          virtual std::string getInfo(const std::string &name);
          /// returns the current value of a property or a parameter.
          virtual std::string getValue(const std::string &name);
          /// Returns whether this property may be changed internally.
          virtual int isVolatile(const std::string &propertyName);
  
          /// convenience function to get the cameras PixelType
          Pylon::PixelType getCameraPixelType();
          /// getter for cameras PixelSize in bits
          int getCameraPixelSize();
          /// getter of the BufferSize needed by the camera.
          long getNeededBufferSize();
          /// Executes the ICommand 'AcquisitionStart'
          void acquisitionStart();
          /// Executes the ICommand 'AcquisitionStop'
          void acquisitionStop();
          /// getter for the camera image height.
          int getHeight();
          /// getter for the camera image width.
          int getWidth();
          /// returns the cameras PixelFormat as string
          std::string getFormatString();
          /// whether double frames should be omitted.
          bool omitDoubleFrames();
          /// getter for the current expected framerate
          double getResultingFrameRateAbs();
  
        private:
          /// the Interruptable that provides interruption for the camera.
          Interruptable* m_Interu;
          /// The camera
          Pylon::IPylonDevice* m_Camera;
          /// whether double frames should be omitted.
          bool m_OmitDoubleFrames;
      
          /// helper function for getPropertyList.
          void addToPropertyList(std::vector<std::string> &ps, const GenApi::CNodePtr& node);
          /// setter function options of PylonGrabber (device-independent)
          void setPropertyExtra(const std::string &property, const std::string &value);
          /// adds PylonGrabber properties to property list
          void addPropertiesExtra(std::vector<std::string> &ps);
          /// checks whether property is from PylonGrabber (always supported)
          bool supportsPropertyExtra(const std::string &property);
          /// get type of PylonGrabber property
          /** @return null when not PylonGrabber property **/
          std::string getTypeExtra(const std::string &name);
          /// get information of a PylonGrabber properties valid values.
          /** @return null when not PylonGrabber property **/
          std::string getInfoExtra(const std::string &name);
          /// returns the current value of a property or a parameter.
          /** @return null when not PylonGrabber property **/
          std::string getValueExtra(const std::string &name);
          /// Returns whether a PylonGrabber-property may be changed internally.
          int isVolatileExtra(const std::string &propertyName);
  
          /// gets the corresponding CValuePtr to the passed name.
          GenApi::INode *getNode(std::string name);
      };
  
    } // namespace pylon
  
    // here come some convenience functions for pylon namespace
    namespace pylon {
      
      /// template function to get the value of an IValue-subclass
      template <typename NODE, typename RET>
      RET getNodeValue(NODE* node){
        return node -> GetValue();
      }
  
      /// template function overload to get the int64_t-value of an IEnumeration
      template <typename NODE, typename RET>
      int64_t getNodeValue(GenApi::IEnumeration* node){
        return node -> GetIntValue();
      }
  
      /// template function to set the value of an IValue-subclass
      template <typename NODE, typename VAL>
      void setNodeValue(NODE* node, VAL value){
        node -> SetValue(value, true);
        return;
      }
  
      /// template function overload to set the value of an IEnumeration
      template <typename NODE, typename VAL>
      void setNodeValue(GenApi::IEnumeration* node, std::string value){
        node -> FromString(value.c_str(), true);
        return;
      }
  
      /// template function overload to set the value of an IEnumeration
      template <typename NODE, typename VAL>
      void setNodeValue(GenApi::IEnumeration* node, int64_t value){
        node -> SetIntValue(value, true);
        return;
      }
  
      /// set the value of a parameter of a specific type on a specific source (camera/grabber)
      template <typename OBJ, typename NODE, typename VAL>
      bool setParameterValueOf(OBJ* object, std::string parameter, VAL value){
        GenApi::INode* node = object -> GetNodeMap() -> GetNode(parameter.c_str());
        if (!node) {
          DEBUG_LOG("There is no parameter called '" << parameter << "'")
          return false;
        }
        //dynamic cast to needed node-type
        NODE* node2;
        try{
          node2 = dynamic_cast<NODE*>(node);
        } catch (std::exception &e){
          DEBUG_LOG ("Could not cast node '"<< parameter << "' to desired type2")
          return false;
        }
        if(!GenApi::IsWritable(node2)){
          DEBUG_LOG("Parameter called '" << parameter << "' is not writable.")
          return false;
        }
        // now setting parameter
        try{
          setNodeValue<NODE, VAL>(node2, value);
          return true;
        }
        catch (GenICam::GenericException &e) {
          std::cerr << e.what() << std::endl;
          return false;
        }
      }
  
      /// get the value of a parameter of a specific type from a spec. source (camera/grabber)
      template <typename SOURCE, typename NODE, typename RET>
      RET getParameterValueOf(SOURCE* source, std::string param){
        GenApi::INode* node = source -> GetNodeMap() -> GetNode(param.c_str());
        if(!node){
          throw utils::ICLException("parameter of this type not found");
        }
        //dynamic cast to needed node-type
        try{
          NODE* node2 = dynamic_cast<NODE*>(node);
          if(!node2){
            throw utils::ICLException("Could not cast " + param + " to desired type");
          }
          if(!GenApi::IsReadable(node2)){
            throw utils::ICLException("The node " + param + " is not Readable");
          }
          return getNodeValue<NODE, RET>(node2);
        } catch (std::exception &e){
          throw utils::ICLException(e.what());
        }
      }
  
      /// returns a string representation of the value of a parameter of the camera.
      std::string getParameterValueString(
              Pylon::IPylonDevice* device, std::string parameter);
      
    } //namespace pylon
  } // namespace io
} //namespace icl