Functions
virtual void	LoadXMLFromFile (const GenICam::gcstring &FileName)=0
	Loads an XML from a file. More...

virtual void	LoadXMLFromFileInject (const GenICam::gcstring &TargetFileName, const GenICam::gcstring &InjectFileName)=0
	Loads an XML from a file with injection. More...

virtual void	LoadXMLFromString (const GenICam::gcstring &XMLData)=0
	Loads an XML from a string. More...

virtual void	LoadXMLFromStringInject (const GenICam::gcstring &TargetXMLData, const GenICam::gcstring &InjectXMLData)=0
	Loads an XML from a string with injection. More...

virtual void	PreprocessXMLFromFile (const GenICam::gcstring &XMLFileName, const GenICam::gcstring &StyleSheetFileName, const GenICam::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. More...

virtual void	MergeXMLFiles (const GenICam::gcstring &TargetFileName, const GenICam::gcstring &InjectedFileName, const GenICam::gcstring &OutputFileName)=0
	Injects an XML file into a target file. More...

virtual void	ExtractIndependentSubtree (const GenICam::gcstring &XMLData, const GenICam::gcstring &InjectXMLData, const GenICam::gcstring &SubTreeRootNodeName, GenICam::gcstring &ExtractedSubtree)=0
	Extract independent subtree. More...

virtual void	GetSupportedSchemaVersions (GenICam::gcstring_vector &SchemaVersions)=0
	Gets a list of supported schema versions. More...

virtual void	LoadXMLFromZIPFile (const GenICam::gcstring &ZipFileName)=0
	Loads an XML from a ZIP file. More...

virtual void	LoadXMLFromZIPData (const void *zipData, size_t zipSize)=0
	Loads an XML from a ZIP data buffer. More...

virtual void	PreprocessXMLFromZIPFile (const GenICam::gcstring &XMLFileName, const GenICam::gcstring &StyleSheetFileName, const GenICam::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. More...

Variables
interface SPINNAKER_API_ABSTRACT	INodeMapDyn
	Interface to access the node map. More...

Detailed Description

Function Documentation

◆ ExtractIndependentSubtree()

virtual void Spinnaker::GenApi::ExtractIndependentSubtree	(	const GenICam::gcstring &	XMLData,
		const GenICam::gcstring &	InjectXMLData,
		const GenICam::gcstring &	SubTreeRootNodeName,
		GenICam::gcstring &	ExtractedSubtree
	)

pure virtual

Extract independent subtree.

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 Spinnaker::GenApi::GetSupportedSchemaVersions ( GenICam::gcstring_vector & SchemaVersions )

pure virtual

Gets a list of supported schema versions.

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

◆ LoadXMLFromFile()

virtual void Spinnaker::GenApi::LoadXMLFromFile ( const GenICam::gcstring & FileName )

pure virtual

Loads an XML from a file.

◆ LoadXMLFromFileInject()

virtual void Spinnaker::GenApi::LoadXMLFromFileInject	(	const GenICam::gcstring &	TargetFileName,
		const GenICam::gcstring &	InjectFileName
	)

pure virtual

Loads an XML from a file with injection.

◆ LoadXMLFromString()

virtual void Spinnaker::GenApi::LoadXMLFromString ( const GenICam::gcstring & XMLData )

pure virtual

Loads an XML from a string.

◆ LoadXMLFromStringInject()

virtual void Spinnaker::GenApi::LoadXMLFromStringInject	(	const GenICam::gcstring &	TargetXMLData,
		const GenICam::gcstring &	InjectXMLData
	)

pure virtual

Loads an XML from a string with injection.

◆ LoadXMLFromZIPData()

virtual void Spinnaker::GenApi::LoadXMLFromZIPData	(	const void *	zipData,
		size_t	zipSize
	)

pure virtual

Loads an XML from a ZIP data buffer.

◆ LoadXMLFromZIPFile()

virtual void Spinnaker::GenApi::LoadXMLFromZIPFile ( const GenICam::gcstring & ZipFileName )

pure virtual

Loads an XML from a ZIP file.

◆ MergeXMLFiles()

virtual void Spinnaker::GenApi::MergeXMLFiles	(	const GenICam::gcstring &	TargetFileName,
		const GenICam::gcstring &	InjectedFileName,
		const GenICam::gcstring &	OutputFileName
	)

pure virtual

Injects an XML file into a target file.

Parameters

InjectedFileName	> Name of the target XML file to process
OutputFileName	> Name of the Injected XML file to process> Name of the oputput file

◆ PreprocessXMLFromFile()

virtual void Spinnaker::GenApi::PreprocessXMLFromFile	(	const GenICam::gcstring &	XMLFileName,
		const GenICam::gcstring &	StyleSheetFileName,
		const GenICam::gcstring &	OutputFileName,
		const uint32_t	XMLValidation = `xvDefault`
	)

pure virtual

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.

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

◆ PreprocessXMLFromZIPFile()

virtual void Spinnaker::GenApi::PreprocessXMLFromZIPFile	(	const GenICam::gcstring &	XMLFileName,
		const GenICam::gcstring &	StyleSheetFileName,
		const GenICam::gcstring &	OutputFileName,
		const uint32_t	XMLValidation = `xvDefault`
	)

pure virtual

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.

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

Variable Documentation

◆ INodeMapDyn

interface SPINNAKER_API_ABSTRACT INodeMapDyn

Interface to access the node map.

Functions

Variables

Detailed Description

Function Documentation

◆ ExtractIndependentSubtree()

◆ GetSupportedSchemaVersions()

◆ LoadXMLFromFile()

◆ LoadXMLFromFileInject()

◆ LoadXMLFromString()

◆ LoadXMLFromStringInject()

◆ LoadXMLFromZIPData()

◆ LoadXMLFromZIPFile()

◆ MergeXMLFiles()

◆ PreprocessXMLFromFile()

◆ PreprocessXMLFromZIPFile()

Variable Documentation

◆ INodeMapDyn