Spinnaker C++
2.6.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
NodeMap Class Reference

Smart pointer template for NodeMaps with create function. More...

Inheritance diagram for NodeMap:
SpinTestCamera

Public Member Functions

 NodeMap (GenICam::gcstring DeviceName="Device")
 Constructor. More...
 
virtual ~NodeMap ()
 Destructor. More...
 
void Destroy ()
 Destroys the node map. More...
 
void LoadXMLFromFile (GenICam::gcstring FileName)
 Creates the object from a XML file with given file name. More...
 
void LoadXMLFromZIPFile (GenICam::gcstring ZipFileName)
 Creates the object from a ZIP'd XML file with given file name. More...
 
void LoadXMLFromZIPData (const void *zipData, size_t zipSize)
 Creates the object from a ZIP'd XML file given in a string. More...
 
void LoadXMLFromFileInject (GenICam::gcstring TargetFileName, GenICam::gcstring InjectFileName)
 Creates the object from a XML target and an inject file with given file name. More...
 
void LoadXMLFromString (const GenICam::gcstring &XMLData)
 Creates the object from XML data given in a string. More...
 
void LoadXMLFromStringInject (const GenICam::gcstring &TargetXMLDataconst, const GenICam::gcstring &InjectXMLData)
 Creates the object from XML data given in a string with injection. More...
 
virtual void GetSupportedSchemaVersions (GenICam::gcstring_vector &SchemaVersions)
 Gets a list of supported schema versions. More...
 
virtual GenICam::gcstring GetDeviceName ()
 Get device name. More...
 
virtual void Poll (int64_t ElapsedTime)
 Fires nodes which have a polling time. More...
 
virtual void GetNodes (NodeList_t &Nodes) const
 Retrieves all nodes in the node map. More...
 
virtual INodeGetNode (const GenICam::gcstring &key) const
 Retrieves the node from the central map by name. More...
 
virtual void InvalidateNodes () const
 Invalidates all nodes. More...
 
virtual bool Connect (IPort *pPort, const GenICam::gcstring &PortName) const
 Connects a port to a port node with given name. More...
 
virtual bool Connect (IPort *pPort) const
 Connects a port to the standard port "Device". More...
 
virtual CLockGetLock () const
 Returns the lock which guards the node map. More...
 
virtual uint64_t GetNumNodes () const
 Get the number of nodes in the map. More...
 
void * GetNodeMapHandle () const
 
virtual GenICam::gcstring GetModelName ()
 Get the model name. More...
 
virtual GenICam::gcstring GetVendorName ()
 Get the vendor name. More...
 
virtual GenICam::gcstring GetToolTip ()
 Get tool tip. More...
 
virtual GenICam::gcstring GetStandardNameSpace ()
 Get the standard name space. More...
 
virtual void GetGenApiVersion (GenICam::Version_t &Version, uint16_t &Build)
 Get the version of the DLL's GenApi implementation. More...
 
virtual void GetSchemaVersion (GenICam::Version_t &Version)
 Get the schema version number. More...
 
virtual void GetDeviceVersion (GenICam::Version_t &Version)
 Get the version of the device description file. More...
 
virtual GenICam::gcstring GetProductGuid ()
 Get the GUID describing the product. More...
 
virtual GenICam::gcstring GetVersionGuid ()
 Get the GUID describing the product version. More...
 

Static Public Member Functions

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

Public Attributes

INodeMap_Ptr
 Pointer to the NodeMap. More...
 

Detailed Description

Smart pointer template for NodeMaps with create function.

Parameters
TCameraParamsThe camera specific parameter class (auto generated from camera xml file)
Examples:
GigEVisionPerformance.cpp.

Constructor & Destructor Documentation

NodeMap ( GenICam::gcstring  DeviceName = "Device")

Constructor.

virtual ~NodeMap ( )
virtual

Destructor.

Member Function Documentation

static bool ClearXMLCache ( )
static

Clears the cache of the camera description files.

virtual bool Connect ( IPort pPort,
const GenICam::gcstring PortName 
) const
virtual

Connects a port to a port node with given name.

