Register.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2006 by Basler Vision Technologies
//  Section: Vision Components
//  Project: GenApi
//  Author:  Fritz Dierks
//  $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_REGISTER_H
#define GENAPI_REGISTER_H

#include "NodeT.h"
#include "RegisterT.h"
#include "BaseT.h"
#include "ValueT.h"
#include "Port.h"
#include "PrivateTypes.h"
#include "Node.h"
#include "NodeMap.h"
#include "../IInteger.h"
#include "../IEnumeration.h"

namespace GENAPI_NAMESPACE
{

    typedef std::list<IValue *> ValueList_t;

    //*************************************************************
    // CRegisterImpl class
    //*************************************************************
    class CRegisterImpl
        : public IRegister
        , public CNodeImpl
    {
    public:
        CRegisterImpl();

    protected:
        //-------------------------------------------------------------
        //-------------------------------------------------------------

        virtual GENICAM_NAMESPACE::gcstring InternalToString(bool Verify = false, bool IgnoreCache = false);

        virtual void InternalFromString(const GENICAM_NAMESPACE::gcstring& valueString, bool Verify = true);

    public:

        virtual EInterfaceType InternalGetPrincipalInterfaceType() const
        {
            return intfIRegister;
        }

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

        virtual void SetInvalid(INodePrivate::ESetInvalidMode simMode);

        virtual void FinalConstruct();

        virtual bool CanBeWritten(bool Verify);

        //-------------------------------------------------------------
        // IBase implementation
        //-------------------------------------------------------------

    protected:
        virtual EAccessMode InternalGetAccessMode() const;

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

        virtual void InternalSet(const uint8_t *pBuffer, int64_t Length, bool Verify = true);

        virtual void InternalGet(uint8_t *ppBuffer, int64_t pLength, bool Verify = false, bool IgnoreCache = false) ;

        virtual int64_t InternalGetLength(bool Verify);

        virtual int64_t InternalGetAddress(bool Verify, bool IgnoreCache);

        virtual ECachingMode InternalGetCachingMode() const;

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


    protected:
        void UpdateAddress(bool Verify, bool IgnoreCache );

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

        CPort *m_pPort;

        int64_t m_Address;

        int64_t m_AddressValid;

        CIntegerPolyRef m_Length;

        std::list<CIntegerPolyRef> m_Addresses;

        std::list<CIntegerOffsetPolyRef> m_Indexes;

        EAccessMode m_AccessMode;
    };



class CRegister
    : public NodeT< RegisterT < ValueT < BaseT < CRegisterImpl > > > >
{};


}

#endif // ifndef GENAPI_REGISTER_H