Port.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_PORT_H
#define GENAPI_PORT_H

#include "../Types.h"
#include "../IPortConstruct.h"
#include "../IChunkPort.h"
#include "../IPortRecorder.h"
#include "../IString.h"
#include "Node.h"
#include "NodeT.h"
//#include "NodeMap.h"
#include "BaseT.h"

class CNodeImpl;

namespace GENAPI_NAMESPACE
{

    class CValueCache;

    //*************************************************************
    // CPort class
    //*************************************************************


    class CPortImplIntern :
        public IPortConstruct,
        public IChunkPort,
        public IPortRecorder,
        public IPortStackedConstruct,
        public CNodeImpl
    {
    public:
        //constructor
        CPortImplIntern();

        virtual ~CPortImplIntern();

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

    protected:
        virtual EAccessMode InternalGetAccessMode() const;

        virtual EInterfaceType InternalGetPrincipalInterfaceType() const
        {
            return intfIPort;
        }

        //-------------------------------------------------------------
        // IPort implementation
        //-------------------------------------------------------------

    public:
        virtual void Read(void *pBuffer, int64_t Address, int64_t Length);

        virtual void Write(const void *pBuffer, int64_t Address, int64_t Length);

        //-------------------------------------------------------------
        // IPortConstruct implementation
        //-------------------------------------------------------------

        void SetPortImpl(IPort* pPort);

        void SetPortImpl(IPortStacked *pPort);

        //-------------------------------------------------------------
        // IChunkPort implementation
        //-------------------------------------------------------------

        virtual GENICAM_NAMESPACE::gcstring GetChunkID() const;

        virtual EYesNo GetSwapEndianess();

        virtual EYesNo CacheChunkData() const;

        //-------------------------------------------------------------
        // IPortRecorder implementation
        //-------------------------------------------------------------

        virtual void StartRecording( IPortWriteList *pPortRecorder );

        virtual void StopRecording();

        //-------------------------------------------------------------
        // IPortReplay implementation
        //-------------------------------------------------------------


        virtual void Replay( IPortWriteList *pPortRecorder, bool Invalidate = true );

        //-------------------------------------------------------------
        // IPortStacked Interface
        //-------------------------------------------------------------
        virtual void EnabledStack();

        virtual void FlushStack();
        
        virtual void DisableStack();

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


    protected:
        //-------------------------------------------------------------
        // Member variables
        //-------------------------------------------------------------

        IPort *m_pPort;

        IPortStacked *m_pPortStack;

        IPortWriteList *m_pPortWriteList;

        CStringPolyRef m_ChunkID;

        mutable GENAPI_NAMESPACE::CValueCache *m_pValueCache;

        EYesNo m_SwapEndianess;

        EYesNo m_CacheChunkData;

        bool m_isStackingEnabled;

        std::vector<PORT_REGISTER_STACK_ENTRY> m_writeStackData;
    };

    class CPort : public BaseT<  NodeT< CPortImplIntern > >
    {
    };

}

#endif // ifndef GENAPI_PORT_H