Skip to content

File INodeMapDyn.h

File List > include > SpinGenApi > INodeMapDyn.h

Go to the documentation of this file

//=============================================================================
// Copyright (c) 2026 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
//
// This software is the confidential and proprietary information of FLIR
// Integrated Imaging Solutions, Inc. ("Confidential Information"). You
// shall not disclose such Confidential Information and shall use it only in
// accordance with the terms of the license agreement you entered into
// with FLIR Integrated Imaging Solutions, Inc. (FLIR).
//
// FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
// SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
// SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
// THIS SOFTWARE OR ITS DERIVATIVES.
//=============================================================================

#ifndef SPINNAKER_GENAPI_INODEMAPDYN_H
#define SPINNAKER_GENAPI_INODEMAPDYN_H

#include "GCString.h"
#include "INodeMap.h"
#include "GCStringVector.h"

#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable : 4251) // XXX needs to have dll-interface to be used by clients of class YYY
#endif

namespace Spinnaker
{
    namespace GenApi
    {
        //*************************************************************
        // INodeMap interface
        //*************************************************************

        interface SPINNAKER_API_ABSTRACT INodeMapDyn : virtual public INodeMap
        {
            virtual void ClearAllNodes() = 0;

            virtual void LoadXMLFromFile(const GenICam::gcstring& FileName) = 0;

            virtual void LoadXMLFromFileInject(
                const GenICam::gcstring& TargetFileName, const GenICam::gcstring& InjectFileName) = 0;

            virtual void LoadXMLFromString(const GenICam::gcstring& XMLData) = 0;

            virtual void LoadXMLFromStringInject(
                const GenICam::gcstring& TargetXMLData, const GenICam::gcstring& InjectXMLData) = 0;

            virtual void PreprocessXMLFromFile(
                const GenICam::gcstring& XMLFileName,        
                const GenICam::gcstring& StyleSheetFileName, 
                const GenICam::gcstring& OutputFileName, 
                const uint32_t XMLValidation = xvDefault 
                ) = 0;

            virtual void MergeXMLFiles(
                const GenICam::gcstring& TargetFileName,   
                const GenICam::gcstring& InjectedFileName, 
                const GenICam::gcstring& OutputFileName    
                ) = 0;

            virtual void ExtractIndependentSubtree(
                const GenICam::gcstring& XMLData,       
                const GenICam::gcstring& InjectXMLData, 
                const GenICam::gcstring& SubTreeRootNodeName, 
                GenICam::gcstring& ExtractedSubtree           
                ) = 0;

            virtual void GetSupportedSchemaVersions(GenICam::gcstring_vector & SchemaVersions) = 0;

            virtual void LoadXMLFromZIPFile(const GenICam::gcstring& ZipFileName) = 0;

            virtual void LoadXMLFromZIPData(const void* zipData, size_t zipSize) = 0;

            virtual void PreprocessXMLFromZIPFile(
                const GenICam::gcstring& XMLFileName,        
                const GenICam::gcstring& StyleSheetFileName, 
                const GenICam::gcstring& OutputFileName, 
                const uint32_t XMLValidation = xvDefault 
                ) = 0;
        };

    } // namespace GenApi
} // namespace Spinnaker

#ifdef _WIN32
#pragma warning(pop)
#endif

#endif // ifndef SPINNAKER_GENAPI_INODEMAPDYN_H