EventPort.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_EVENTPORT_H
#define GENAPI_EVENTPORT_H

#include <GenApi/Pointer.h>
#include <GenApi/IPortConstruct.h>
#include <GenApi/INodeMap.h>

namespace GENAPI_NAMESPACE
{

    class GENAPI_DECL CEventPort : public IPortConstruct
    {

    public:
        CEventPort(INode* pNode = NULL);

        ~CEventPort();

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

        virtual EAccessMode GetAccessMode() const;

        virtual EInterfaceType GetPrincipalInterfaceType() const;

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

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

        virtual void SetPortImpl(GENAPI_NAMESPACE::IPort* pPort);

        virtual EYesNo GetSwapEndianess();

        //---------------------------------------------------------------
        // Implementation
        //---------------------------------------------------------------

        // Invalidates the chunk port node
        void InvalidateNode();

        //-------------------------------------------------------------
        // Initializing
        //-------------------------------------------------------------

        bool AttachNode(GENAPI_NAMESPACE::INode* pNode);

        void DetachNode();

        int GetEventIDLength();

        bool CheckEventID(uint8_t* pEventIDBuffer, int EventIDLength) const;

        bool CheckEventID(uint64_t EventID) const;

        void AttachEvent(uint8_t *pBaseAddress, int64_t Length);

        void DetachEvent();

    protected:

        CLock& GetLock() const;
    private:
        void ResetEventDataBuffer();

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

        uint8_t *m_pEventData;

        int64_t m_EventDataLength;

        int64_t m_EventDataAlloc;
#ifdef _MSC_VER
#   pragma warning( push )
#   pragma warning( disable: 4251 )
#endif

        CNodePtr m_ptrNode;
#ifdef _MSC_VER
#   pragma warning( pop )
#endif

        uint8_t *m_pEventIDBuffer;

        int m_EventIDLength;

        bool m_IsAttachedToPortNode;

        uint64_t m_EventIDNumber;

        bool m_EventIDNumberValid;
    };

}
#endif // GENAPI_EVENTPORT_H