INodeMapDyn.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2006 by Basler Vision Technologies
3 // Section: Vision Components
4 // Project: GenApi
5 // Author: Fritz Dierks
6 // $Header$
7 //
8 // License: This file is published under the license of the EMVA GenICam Standard Group.
9 // A text file describing the legal terms is included in your installation as 'GenICam_license.pdf'.
10 // If for some reason you are missing this file please contact the EMVA or visit the website
11 // (http://www.genicam.org) for a full copy.
12 //
13 // THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
14 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD GROUP
17 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23 // POSSIBILITY OF SUCH DAMAGE.
24 //-----------------------------------------------------------------------------
31 #ifndef GENAPI_INODEMAPDYN_H
32 #define GENAPI_INODEMAPDYN_H
33 
34 #include "Base/GCBase.h"
35 #include "INodeMap.h"
36 
37 #ifdef _MSC_VER
38 # pragma warning ( push )
39 # pragma warning ( disable : 4251 ) // XXX needs to have dll-interface to be used by clients of class YYY
40 #endif
41 
42 namespace GENAPI_NAMESPACE
43 {
44 
45  //*************************************************************
46  // INodeMap interface
47  //*************************************************************
48 
53  interface GENAPI_DECL_ABSTRACT INodeMapDyn : virtual public INodeMap
54  {
56  virtual void ClearAllNodes() = 0;
57 
59  virtual void LoadXMLFromFile(const GENICAM_NAMESPACE::gcstring& FileName) = 0;
60 
62  virtual void LoadXMLFromFileInject(const GENICAM_NAMESPACE::gcstring& TargetFileName, const GENICAM_NAMESPACE::gcstring& InjectFileName) = 0;
63 
65  virtual void LoadXMLFromString(const GENICAM_NAMESPACE::gcstring& XMLData) = 0;
66 
68  virtual void LoadXMLFromStringInject(const GENICAM_NAMESPACE::gcstring& TargetXMLData, const GENICAM_NAMESPACE::gcstring& InjectXMLData) = 0;
69 
71  virtual void PreprocessXMLFromFile(
72  const GENICAM_NAMESPACE::gcstring& XMLFileName,
73  const GENICAM_NAMESPACE::gcstring& StyleSheetFileName,
74  const GENICAM_NAMESPACE::gcstring& OutputFileName,
76  const uint32_t XMLValidation = xvDefault
77  ) = 0;
78 
80  virtual void MergeXMLFiles(
81  const GENICAM_NAMESPACE::gcstring& TargetFileName,
82  const GENICAM_NAMESPACE::gcstring& InjectedFileName,
83  const GENICAM_NAMESPACE::gcstring& OutputFileName
84  ) = 0;
85 
87  virtual void ExtractIndependentSubtree(
88  const GENICAM_NAMESPACE::gcstring& XMLData,
89  const GENICAM_NAMESPACE::gcstring& InjectXMLData,
90  const GENICAM_NAMESPACE::gcstring& SubTreeRootNodeName,
91  GENICAM_NAMESPACE::gcstring& ExtractedSubtree
92  ) = 0;
93 
95 
99  virtual void GetSupportedSchemaVersions( GENICAM_NAMESPACE::gcstring_vector &SchemaVersions ) = 0;
100 
102  virtual void LoadXMLFromZIPFile(const GENICAM_NAMESPACE::gcstring & ZipFileName) = 0;
103 
105  virtual void LoadXMLFromZIPData(const void* zipData, size_t zipSize) = 0;
106 
108  virtual void PreprocessXMLFromZIPFile(
109  const GENICAM_NAMESPACE::gcstring& XMLFileName,
110  const GENICAM_NAMESPACE::gcstring& StyleSheetFileName,
111  const GENICAM_NAMESPACE::gcstring& OutputFileName,
113  const uint32_t XMLValidation = xvDefault
114  ) = 0;
115  };
116 
117 }
118 
119 #ifdef _MSC_VER
120 # pragma warning ( pop )
121 #endif
122 
123 #endif // ifndef GENAPI_INODEMAPDYN_H
interface GENAPI_DECL_ABSTRACT INodeMapDyn
Interface to access the node map.
Definition: INodeMapDyn.h:56
virtual void PreprocessXMLFromFile(const GENICAM_NAMESPACE::gcstring &XMLFileName, const GENICAM_NAMESPACE::gcstring &StyleSheetFileName, const GENICAM_NAMESPACE::gcstring &OutputFileName, const uint32_t XMLValidation=xvDefault)=0
Loads an XML, checks it for correctness, pre-processes it, caches it, and optionally applies a style ...
virtual void LoadXMLFromZIPFile(const GENICAM_NAMESPACE::gcstring &ZipFileName)=0
Loads an XML from a ZIP file.
virtual void LoadXMLFromStringInject(const GENICAM_NAMESPACE::gcstring &TargetXMLData, const GENICAM_NAMESPACE::gcstring &InjectXMLData)=0
Loads an XML from a string with injection.
virtual void LoadXMLFromString(const GENICAM_NAMESPACE::gcstring &XMLData)=0
Loads an XML from a string.
virtual void LoadXMLFromZIPData(const void *zipData, size_t zipSize)=0
Loads an XML from a ZIP data buffer.
interface GENAPI_DECL_ABSTRACT INodeMap
Interface to access the node map.
Definition: INodeMap.h:56
Common GenICam base include file.
virtual void PreprocessXMLFromZIPFile(const GENICAM_NAMESPACE::gcstring &XMLFileName, const GENICAM_NAMESPACE::gcstring &StyleSheetFileName, const GENICAM_NAMESPACE::gcstring &OutputFileName, const uint32_t XMLValidation=xvDefault)=0
Loads a Zipped XML, checks it for correctness, pre-processes it, caches it, and optionally applies a ...
Definition of interface INodeMap.
virtual void MergeXMLFiles(const GENICAM_NAMESPACE::gcstring &TargetFileName, const GENICAM_NAMESPACE::gcstring &InjectedFileName, const GENICAM_NAMESPACE::gcstring &OutputFileName)=0
Injects an XML file into a target file.
A string class which is a clone of std::string.
Definition: GCString.h:52
virtual void ExtractIndependentSubtree(const GENICAM_NAMESPACE::gcstring &XMLData, const GENICAM_NAMESPACE::gcstring &InjectXMLData, const GENICAM_NAMESPACE::gcstring &SubTreeRootNodeName, GENICAM_NAMESPACE::gcstring &ExtractedSubtree)=0
Extract independent subtree.
checks performed if nothing else is said
Definition: Types.h:172
virtual void LoadXMLFromFileInject(const GENICAM_NAMESPACE::gcstring &TargetFileName, const GENICAM_NAMESPACE::gcstring &InjectFileName)=0
Loads an XML from a file with injection.
virtual void LoadXMLFromFile(const GENICAM_NAMESPACE::gcstring &FileName)=0
Loads an XML from a file.
Part of the generic device API.
Definition: Autovector.h:48
virtual void GetSupportedSchemaVersions(GENICAM_NAMESPACE::gcstring_vector &SchemaVersions)=0
Gets a list of supported schema versions.


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:54