Public Member Functions | Static Public Member Functions | Public Attributes | List of all members

Smartpointer for NodeMaps with create function. More...

#include <GenApi/NodeMapRef.h>

Inheritance diagram for GenApi::CNodeMapRef:
Inheritance graph
[legend]

Public Member Functions

 CNodeMapRef (GenICam::gcstring DeviceName="Device")
 Constructor.
 
void _Destroy ()
 Destroys the node map.
 
void _LoadDLL (void)
 Creates the object from the default DLL. More...
 
void _LoadDLL (GenICam::gcstring VendorName, GenICam::gcstring ModelName)
 Creates the object from a DLL whose name is deduced from vendor and model name.
 
void _LoadDLL (GenICam::gcstring FileName)
 Creates the object from a DLL with given file name.
 
void _LoadXMLFromFile (GenICam::gcstring VendorName, GenICam::gcstring ModelName)
 Creates the object from a XML file whose name is deduced from vendor and model name.
 
void _LoadXMLFromFile (GenICam::gcstring FileName)
 Creates the object from a XML file with given file name.
 
void _LoadXMLFromFileInject (GenICam::gcstring TargetFileName, GenICam::gcstring InjectFileName)
 Creates the object from a XML target and an inject file with given file name.
 
void _LoadXMLFromString (const GenICam::gcstring &XMLData)
 Creates the object from XML data given in a string.
 
void _LoadXMLFromStringInject (const GenICam::gcstring &TargetXMLDataconst, const GenICam::gcstring &InjectXMLData)
 Creates the object from XML data given in a string with injection.
 
void _PreprocessXMLFromFile (const GenICam::gcstring &XMLFileName, const GenICam::gcstring &StyleSheetFileName, const GenICam::gcstring &OutputFileName, const uint32_t XMLValidation=xvDefault)
 Loads an XML, checks it for correctness, applies a stylesheet and outputs it.
 
virtual void _MergeXMLFiles (const GenICam::gcstring &TargetFileName, const GenICam::gcstring &InjectedFileName, const GenICam::gcstring &OutputFileName)
 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)
 Extract independent subtree. More...
 
virtual void _GetSupportedSchemaVersions (GenICam::gcstring_vector &SchemaVersions)
 Gets a list of supported schema versions. More...
 
virtual GenICam::gcstring _GetDeviceName ()
 Get device name.
 
virtual void _Poll (int64_t ElapsedTime)
 Fires nodes which have a polling time.
 
virtual void _GetNodes (NodeList_t &Nodes) const
 Retrieves all nodes in the node map.
 
virtual INode_GetNode (const GenICam::gcstring &key) const
 Retrieves the node from the central map by name.
 
virtual void _InvalidateNodes () const
 Invalidates all nodes.
 
virtual bool _Connect (IPort *pPort, const GenICam::gcstring &PortName) const
 Connects a port to a port node with given name.
 
virtual bool _Connect (IPort *pPort) const
 Connects a port to the standard port "Device".
 

Static Public Member Functions

static bool _ClearXMLCache ()
 Clears the cache of the camera description files.
 

Public Attributes

INodeMap_Ptr
 Pointer to the NodeMap.
 

Detailed Description

Smartpointer for NodeMaps with create function.

Note
This class is a simple typedef definition. The class syntax is only used, because Doxygen has to generate a useful documentation.

Member Function Documentation

virtual void GenApi::CNodeMapRefT< GenApi::CGeneric_XMLLoaderParams >::_ExtractIndependentSubtree ( const GenICam::gcstring XMLData,
const GenICam::gcstring InjectXMLData,
const GenICam::gcstring SubTreeRootNodeName,
GenICam::gcstring ExtractedSubtree 
)
virtualinherited

Extract independent subtree.

Parameters
XMLDataThe XML data the subtree is extracted from.
InjectXMLDataOptional XML data that is injected before extracting the subtree. No effect if an empty string is passed.
SubTreeRootNodeNameThe name of the node that represents the root of the subtree that shall be extracted.
ExtractedSubtreeThe returned extracted subtree as string.
virtual void GenApi::CNodeMapRefT< GenApi::CGeneric_XMLLoaderParams >::_GetSupportedSchemaVersions ( GenICam::gcstring_vector &  SchemaVersions)
virtualinherited

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

void GenApi::CNodeMapRefT< GenApi::CGeneric_XMLLoaderParams >::_LoadDLL ( void  )
inherited

Creates the object from the default DLL.

Note
Can only be used if the class TCameraParams was auto generated from a specific camera xml file
virtual void GenApi::CNodeMapRefT< GenApi::CGeneric_XMLLoaderParams >::_MergeXMLFiles ( const GenICam::gcstring TargetFileName,
const GenICam::gcstring InjectedFileName,
const GenICam::gcstring OutputFileName 
)
virtualinherited

Injects an XML file into a target file.

Parameters
TargetFileNameName of the target XML file to process
InjectedFileNameName of the Injected XML file to process
OutputFileNameName of the oputput file

The documentation for this class was generated from the following file:

© 2006-2014 Basler (Tue Jul 22 2014 11:41:23)