NodeMap.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2006 by Basler 
//  Project: GenApi
//  Author:  Fritz Dierks
//
//  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_NODEMAP_H
#define GENAPI_NODEMAP_H

#include "GenApi/GenApiVersion.h"
#include "GenApi/GenApiDll.h"
#include "GenApi/impl/INodeMapPrivate.h"
#include "GenApi/impl/INodePrivate.h"
#include "GenApi/IDestroy.h"
#include "GenApi/IDeviceInfo.h"
#include "GenApi/Synch.h"
#include "Base/GCString.h"
#include "Base/GCStringVector.h"
#include "GenApi/impl/Value2String.h"
#include "GenApi/IUserData.h"
#include "GenApi/impl/ConcatenatedWriteImpl.h"
#include "GenApi/impl/Port.h"
#include <map>

#ifdef _MSC_VER 
# pragma warning(push)
# pragma warning(disable: 4251) // class 'xxx' needs to have dll-interface to be used by clients of class 'yyy'
#endif

namespace GENAPI_NAMESPACE
{

    typedef  INodePrivate*(*CreateFunc_t)( const GENICAM_NAMESPACE::gcstring& );

    class string2node_t;
    class CNodeMap
        : virtual public INodeMapPrivate
        , public IDeviceInfo
        , public IDestroy
        , public IUserData
    {
    public:
        //----------------------------------------------------------------
        // Construction 
        //----------------------------------------------------------------

        CNodeMap(const GENICAM_NAMESPACE::gcstring& DeviceName = "Device", CLock* pUserProvidedLock = NULL);

        //-------------------------------------------------------------

            virtual void GetNodes(NodeList_t &Nodes) const;
            virtual INode* GetNode(const GENICAM_NAMESPACE::gcstring& Name) const;
            virtual void InvalidateNodes() const;
            virtual bool Connect(IPort* pPort, const GENICAM_NAMESPACE::gcstring& PortName) const;
            virtual bool Connect(IPort* pPort) const;
            virtual bool Connect(IPortStacked* pPort, const GENICAM_NAMESPACE::gcstring& PortName);
            virtual bool Connect(IPortStacked* pPort);
            virtual GENICAM_NAMESPACE::gcstring GetDeviceName();
            virtual void Poll(int64_t ElapsedTime);
            virtual CLock& GetLock() const;
            virtual uint64_t GetNumNodes() const;
            virtual CNodeWriteConcatenator *NewNodeWriteConcatenator() const;
            virtual bool ConcatenatedWrite(CNodeWriteConcatenator *, bool featureStreaming = true, GENICAM_NAMESPACE::gcstring_vector *pErrorList = NULL);
            virtual bool ParseSwissKnifes( GENICAM_NAMESPACE::gcstring_vector *pErrorList = NULL ) const;
            virtual void SetSuppressCallbackMode(ECallbackSuppressMode mode);

        //-------------------------------------------------------------

            virtual void RegisterNode(INodePrivate* pNode, CNodeData::ENodeType_t NodeType, NodeID_t NodeID);
            virtual void FinalConstruct(bool DetermineDependencies);
            virtual void SetNumNodes(size_t NumNodes);
            virtual INodePrivate* GetNodeByID(NodeID_t NodeID);
            virtual void SetProperty(CProperty &Property);
            virtual bool GetProperty(CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const;
            virtual bool IsCallbackSuppressed() { return m_suppressCallback!=csmOff; };
            virtual Counter& GetBathometer() { return m_Bathometer; }
            virtual void SetEntryPoint(EMethod EntryMethod, const INodePrivate *pEntryNode, bool stremable, bool IgnoreCache);
            virtual void ResetEntryPoint();
            virtual GENICAM_NAMESPACE::gcstring GetEntryPoint();
            virtual bool IsGenApiLoggingEnabled();
            virtual bool IsGenApiDeviceLoggingEnabled();
            virtual bool EntryIsStremable();
            virtual void SetGenApiPersistenceMode(bool);

        //-------------------------------------------------------------

            virtual GENICAM_NAMESPACE::gcstring GetModelName();
            virtual GENICAM_NAMESPACE::gcstring GetVendorName();
            virtual GENICAM_NAMESPACE::gcstring GetToolTip();
            virtual GENICAM_NAMESPACE::gcstring GetStandardNameSpace();
            virtual void GetGenApiVersion(Version_t &Version, uint16_t &Build);
            virtual void GetSchemaVersion(Version_t &Version);
            virtual void GetDeviceVersion(Version_t &Version);
            virtual GENICAM_NAMESPACE::gcstring GetProductGuid();
            virtual GENICAM_NAMESPACE::gcstring GetVersionGuid();
    private:
        //-------------------------------------------------------------

        virtual UserData_t GetUserData() const;
        virtual UserData_t SetUserData( UserData_t userdata );
    public:
        //-------------------------------------------------------------
        virtual void Destroy();

        // Fast Track...
        inline INodePrivate* _GetNodeByID( NodeID_t NodeID )
        {
            assert((size_t)NodeID.ToIndex() < m_Node2NodeID.size());
            return m_Node2NodeID[(size_t)NodeID.ToIndex()];
        }

    protected:
        //-------------------------------------------------------------
        // DeviceInfo members
        //-------------------------------------------------------------

        GENICAM_NAMESPACE::gcstring m_ModelName;

        GENICAM_NAMESPACE::gcstring m_VendorName;

        GENICAM_NAMESPACE::gcstring m_ToolTip;

        GENAPI_NAMESPACE::EStandardNameSpace m_StandardNameSpace;

        Version_t m_SchemaVersion;

        Version_t m_DeviceVersion;

        GENICAM_NAMESPACE::gcstring m_ProductGuid;

        GENICAM_NAMESPACE::gcstring m_VersionGuid;

        GENICAM_NAMESPACE::gcstring_vector m_PropertyNames;

        GENICAM_NAMESPACE::gcstring m_DeviceName;

        GENICAM_NAMESPACE::gcstring m_Name;

        //-------------------------------------------------------------
        // Node containers
        //-------------------------------------------------------------

        typedef std::vector<INodePrivate*> Node2NodeID_t;
        Node2NodeID_t m_Node2NodeID;

        string2node_t *m_pMap;

        string2node_t& Map();

        const string2node_t& Map() const;

        //-------------------------------------------------------------
        // Destruction
        //-------------------------------------------------------------

        virtual ~CNodeMap();

        void ClearAllNodes();

        //-------------------------------------------------------------
        // Call-stack implementation 
        //-------------------------------------------------------------

        uint64_t m_suppressCallback;

        Counter m_Bathometer;

        const INodePrivate *m_pEntryNode;

        EMethod m_EntryMethod;

        int m_EntryPointDepth;

        bool m_EntryPointIgnoreCache;

        bool m_EntryPointStreamable;

        NodePrivateVector_t* m_pPollingNodes;

        bool m_GenApiLoggingEnabled;

        bool m_GenApiDeviceLoggingEnabled;

        bool m_GenApiPersistenceMode;

    private:
        CLock m_zzz_OwnLock_DoNotUse;
    private:
        UserData_t m_pUserData;

    protected:
        CLock& m_Lock;

    private:
        std::list<CPort *> m_connectedPort;

    protected:
    
    class EntryMethodFinalizer
    {
    public:
        EntryMethodFinalizer(CNodeMap* pThis)
        {
            assert(pThis);
            m_pNodeMapPrivate = pThis;
        }

        ~EntryMethodFinalizer()
        {
            if (m_pNodeMapPrivate->m_suppressCallback == csmOnce)
            {
                m_pNodeMapPrivate->m_suppressCallback = csmOff;
            }
        }

    private:
        CNodeMap* m_pNodeMapPrivate;
    };

        //-------------------------------------------------------------
        // No copying of this class
        //-------------------------------------------------------------
    private:
        CNodeMap(const CNodeMap&);

        CNodeMap& operator=(const CNodeMap&);

    };
}

#ifdef _MSC_VER 
# pragma warning(pop)
#endif

#endif // GENAPI_NODEMAP_H