Namespaces | Typedefs | Functions | Variables
INode.h File Reference

Definition of interface INode and types NodeList_t and CallbackHandleType: More...

#include <Base/GCString.h>
#include <GenApi/GenApiDll.h>
#include <GenApi/Types.h>
#include <GenApi/IBase.h>
#include <GenApi/Container.h>
#include <assert.h>
Include dependency graph for INode.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  GENAPI_NAMESPACE
 

Part of the generic device API.


Typedefs

typedef intptr_t GENAPI_NAMESPACE::CallbackHandleType
 the callback handle for nodes
typedef node_vector GENAPI_NAMESPACE::NodeList_t
 a list of node references

Functions

EAccessMode GENAPI_NAMESPACE::Combine (EAccessMode Peter, EAccessMode Paul)
 Computes which access mode the two guards allow together.
EVisibility GENAPI_NAMESPACE::Combine (EVisibility Peter, EVisibility Paul)
 Computes which visibility the two guards allow together.
ECachingMode GENAPI_NAMESPACE::Combine (ECachingMode Peter, ECachingMode Paul)
 Computes which CachingMode results from a combination.
virtual bool GENAPI_NAMESPACE::DeregisterCallback (CallbackHandleType hCallback)=0
 De register change callback.
virtual INode * GENAPI_NAMESPACE::GetAlias () const =0
 Retrieves the a node which describes the same feature in a different way.
virtual ECachingMode GENAPI_NAMESPACE::GetCachingMode () const =0
 Get Caching Mode.
virtual INode * GENAPI_NAMESPACE::GetCastAlias () const =0
 Retrieves the a node which describes the same feature so that it can be casted.
virtual void GENAPI_NAMESPACE::GetChildren (GENAPI_NAMESPACE::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const =0
 Get all nodes this node directly depends on.
virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetDescription () const =0
 Get a long description of the node.
virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetDeviceName () const =0
 Get a name of the device.
virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetDisplayName () const =0
 Get a name string for display.
virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetDocuURL () const =0
 Gets a URL pointing to the documentation of that feature.
virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetEventID () const =0
 Get the EventId of the node.
virtual
GENAPI_NAMESPACE::ENameSpace 
GENAPI_NAMESPACE::GetNameSpace () const =0
 Get name space.
virtual INodeMap * GENAPI_NAMESPACE::GetNodeMap () const =0
 Retrieves the central node map.
virtual void GENAPI_NAMESPACE::GetParents (GENAPI_NAMESPACE::NodeList_t &Parents) const =0
 Gets all nodes this node is directly depending on.
virtual int64_t GENAPI_NAMESPACE::GetPollingTime () const =0
 recommended polling time (for not cachable nodes)
virtual EInterfaceType GENAPI_NAMESPACE::GetPrincipalInterfaceType () const =0
 Get the type of the main interface of a node.
virtual bool GENAPI_NAMESPACE::GetProperty (const GENICAM_NAMESPACE::gcstring &PropertyName, GENICAM_NAMESPACE::gcstring &ValueStr, GENICAM_NAMESPACE::gcstring &AttributeStr)=0
 Retrieves a property plus an additional attribute by name.
virtual void GENAPI_NAMESPACE::GetPropertyNames (GENICAM_NAMESPACE::gcstring_vector &PropertyNames) const =0
 Returns a list of the names all properties set during initialization.
virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetToolTip () const =0
 Get a short description of the node.
virtual EVisibility GENAPI_NAMESPACE::GetVisibility () const =0
 Get the recommended visibility of the node.
virtual void GENAPI_NAMESPACE::ImposeAccessMode (EAccessMode ImposedAccessMode)=0
 Imposes an access mode to the natural access mode of the node.
virtual void GENAPI_NAMESPACE::ImposeVisibility (EVisibility ImposedVisibility)=0
 Imposes a visibility to the natural visibility of the node.
virtual void GENAPI_NAMESPACE::InvalidateNode ()=0
 Indicates that the node's value may have changed.
virtual EYesNo GENAPI_NAMESPACE::IsAccessModeCacheable () const =0
 True if the AccessMode can be cached.
bool GENAPI_NAMESPACE::IsAvailable (EAccessMode AccessMode)
 Tests if available.
bool GENAPI_NAMESPACE::IsAvailable (const IBase *p)
 Checks if a node is available.
bool GENAPI_NAMESPACE::IsAvailable (const IBase &r)
 Checks if a node is available.
virtual bool GENAPI_NAMESPACE::IsCachable () const =0
 Is the node value cachable.
bool GENAPI_NAMESPACE::IsCacheable (ECachingMode CachingMode)
 Tests Cacheability.
virtual bool GENAPI_NAMESPACE::IsDeprecated () const =0
 True if the node should not be used any more.
virtual bool GENAPI_NAMESPACE::IsFeature () const =0
 True if the node can be reached via category nodes from a category node named "Root".
bool GENAPI_NAMESPACE::IsImplemented (EAccessMode AccessMode)
 Tests if implemented.
bool GENAPI_NAMESPACE::IsImplemented (const IBase *p)
 Checks if a node is implemented.
bool GENAPI_NAMESPACE::IsImplemented (const IBase &r)
 Checks if a node is implemented.
bool GENAPI_NAMESPACE::IsReadable (EAccessMode AccessMode)
 Tests if readable.
bool GENAPI_NAMESPACE::IsReadable (const IBase *p)
 Checks if a node is readable.
bool GENAPI_NAMESPACE::IsReadable (const IBase &r)
 Checks if a node is readable.
virtual bool GENAPI_NAMESPACE::IsStreamable () const =0
 True if the node is streamable.
bool GENAPI_NAMESPACE::IsVisible (EVisibility Visibility, EVisibility MaxVisiblity)
 Tests Visibility.
bool GENAPI_NAMESPACE::IsWritable (EAccessMode AccessMode)
 Tests if writable.
bool GENAPI_NAMESPACE::IsWritable (const IBase *p)
 Checks if a node is writable.
bool GENAPI_NAMESPACE::IsWritable (const IBase &r)
 Checks if a node is writable.
virtual CallbackHandleType GENAPI_NAMESPACE::RegisterCallback (CNodeCallback *pCallback)=0
 Register change callback.

Variables

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INode
 Interface common to all nodes.

Detailed Description

Definition of interface INode and types NodeList_t and CallbackHandleType:

Definition in file INode.h.



rc_visard_driver
Author(s): Heiko Hirschmueller , Christian Emmerich , Felix Ruess
autogenerated on Thu Jun 6 2019 20:43:08