ChunkPort.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2006-8 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_CHUNKPORT_H
#define GENAPI_CHUNKPORT_H
 
#include <GenApi/Pointer.h>
#include <GenApi/IPortConstruct.h>
#include <GenApi/INodeMap.h>
 
#ifdef _MSC_VER
#   pragma warning(push)
#   pragma warning(disable: 4251) // GenApi::CChunkPort::m_ptrPort' : class 'GenApi::CPointer<T>' needs to have dll-interface
#endif
 
namespace GENAPI_NAMESPACE
{
 
    class GENAPI_DECL CChunkPort : public IPortConstruct
    {
 
    public:
 
        CChunkPort(IPort* pPort = NULL);
 
        virtual ~CChunkPort();
    private:
        CChunkPort(const CChunkPort&);             // copy constructor is not implemented
        CChunkPort& operator =(const CChunkPort&); // assignment operator is not implemented
    public:
        //-------------------------------------------------------------
        // 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 void SetPortImpl(GENAPI_NAMESPACE::IPortStacked* pPort);
 
        virtual EYesNo GetSwapEndianess()
        {
            return No;
        }
 
        //---------------------------------------------------------------
        // Implementation
        //---------------------------------------------------------------
 
        // Invalidates the chunk port node
        void InvalidateNode();
 
        //-------------------------------------------------------------
        // Initializing
        //-------------------------------------------------------------
 
        bool AttachPort(GENAPI_NAMESPACE::IPort* pPort);
 
        void DetachPort();
 
        void AttachChunk(uint8_t *pBaseAddress, int64_t ChunkOffset, int64_t Length, bool Cache);
 
        void DetachChunk();
 
        int GetChunkIDLength()
        {
            return m_ChunkIDLength;
        }
 
        bool CheckChunkID(uint8_t* pChunkIDBuffer, int ChunkIDLength);
 
        bool CheckChunkID(uint64_t ChunkID);
 
        void UpdateBuffer(uint8_t *pBaseAddress);
 
        void ClearCache();
    protected:
 
        CLock& GetLock() const
        {
            if (!m_ptrPort.IsValid())
                throw RUNTIME_EXCEPTION("The event port is not attached to a node");
 
            return m_ptrPort->GetNodeMap()->GetLock();
        }
 
        //-------------------------------------------------------------
        // Member variables
        //-------------------------------------------------------------
 
        uint8_t *m_pBaseAddress;
 
        int64_t m_ChunkOffset;
 
        int64_t m_Length;
 
        int64_t m_LengthAlloc;
 
        CNodePtr m_ptrPort;
 
        uint8_t *m_pChunkIDBuffer;
 
        int m_ChunkIDLength;
 
        uint8_t *m_pChunkData;
 
        bool m_CacheData;
 
        uint64_t m_ChunkIDNumber;
 
        bool m_ChunkIDNumberValid;
     };
 
}
 
#ifdef _MSC_VER
#   pragma warning(pop)
#endif
 
#endif // GENAPI_CHUNKPORT_H