NodeMapFactory.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2013 by Basler Vision Technologies
//  Section: Vision Components
//  Project: GenApi
//  Author:  Andreas Gau
//  $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.
//-----------------------------------------------------------------------------
#pragma once

#include <GenApi/GenApiVersion.h>
#include <GenApi/GenApiDll.h>
#include <Base/GCString.h>
#include <Base/GCStringVector.h>
#include <memory>

namespace GENAPI_NAMESPACE
{
    class CLock; // forward
    class CNodeDataMap; 
    struct INodeMap;

    typedef enum
    {
        CacheUsage_Automatic, 
        CacheUsage_ForceWrite,

        CacheUsage_ForceRead, 

        CacheUsage_Ignore     
    } ECacheUsage_t;

    typedef enum
    {
        //ContentType_Auto,
        ContentType_Xml, 
        ContentType_ZippedXml 
    } EContentType_t;




    //*************************************************************
    // CNodeMapFactory
    //*************************************************************

    class GENAPI_DECL CNodeMapFactory
    {
    public:
        CNodeMapFactory();

        virtual ~CNodeMapFactory();

        CNodeMapFactory( const CNodeMapFactory&);

        CNodeMapFactory& operator=(const CNodeMapFactory&);



        CNodeMapFactory( EContentType_t FileType, const GENICAM_NAMESPACE::gcstring& FileName, ECacheUsage_t CacheUsage = CacheUsage_Automatic, bool SuppressStringsOnLoad = false);



        CNodeMapFactory(EContentType_t ContentType, const void* pData, size_t DataSize, ECacheUsage_t CacheUsage = CacheUsage_Automatic, bool SuppressStringsOnLoad = false);



        CNodeMapFactory(const GENICAM_NAMESPACE::gcstring& XmlData, ECacheUsage_t CacheUsage = CacheUsage_Automatic, bool SuppressStringsOnLoad = false);


        bool IsEmpty() const;



        void AddInjectionData(CNodeMapFactory& injectionData);



        void LoadAndInject();


        bool IsLoaded() const;



        CNodeMapFactory ExtractSubtree(const GENICAM_NAMESPACE::gcstring& SubTreeRootNodeName, bool doRenameToRoot = false);



        void Preprocess();


        bool IsPreprocessed() const;

        

        void ReleaseCameraDescriptionFileData();


        bool IsCameraDescriptionFileDataReleased() const;



        INodeMap* CreateNodeMap(const GENICAM_NAMESPACE::gcstring &DeviceName = "Device", bool DoReleaseCameraDescriptionFileData = true);



        INodeMap* CreateNodeMap(CLock& UserProvidedLock, const GENICAM_NAMESPACE::gcstring &DeviceName = "Device", bool DoReleaseCameraDescriptionFileData = true);


        static INodeMap* CreateEmptyNodeMap();


        static bool ClearCache();


        void GetSupportedSchemaVersions(GENICAM_NAMESPACE::gcstring_vector &SchemaVersions) const;

        GENICAM_NAMESPACE::gcstring ToString() const;

        GENICAM_NAMESPACE::gcstring ToXml() const;

        static CNodeDataMap *CreateNodeDataFromNodeMap( INodeMap* pNodeMap );

        typedef struct
        {
            uint32_t NumNodes;
            uint32_t NumProperties;
            uint32_t NumLinks;
            uint32_t NumStrings;
        } NodeStatistics_t;

        void GetNodeStatistics(NodeStatistics_t &NodeStatistics);

        const GENICAM_NAMESPACE::gcstring ApplyStyleSheet(const GENICAM_NAMESPACE::gcstring& StyleSheetFileName);

    private:

        class CNodeMapFactoryImpl;

        CNodeMapFactoryImpl* m_pImpl;
    };
}