IntReg.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_INTREG_H
#define GENAPI_INTREG_H

#include "Register.h"
#include "../IRegister.h"
#include "BaseT.h"
#include "ValueT.h"
#include "NodeT.h"
#include "NodeMap.h"
#include "IntegerT.h"
#include "RegisterT.h"

namespace GENAPI_NAMESPACE
{
    //*************************************************************
    // CIntRegImpl class
    //*************************************************************

    class CIntRegImpl
        : public IInteger
        , public CRegisterImpl
    {
    public:
        CIntRegImpl();

        virtual EInterfaceType InternalGetPrincipalInterfaceType() const
        {
            return intfIInteger;
        }

    protected:

        //-------------------------------------------------------------
        // IRegister implementation
        //-------------------------------------------------------------

        virtual int64_t InternalGetLength( bool Verify = false );

        void UpdateMasks() const;

        mutable bool m_MasksAreValid;

        //-------------------------------------------------------------
        // IInteger implementation
        //-------------------------------------------------------------

        virtual void InternalSetValue(int64_t Value, bool Verify = true);

        virtual int64_t InternalGetValue(bool Verify = false, bool IgnoreCache = false);

        virtual int64_t InternalGetMin() const;

        virtual int64_t InternalGetMax() const;

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

        virtual int64_t InternalGetInc() const;

        virtual  ERepresentation InternalGetRepresentation() const;

        virtual GENICAM_NAMESPACE::gcstring InternalGetUnit();

        //-------------------------------------------------------------
        // INodePrivate implementation
        //-------------------------------------------------------------

        virtual void SetInvalid(ESetInvalidMode simMode);

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

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

    protected:
        void ReadReg(uint8_t* ValueBytes, bool Verify = false, bool IgnoreCache = false);

        void WriteReg(uint8_t* ValueBytes, bool Verify = true);

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

        mutable int64_t  m_Min;

        mutable int64_t  m_Max;

        ESign m_Sign;

        ERepresentation  m_Representation;

        GENICAM_NAMESPACE::gcstring m_Unit;

        EEndianess m_Endianess;

        mutable uint64_t m_SignBit;

        mutable uint64_t m_SignMask;

    };

    class CIntReg : public BaseT < ValueT < IntegerT < RegisterT < NodeT <  CIntRegImpl > > > > >
    {
    };
}

#endif // GENAPI_INTREG_H