Converter.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2006 by Basler Vision Technologies
//  Section: Vision Components
//  Project: GenApi
//  Author:  Hartmut Nebelung
//  $Header$
//
//  License: This file is published under the license of the EMVA GenICam  Standard Group.
//  A text file describing the legal terms is included in  your installation as 'GenICam_license.pdf'.
//  If for some reason you are missing  this file please contact the EMVA or visit the website
//  (http://www.genicam.org) for a full copy.
//
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD  GROUP
//  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL,
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT  LIMITED TO,
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  DATA, OR PROFITS;
//  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)
//  ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
#ifndef GENAPI_CONVERTER_H
#define GENAPI_CONVERTER_H
#include "Base/GCString.h"
#include "../IFloat.h"
#include "Node.h"
#include "BaseT.h"
#include "ValueT.h"
#include "NodeT.h"
#include "SwissKnife.h"
#include "FloatT.h"
#include "PolyReference.h"

namespace GENAPI_NAMESPACE
{
    //*************************************************************
    // CConverter class
    //*************************************************************


    class CConverterImpl : public  IFloat, public CNodeImpl
    {
    public:
        CConverterImpl();
    protected:

        //-------------------------------------------------------------
        // IFloat implementation
        //-------------------------------------------------------------

        // Set feature value
        virtual void InternalSetValue(double Value, bool Verify = true);

        // Get feature value
        virtual double InternalGetValue(bool Verify = false, bool IgnoreCache = false);

        // Get minimum value allowed
        virtual double InternalGetMin();

        // Get maximum value allowed
        virtual double InternalGetMax();

        virtual bool InternalHasInc();
        
        virtual double InternalGetInc();

        virtual const  double_autovector_t InternalGetListOfValidValues();

        // Get recommended representation
        virtual  ERepresentation InternalGetRepresentation() const
        {
            if (m_Representation != _UndefinedRepresentation)
                return m_Representation;
            else
                return m_Value.GetRepresentation();
        }

        // Get the access mode of the node
        virtual EAccessMode InternalGetAccessMode() const;

        virtual EInterfaceType InternalGetPrincipalInterfaceType() const
        {
            return intfIFloat;
        }

        virtual GENICAM_NAMESPACE::gcstring InternalGetUnit() const
        {
            if ( !m_Unit.empty() )
                return m_Unit;
            else
                return m_Value.GetUnit();
        }

        virtual EDisplayNotation InternalGetDisplayNotation() const
        {
            if ( m_DisplayNotation != _UndefinedEDisplayNotation )
                return m_DisplayNotation;
            else
                return m_Value.GetDisplayNotation();
        }

        virtual int64_t InternalGetDisplayPrecision() const
        {
            if ( m_DisplayPrecision != -1 )
                return m_DisplayPrecision;
            else
                return m_Value.GetDisplayPrecision();
        }

        virtual ECachingMode InternalGetCachingMode() const;

    public:
        //-------------------------------------------------------------
        // Initializing
        //-------------------------------------------------------------
    public:


        virtual void SetProperty( CProperty &Property );
        virtual bool GetProperty(CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const;


        // determine if the conversion function is increasing or decreasing
        void CheckIncreasing();


    protected:
        bool IsMinUninititialized() const;

        bool IsMaxUninitialized() const;

        //-------------------------------------------------------------
        // Member variables
        //-------------------------------------------------------------

        GENICAM_NAMESPACE::gcstring m_FormulaTo;

        GENICAM_NAMESPACE::gcstring m_FormulaFrom;

        GENICAM_NAMESPACE::gcstring m_InputName;

        CFloatPolyRef m_ConvertTo;

        CFloatPolyRef m_ConvertFrom;

        CFloatPolyRef m_Value;

        mutable ERepresentation m_Representation;

        GENICAM_NAMESPACE::gcstring m_Unit;

        EDisplayNotation m_DisplayNotation;

        int64_t m_DisplayPrecision;

        ESlope m_Slope;

        EYesNo m_IsLinear;
    };

    class CConverter
        : public BaseT< ValueT< NodeT < FloatT < CConverterImpl > > > >
    {
    };
}

#endif // GENAPI_CONVERTER_H