virtual bool Connect ( IPort pPort) const
virtual

Connects a port to the standard port "Device".

void Destroy ( )

Destroys the node map.

virtual GenICam::gcstring GetDeviceName ( )
virtual

Get device name.

virtual void GetDeviceVersion ( GenICam::Version_t Version)
virtual

Get the version of the device description file.

virtual void GetGenApiVersion ( GenICam::Version_t Version,
uint16_t &  Build 
)
virtual

Get the version of the DLL's GenApi implementation.

virtual CLock& GetLock ( ) const
virtual

Returns the lock which guards the node map.

virtual GenICam::gcstring GetModelName ( )
virtual

Get the model name.

virtual INode* GetNode ( const GenICam::gcstring key) const
virtual

Retrieves the node from the central map by name.

void* GetNodeMapHandle ( ) const
virtual void GetNodes ( NodeList_t Nodes) const
virtual

Retrieves all nodes in the node map.

virtual uint64_t GetNumNodes ( ) const
virtual

Get the number of nodes in the map.

virtual GenICam::gcstring GetProductGuid ( )
virtual

Get the GUID describing the product.

virtual void GetSchemaVersion ( GenICam::Version_t Version)
virtual

Get the schema version number.

virtual GenICam::gcstring GetStandardNameSpace ( )
virtual

Get the standard name space.

virtual void GetSupportedSchemaVersions ( GenICam::gcstring_vector &  SchemaVersions)
virtual

Gets a list of supported schema versions.

! Loads an XML, checks it for correctness, applies a style-sheet and outputs it void PreprocessXMLFromFile(const GenICam::gcstring& XMLFileName, const GenICam::gcstring& StyleSheetFileName, const GenICam::gcstring& OutputFileName, const uint32_t XMLValidation = xvDefault);

! Loads a Zipped XML, checks it for correctness, applies a style-sheet and outputs it void PreprocessXMLFromZIPFile(const GenICam::gcstring& ZIPFileName, const GenICam::gcstring& StyleSheetFileName, const GenICam::gcstring& OutputFileName, const uint32_t XMLValidation = xvDefault);

! Injects an XML file into a target file virtual void MergeXMLFiles( const GenICam::gcstring& TargetFileName, *< Name of the target XML file to process const GenICam::gcstring& InjectedFileName, *< Name of the Injected XML file to process const GenICam::gcstring& OutputFileName *< Name of the output file );

! Extract independent subtree virtual void ExtractIndependentSubtree( const GenICam::gcstring& XMLData, *< The XML data the subtree is extracted from. const GenICam::gcstring& InjectXMLData, *< Optional XML data that is injected before extracting the subtree. No effect if an empty string is passed. const GenICam::gcstring& SubTreeRootNodeName,*< The name of the node that represents the root of the subtree that shall be extracted. GenICam::gcstring& ExtractedSubtree *< The returned extracted subtree as string. );

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

virtual GenICam::gcstring GetToolTip ( )
virtual

Get tool tip.

virtual GenICam::gcstring GetVendorName ( )
virtual

Get the vendor name.

virtual GenICam::gcstring GetVersionGuid ( )
virtual

Get the GUID describing the product version.

virtual void InvalidateNodes ( ) const
virtual

Invalidates all nodes.

void LoadXMLFromFile ( GenICam::gcstring  FileName)

Creates the object from a XML file with given file name.

! 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 void LoadDLL(void);

! Creates the object from a DLL whose name is deduced from vendor and model name void LoadDLL(GenICam::gcstring VendorName, GenICam::gcstring ModelName);

! Creates the object from a DLL with given file name void LoadDLL(GenICam::gcstring FileName);

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 LoadXMLFromZIPData ( const void *  zipData,
size_t  zipSize 
)

Creates the object from a ZIP'd XML file given in a string.

void LoadXMLFromZIPFile ( GenICam::gcstring  ZipFileName)

Creates the object from a ZIP'd XML file with given file name.

virtual void Poll ( int64_t  ElapsedTime)
virtual

Fires nodes which have a polling time.

Member Data Documentation

INodeMap* _Ptr

Pointer to the NodeMap.


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference