Group INode_h¶

Public Attributes¶

Type	Name
interface SPINNAKER_API_ABSTRACT	INode Interface common to all nodes.
	IReference = `/* multi line expression /` Interface* to construct a reference.

Public Functions¶

Type	Name
EAccessMode	Combine (EAccessMode Peter, EAccessMode Paul) Computes which access mode the two guards allow together.
EVisibility	Combine (EVisibility Peter, EVisibility Paul)
ECachingMode	Combine (ECachingMode Peter, ECachingMode Paul)
virtual bool	DeregisterCallback (CallbackHandleType hCallback) = 0
virtual INode *	GetAlias () const = 0
virtual ECachingMode	GetCachingMode () const = 0
virtual INode *	GetCastAlias () const = 0
virtual void	GetChildren (GenApi::NodeList_t & Children, ELinkType LinkType=ctReadingChildren) const = 0 Get all nodes this node directly depends on.
virtual GenICam::gcstring	GetDescription () const = 0
virtual GenICam::gcstring	GetDeviceName () const = 0
virtual GenICam::gcstring	GetDisplayName () const = 0
virtual GenICam::gcstring	GetDocuURL () const = 0
virtual GenICam::gcstring	GetEventID () const = 0
virtual void	GetLockNodes (GenApi::NodeList_t & LockNodes) const = 0 Gets all nodes which can directly lock this node.
virtual GenApi::ENameSpace	GetNameSpace () const = 0
virtual INodeMap *	GetNodeMap () const = 0
virtual void	GetParents (GenApi::NodeList_t & Parents) const = 0 Gets all nodes this node is directly depending on.
virtual int64_t	GetPollingTime () const = 0
virtual EInterfaceType	GetPrincipalInterfaceType () const = 0
virtual bool	GetProperty (const GenICam::gcstring & PropertyName, GenICam::gcstring & ValueStr, GenICam::gcstring & AttributeStr) = 0
virtual void	GetPropertyNames (GenICam::gcstring_vector & PropertyNames) const = 0
virtual EVisibility	GetVisibility () const = 0
virtual void	ImposeAccessMode (EAccessMode ImposedAccessMode) = 0
virtual void	ImposeVisibility (EVisibility ImposedVisibility) = 0
virtual void	InvalidateNode () = 0
virtual EYesNo	IsAccessModeCacheable () const = 0
bool	IsAvailable (EAccessMode AccessMode)
bool	IsAvailable (const IBase * p)
bool	IsAvailable (const IBase & r)
virtual bool	IsCachable () const = 0
bool	IsCacheable (ECachingMode CachingMode)
virtual bool	IsDeprecated () const = 0
virtual bool	IsFeature () const = 0
bool	IsImplemented (EAccessMode AccessMode)
bool	IsImplemented (const IBase * p)
bool	IsImplemented (const IBase & r)
bool	IsReadable (EAccessMode AccessMode)
bool	IsReadable (const IBase * p)
bool	IsReadable (const IBase & r)
virtual bool	IsStreamable () const = 0
bool	IsVisible (EVisibility Visibility, EVisibility MaxVisiblity)
bool	IsWritable (EAccessMode AccessMode)
bool	IsWritable (const IBase * p)
bool	IsWritable (const IBase & r)
virtual CallbackHandleType	RegisterCallback (CNodeCallback * pCallback) = 0
virtual bool	operator!= (int nullPtr) const = 0
virtual bool	operator== (int nullPtr) const = 0

Public Attributes Documentation¶

variable INode¶

Interface common to all nodes.

interface SPINNAKER_API_ABSTRACT Spinnaker::GenApi::INode;

variable IReference¶

Interface to construct a reference.

interface SPINNAKER_API_ABSTRACT Spinnaker::GenApi::IReference;

Public Functions Documentation¶

function Combine¶

Computes which access mode the two guards allow together.

inline EAccessMode Combine (
    EAccessMode Peter,
    EAccessMode Paul
)

function Combine¶

inline EVisibility Combine (
    EVisibility Peter,
    EVisibility Paul
)

Computes which visibility the two guards allow together

function Combine¶

inline ECachingMode Combine (
    ECachingMode Peter,
    ECachingMode Paul
)

Computes which CachingMode results from a combination

function DeregisterCallback¶

virtual bool DeregisterCallback (
    CallbackHandleType hCallback
) = 0

De register change callback Destroys CNodeCallback object

Returns:

true if the callback handle was valid

function GetAlias¶

virtual INode * GetAlias () const = 0

Retrieves the a node which describes the same feature in a different way

function GetCachingMode¶

virtual ECachingMode GetCachingMode () const = 0

Get Caching Mode

function GetCastAlias¶

virtual INode * GetCastAlias () const = 0

Retrieves the a node which describes the same feature so that it can be casted

function GetChildren¶

Get all nodes this node directly depends on.

virtual void GetChildren (
    GenApi::NodeList_t & Children,
    ELinkType LinkType=ctReadingChildren
) const = 0

Parameters:

Children List of children nodes
LinkType The link type

function GetDescription¶

