GenApi 3.5.1
Functions | Variables

Definition of interface INodeMapDyn. More...

Go to the source code of this file.

Functions

virtual void LoadXMLFromFile (const GENICAM_NAMESPACE::gcstring &FileName)=0
 Loads an XML from a file.
 
virtual void LoadXMLFromFileInject (const GENICAM_NAMESPACE::gcstring &TargetFileName, const GENICAM_NAMESPACE::gcstring &InjectFileName)=0
 Loads an XML from a file with injection.
 
virtual void LoadXMLFromString (const GENICAM_NAMESPACE::gcstring &XMLData)=0
 Loads an XML from a string.
 
virtual void LoadXMLFromStringInject (const GENICAM_NAMESPACE::gcstring &TargetXMLData, const GENICAM_NAMESPACE::gcstring &InjectXMLData)=0
 Loads an XML from a string with injection.
 
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 sheet, and optionally writes it to a file.
 
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.
 
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.
 
virtual void GetSupportedSchemaVersions (GENICAM_NAMESPACE::gcstring_vector &SchemaVersions)=0
 Gets a list of supported schema versions.
 
virtual void LoadXMLFromZIPFile (const GENICAM_NAMESPACE::gcstring &ZipFileName)=0
 Loads an XML from a ZIP file.
 
virtual void LoadXMLFromZIPData (const void *zipData, size_t zipSize)=0
 Loads an XML from a ZIP data buffer.
 
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 style sheet, and optionally writes it to a file.
 

Variables

GENICAM_INTERFACE GENAPI_DECL_ABSTRACT INodeMapDyn
 Interface to access the node map.
 

Function Documentation

◆ PreprocessXMLFromFile()

virtual void PreprocessXMLFromFile ( const GENICAM_NAMESPACE::gcstring & XMLFileName,
const GENICAM_NAMESPACE::gcstring & StyleSheetFileName,
const GENICAM_NAMESPACE::gcstring & OutputFileName,
const uint32_t XMLValidation = xvDefault )
pure virtual
Parameters
StyleSheetFileName

‍The name of the XML file to process

OutputFileName

‍Optional name of a style sheet which is applied after the pre-processor (can be empty string) > This has no effect if the OutputFileName is an empty string

XMLValidation

‍Optional name of an output file into which the processed data is written (can be empty string)> Optional bit mask formed from EXMLValidation enumeration indicating which tests should be performed on the XML file

◆ MergeXMLFiles()

virtual void MergeXMLFiles ( const GENICAM_NAMESPACE::gcstring & TargetFileName,
const GENICAM_NAMESPACE::gcstring & InjectedFileName,
const GENICAM_NAMESPACE::gcstring & OutputFileName )
pure virtual
Parameters
InjectedFileName

‍Name of the target XML file to process

OutputFileName

‍Name of the Injected XML file to process> Name of the oputput file

◆ ExtractIndependentSubtree()

virtual void ExtractIndependentSubtree ( const GENICAM_NAMESPACE::gcstring & XMLData,
const GENICAM_NAMESPACE::gcstring & InjectXMLData,
const GENICAM_NAMESPACE::gcstring & SubTreeRootNodeName,
GENICAM_NAMESPACE::gcstring & ExtractedSubtree )
pure virtual
Parameters
InjectXMLData

‍The XML data the subtree is extracted from.

SubTreeRootNodeName

‍Optional XML data that is injected before extracting the subtree. No effect if an empty string is passed.

ExtractedSubtree

‍The name of the node that represents the root of the subtree that shall be extracted.> The returned extracted subtree as string.

◆ GetSupportedSchemaVersions()

virtual void GetSupportedSchemaVersions ( GENICAM_NAMESPACE::gcstring_vector & SchemaVersions)
pure virtual

Each list entry is a string with the format "<Major>.<Minor>" were <Major> and <Minor> are integers Example: {"1.1", "1.2"} indicates that the schema v1.1 and v1.2 are supported. The SubMinor version number is not given since it is for fully compatible bug fixes only

◆ PreprocessXMLFromZIPFile()

virtual void PreprocessXMLFromZIPFile ( const GENICAM_NAMESPACE::gcstring & XMLFileName,
const GENICAM_NAMESPACE::gcstring & StyleSheetFileName,
const GENICAM_NAMESPACE::gcstring & OutputFileName,
const uint32_t XMLValidation = xvDefault )
pure virtual
Parameters
StyleSheetFileName

‍The name of the XML file to process

OutputFileName

‍Optional name of a style sheet which is applied after the pre-processor (can be empty string) > This has no effect if the OutputFileName is an empty string

XMLValidation

‍Optional name of an output file into which the processed data is written (can be empty string)> Optional bit mask formed from EXMLValidation enumeration indicating which tests should be performed on the XML file