Skip to content

GenApi Node Interfaces and Access Mode Check Functions#

Module: GenICam

Files#

Name
GenApi/GenApi.h
Main include file for using GenApi with smart pointers.
GenApi/IBase.h
Definition of interface IBase.
GenApi/IBoolean.h
Definition of IBoolean interface.
GenApi/ICategory.h
Definition of interface ICategory and types FeatureList_t :
GenApi/ICommand.h
Definition of ICommand interface.
GenApi/IEnumEntry.h
GenApi/IEnumeration.h
Definition of interface IEnumeration.
GenApi/IEnumerationT.h
Definition of interface IEnumerationT.
GenApi/IFloat.h
Definition of the IFloat interface.
GenApi/IInteger.h
Definition of the interface IInteger.
GenApi/INode.h
Definition of interface INode and types NodeList_t and CallbackHandleType:
GenApi/INodeMap.h
Definition of interface INodeMap.
GenApi/IPort.h
Definition of interface IPort.
GenApi/IRegister.h
Definition of RegisterList_t type and the interface IRegister.
GenApi/IString.h
Definition of interface IString.
GenApi/IValue.h
Definition of the interface IValue.
GenApi/NodeMapRef.h
Definition of CNodeMapRef.

Classes#

Name
struct GenApi::IBase
Base interface common to all nodes.
struct GenApi::IBoolean
Interface for Boolean properties.
struct GenApi::ICategory
Gives access to a category node.
struct GenApi::ICommand
struct GenApi::IEnumEntry
Interface of single enum value.
struct GenApi::IEnumeration
Interface for enumeration properties.
struct GenApi::IEnumerationT
Interface for enumeration properties.
struct GenApi::IFloat
Interface for float properties.
struct GenApi::IInteger
Interface for integer properties.
struct GenApi::INode
Interface common to all nodes.
struct GenApi::INodeMap
Interface to access the node map.
struct GenApi::IPort
Interface for ports.
struct GenApi::IRegister
Interface for registers.
struct GenApi::IString
Interface for string properties.
struct GenApi::IValue
Interface for value properties.
class GenApi::CNodeMapRefT
Smartpointer template for NodeMaps with create function.
class GenApi::CGeneric_XMLLoaderParams
Empty base class used by class CNodeMapRef as generic template argument.
class GenApi::CNodeMapRef
Smartpointer for NodeMaps with create function.

Functions#

Name
bool IsReadable(EAccessMode AccessMode)
Tests if readable.
bool IsReadable(const IBase * p)
Checks if a node is readable.
bool IsReadable(const IBase & r)
Checks if a node is readable.
bool IsWritable(EAccessMode AccessMode)
Tests if writable.
bool IsWritable(const IBase * p)
Checks if a node is writable.
bool IsWritable(const IBase & r)
Checks if a node is writable.
bool IsImplemented(EAccessMode AccessMode)
Tests if implemented.
bool IsImplemented(const IBase * p)
Checks if a node is implemented.
bool IsImplemented(const IBase & r)
Checks if a node is implemented.
bool IsAvailable(EAccessMode AccessMode)
Tests if available.
bool IsAvailable(const IBase * p)
Checks if a node is available.
bool IsAvailable(const IBase & r)
Checks if a node is available.
EAccessMode Combine(EAccessMode Peter, EAccessMode Paul)
Computes which access mode the two guards allow together.
bool IsVisible(EVisibility Visibility, EVisibility MaxVisiblity)
Tests Visibility.
EVisibility Combine(EVisibility Peter, EVisibility Paul)
Computes which visibility the two guards allow together.
bool IsCacheable(ECachingMode CachingMode)
Tests Cacheability.
ECachingMode Combine(ECachingMode Peter, ECachingMode Paul)
Computes which CachingMode results from a combination.

Functions Documentation#

IsReadable#

inline bool IsReadable(
    EAccessMode AccessMode
)

Tests if readable.

IsReadable#

inline bool IsReadable(
    const IBase * p
)

Checks if a node is readable.

IsReadable#

inline bool IsReadable(
    const IBase & r
)

Checks if a node is readable.

IsWritable#

inline bool IsWritable(
    EAccessMode AccessMode
)

Tests if writable.

IsWritable#

inline bool IsWritable(
    const IBase * p
)

Checks if a node is writable.

IsWritable#

inline bool IsWritable(
    const IBase & r
)

Checks if a node is writable.

IsImplemented#

inline bool IsImplemented(
    EAccessMode AccessMode
)

Tests if implemented.

IsImplemented#

inline bool IsImplemented(
    const IBase * p
)

Checks if a node is implemented.

IsImplemented#

inline bool IsImplemented(
    const IBase & r
)

Checks if a node is implemented.

IsAvailable#

inline bool IsAvailable(
    EAccessMode AccessMode
)

Tests if available.

IsAvailable#

inline bool IsAvailable(
    const IBase * p
)

Checks if a node is available.

IsAvailable#

inline bool IsAvailable(
    const IBase & r
)

Checks if a node is available.

Combine#

inline EAccessMode Combine(
    EAccessMode Peter,
    EAccessMode Paul
)

Computes which access mode the two guards allow together.

IsVisible#

inline bool IsVisible(
    EVisibility Visibility,
    EVisibility MaxVisiblity
)

Tests Visibility.

CAVE : this relys on the EVisibility enum's coding

Combine#

inline EVisibility Combine(
    EVisibility Peter,
    EVisibility Paul
)

Computes which visibility the two guards allow together.

IsCacheable#

inline bool IsCacheable(
    ECachingMode CachingMode
)

Tests Cacheability.

Combine#

inline ECachingMode Combine(
    ECachingMode Peter,
    ECachingMode Paul
)

Computes which CachingMode results from a combination.


Updated on 5 July 2022 at 15:30:01