virtual GenICam::gcstring GetDescription () const = 0

Get a long description of the node

function GetDeviceName¶

virtual GenICam::gcstring GetDeviceName () const = 0

Get a name of the device

Get device name The device name identifies a device instance, e.g. for debugging purposes. The default is "Device".

function GetDisplayName¶

virtual GenICam::gcstring GetDisplayName () const = 0

Get a name string for display

function GetDocuURL¶

virtual GenICam::gcstring GetDocuURL () const = 0

Gets a URL pointing to the documentation of that feature

function GetEventID¶

virtual GenICam::gcstring GetEventID () const = 0

Get the EventId of the node

function GetLockNodes¶

Gets all nodes which can directly lock this node.

virtual void GetLockNodes (
    GenApi::NodeList_t & LockNodes
) const = 0

Parameters:

LockNodes List of lock nodes.

function GetNameSpace¶

virtual GenApi::ENameSpace GetNameSpace () const = 0

Get name space

function GetNodeMap¶

virtual INodeMap * GetNodeMap () const = 0

Retrieves the central node map

function GetParents¶

Gets all nodes this node is directly depending on.

virtual void GetParents (
    GenApi::NodeList_t & Parents
) const = 0

Parameters:

Parents List of parent nodes

function GetPollingTime¶

virtual int64_t GetPollingTime () const = 0

recommended polling time (for non-cacheable nodes)

function GetPrincipalInterfaceType¶

virtual EInterfaceType GetPrincipalInterfaceType () const = 0

Get the type of the main interface of a node

function GetProperty¶

virtual bool GetProperty (
    const GenICam::gcstring & PropertyName,
    GenICam::gcstring & ValueStr,
    GenICam::gcstring & AttributeStr
) = 0

Retrieves a property plus an additional attribute by name If a property has multiple values/attribute they come with Tabs as delimiters

function GetPropertyNames¶

virtual void GetPropertyNames (
    GenICam::gcstring_vector & PropertyNames
) const = 0

Returns a list of the names all properties set during initialization

function GetVisibility¶

virtual EVisibility GetVisibility () const = 0

Get the recommended visibility of the node

function ImposeAccessMode¶

virtual void ImposeAccessMode (
    EAccessMode ImposedAccessMode
) = 0

Imposes an access mode to the natural access mode of the node

function ImposeVisibility¶

virtual void ImposeVisibility (
    EVisibility ImposedVisibility
) = 0

Imposes a visibility to the natural visibility of the node

function InvalidateNode¶

virtual void InvalidateNode () = 0

Indicates that the node's value may have changed. Fires the callback on this and all dependent nodes

function IsAccessModeCacheable¶

virtual EYesNo IsAccessModeCacheable () const = 0

True if the AccessMode can be cached

function IsAvailable¶

inline bool IsAvailable (
    EAccessMode AccessMode
)

Tests if available

function IsAvailable¶

inline bool IsAvailable (
    const IBase * p
)

Checks if a node is available

function IsAvailable¶

inline bool IsAvailable (
    const IBase & r
)

Checks if a node is available

function IsCachable¶

virtual bool IsCachable () const = 0

Is the node value cacheable

function IsCacheable¶

inline bool IsCacheable (
    ECachingMode CachingMode
)

Tests Cacheability

function IsDeprecated¶

virtual bool IsDeprecated () const = 0

True if the node should not be used any more

function IsFeature¶

virtual bool IsFeature () const = 0

True if the node can be reached via category nodes from a category node named "Root"

function IsImplemented¶

inline bool IsImplemented (
    EAccessMode AccessMode
)

Tests if implemented

function IsImplemented¶

inline bool IsImplemented (
    const IBase * p
)

Checks if a node is implemented

function IsImplemented¶

inline bool IsImplemented (
    const IBase & r
)

Checks if a node is implemented

function IsReadable¶

inline bool IsReadable (
    EAccessMode AccessMode
)

Tests if readable

function IsReadable¶

inline bool IsReadable (
    const IBase * p
)

Checks if a node is readable

function IsReadable¶

inline bool IsReadable (
    const IBase & r
)

Checks if a node is readable

function IsStreamable¶

virtual bool IsStreamable () const = 0

True if the node is streamable

function IsVisible¶

inline bool IsVisible (
    EVisibility Visibility,
    EVisibility MaxVisiblity
)

Tests Visibility CAVE : this relies on the EVisibility enum's coding

function IsWritable¶

inline bool IsWritable (
    EAccessMode AccessMode
)

Tests if writable

function IsWritable¶

inline bool IsWritable (
    const IBase * p
)

Checks if a node is writable

function IsWritable¶

inline bool IsWritable (
    const IBase & r
)

Checks if a node is writable

function RegisterCallback¶

virtual CallbackHandleType RegisterCallback (
    CNodeCallback * pCallback
) = 0

Register change callback Takes ownership of the CNodeCallback object

function operator!=¶

virtual bool operator!= (
    int nullPtr
) const = 0

function operator==¶

virtual bool operator== (
    int nullPtr
) const = 0