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