PortStackedImpl.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2017 by Teledyne DALSA
//  Author:  Eric Bourbonnais
//
//  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_PORTSTACKEDIMPL_H
#define GENAPI_PORTSTACKEDIMPL_H

#include <Base/GCException.h>
#include <GenApi/GenApiDll.h>
#include <GenApi/Types.h>
#include <GenApi/IPortConstruct.h>
#include <GenApi/IPortRecorder.h>
#include <GenApi/Pointer.h>

#pragma warning( push )
#pragma warning( disable: 4251 ) // enApi::CPortImpl::m_ptrPort' : class 'GenApi::CPointer<T>' needs to have dll-interface
#pragma warning ( disable : 4068 ) // unknown pragma; refers to BullsEyeCoverage

namespace GENAPI_NAMESPACE
{
#   pragma warning ( push ) 
#   pragma warning ( disable : 4251 ) // DLL interface (this is a bug)
#   pragma warning ( disable : 4275 ) // DLL interface (this is a bug)

    //*************************************************************
    // CPortImpl class
    //*************************************************************


    class CPortStackedImpl : public IPortStackedConstruct, public IPortStacked, public IPortReplay
    {
    public:
        CPortStackedImpl()
        {
        }

        virtual ~CPortStackedImpl()
        {
        }

        /*---------------------------------------------------------------*/
        // IBase ==> You need to override this method
        /*---------------------------------------------------------------*/


        virtual EAccessMode GetAccessMode() const = 0;

        /*---------------------------------------------------------------*/
        // IPort ==> You need to override these methods
        /*---------------------------------------------------------------*/

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

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

        /*---------------------------------------------------------------*/
        // IPortStacked  ==> You need to override these methods
        /*---------------------------------------------------------------*/

        virtual void Write(PORT_REGISTER_STACK_ENTRY *pEntries, size_t numEntries) = 0;

        /*---------------------------------------------------------------*/
        // IPortStackedConstruct implementation (without IPort & IBase)
        /*---------------------------------------------------------------*/

        virtual void SetPortImpl(IPortStacked* pPort)
        {
            m_ptrPort = pPort;
            assert(m_ptrPort.IsValid());
        }

        virtual EYesNo GetSwapEndianess()
        {
            return No;
        }


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


        virtual void Replay( IPortWriteList *pPortRecorder, bool Invalidate = true )
        {
            if(pPortRecorder)
                pPortRecorder->Replay(this);

            if(Invalidate)
                InvalidateNode();
        }

        // Invalidate the node
        void InvalidateNode()
        {
            if(m_ptrPort.IsValid())
                m_ptrPort->InvalidateNode();
        }

    private:
        CNodePtr m_ptrPort;

    };

#   pragma warning ( pop )
}

#pragma warning(pop)
#endif // ifndef GENAPI_PORTSTACKEDIMPL_H