SwissKnife.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2006 by Basler Vision Technologies
//  Section: Vision Components
//  Project: GenApi
//  Author:  Margret Albrecht
//  $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_SWISSKNIFE_H
#define GENAPI_SWISSKNIFE_H

#include "../IFloat.h"
#include "Node.h"
#include "MathParser/MathParser.h"
#include "BaseT.h"
#include "ValueT.h"
#include "NodeT.h"
#include "NodeMap.h"
#include "FloatT.h"

namespace GENAPI_NAMESPACE
{
    //*************************************************************
    // CSwissKnife class
    //*************************************************************

    class CSwissKnifeImpl : public IFloat,  public CNodeImpl
    {
    public:
        CSwissKnifeImpl();

        virtual ~CSwissKnifeImpl();

    protected:
        //-------------------------------------------------------------
        // IBase implementation
        //-------------------------------------------------------------

        // Get access mode
        virtual EAccessMode InternalGetAccessMode() const;

        virtual EInterfaceType InternalGetPrincipalInterfaceType() const
        {
            return intfIFloat;
        }


    public:
        //-------------------------------------------------------------
        // IInteger implementation
        //-------------------------------------------------------------


        virtual double GetValueWithInput(double input, bool Verify = false, bool IgnoreCache = false);

    protected:
        //-------------------------------------------------------------
        // IFloat implementation
        //-------------------------------------------------------------

        // Set feature value
        #pragma BullseyeCoverage off
        virtual void InternalSetValue(double /*Value*/, bool /*Verify*/ )
        {
            throw LOGICAL_ERROR_EXCEPTION_NODE("SwissKnife : %s SetValue failed. SwissKnife is read only", m_Name.c_str() );
        }
        #pragma BullseyeCoverage on

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

        // Get minimum value allowed
        virtual double InternalGetMin()
        {
            return m_Min;
        }

        // Get maximum value allowed
        virtual double InternalGetMax()
        {
            return m_Max;
        }

        virtual bool InternalHasInc()
        {
            // a swiss knife does not know about its increments
            return false;
        }

        #pragma BullseyeCoverage off
        // (untestable, function never called)
        virtual double InternalGetInc()
        {
            assert(false);
            return -1.0;
        }
        #pragma BullseyeCoverage on

        const virtual double_autovector_t InternalGetListOfValidValues()
        {
            return double_autovector_t();
        }


        // Get recommended representation
        virtual  ERepresentation InternalGetRepresentation()
        {
            if( m_Representation != _UndefinedRepresentation )
                return m_Representation;
            else
                return PureNumber;
        }

        // Get unit
        virtual GENICAM_NAMESPACE::gcstring InternalGetUnit() const
        {
            return m_Unit;
        }

        virtual EDisplayNotation InternalGetDisplayNotation() const
        {
            return m_DisplayNotation;
        }

        virtual int64_t InternalGetDisplayPrecision() const
        {
            return m_DisplayPrecision;
        }

        virtual ECachingMode InternalGetCachingMode() const;

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

        virtual void FinalConstruct();

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

    protected:

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

        double  m_Min;

        double  m_Max;

        GENICAM_NAMESPACE::gcstring m_Formula;

        std::map<GENICAM_NAMESPACE::gcstring, GENICAM_NAMESPACE::gcstring> m_Symbolics;

        std::map<GENICAM_NAMESPACE::gcstring, CFloatPolyRef> m_Variables;

        CStrMap m_VariableMap;

        CMathParser m_MathParser;

        ERepresentation m_Representation;

        GENICAM_NAMESPACE::gcstring m_Unit;

        EDisplayNotation m_DisplayNotation;

        int64_t m_DisplayPrecision;


        GENICAM_NAMESPACE::gcstring m_InputName;

        GENAPI_NAMESPACE::EInputDirection m_InputDirection;

        CFloatPolyRef m_Input;

    };

    class CSwissKnife : public BaseT< ValueT< NodeT< FloatT<  CSwissKnifeImpl > > > >
    {
    };

}

#endif // GENAPI_SWISSKNIFE_H