Classes | Files | Enumerations | Functions | Variables
GenApi_PublicInterface

Classes

class  GENAPI_NAMESPACE::CGeneric_XMLLoaderParams
 Empty base class used by class CNodeMapRef as generic template argument. More...
class  GENAPI_NAMESPACE::CNodeMapFactory
 The node map factory is used for creating node maps from camera description files. More...
class  GENAPI_NAMESPACE::CNodeMapRef
 Smartpointer for NodeMaps with create function. More...
class  GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >
 Smartpointer template for NodeMaps with create function. More...
class  GENAPI_NAMESPACE::double_autovector_t
 Vector of doubles with reference counting. More...
class  GENAPI_NAMESPACE::int64_autovector_t
 Vector of integers with reference counting. More...

Files

file  Autovector.h
 

This file contains the public definition of the autovector classes.


file  GenApi.h
 

Main include file for using GenApi with smart pointers.


file  GenApiLinkage.h
 

Contains GenApi's linker directives.


file  IBase.h
 

Definition of interface IBase.


file  IBoolean.h
 

Definition of IBoolean interface.


file  ICategory.h
 

Definition of interface ICategory and types FeatureList_t :


file  IChunkPort.h
 

Definition of interface IChunkPort.


file  ICommand.h
 

Definition of ICommand interface.


file  IDeviceInfo.h
 

Definition of interface INodeMap.


file  IEnumEntry.h
file  IEnumeration.h
 

Definition of interface IEnumeration.


file  IEnumerationT.h
 

Definition of interface IEnumerationT.


file  IFloat.h
 

Definition of the IFloat interface.


file  IInteger.h
 

Definition of the interface IInteger.


file  INode.h
 

Definition of interface INode and types NodeList_t and CallbackHandleType:


file  INodeMap.h
 

Definition of interface INodeMap.


file  INodeMapDyn.h
 

Definition of interface INodeMapDyn.


file  IPort.h
 

Definition of interface IPort.


file  IPortRecorder.h
 

Definition of interface IPort.


file  IRegister.h
 

Definition of RegisterList_t type and the interface IRegister.


file  IString.h
 

Definition of interface IString.


file  IValue.h
 

Definition of the interface IValue.


file  NodeMapFactory.h
 

Definition of the node map factory.


file  NodeMapRef.h
 

Definition of CNodeMapRef.


file  PortWriteList.h
 

Definition of interface IPort.


Enumerations

enum  GENAPI_NAMESPACE::ECacheUsage_t { GENAPI_NAMESPACE::CacheUsage_Automatic, GENAPI_NAMESPACE::CacheUsage_ForceWrite, GENAPI_NAMESPACE::CacheUsage_ForceRead, GENAPI_NAMESPACE::CacheUsage_Ignore }
 Lists the cache usage strategies. The cache stores preprocessed camera description xml files providing faster access or smaller footprint. More...
enum  GENAPI_NAMESPACE::EContentType_t { GENAPI_NAMESPACE::ContentType_Xml, GENAPI_NAMESPACE::ContentType_ZippedXml }
 Lists the processable file types. More...

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.
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.
bool GENAPI_NAMESPACE::IsCacheable (ECachingMode CachingMode)
 Tests Cacheability.
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.
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.

Variables

interface GENAPI_DECL_ABSTRACT
int64_t 
GENAPI_NAMESPACE::Address
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IBoolean
 Interface for Boolean properties.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ICategory
 Gives access to a category node.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IChunkPort
 Interface for ports attached to a chunk.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ICommand
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IEnumEntry
 Interface of single enum value.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IEnumeration
 Interface for enumeration properties.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IFloat
 Interface for float properties.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IInteger
 Interface for integer properties.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INode
 Interface common to all nodes.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INodeMapDyn
 Interface to access the node map.
interface GENAPI_DECL_ABSTRACT bool GENAPI_NAMESPACE::Invalidate = true ) = 0
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPort
 Interface for ports.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPortRecorder
 Interface for recording write commands on a port.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPortReplay
 Interface for replaying write commands on a port.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IRegister
 Interface for registers.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IString
 Interface for string properties.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IValue
 Interface for value properties.
interface GENAPI_DECL_ABSTRACT
int64_t int64_t 
GENAPI_NAMESPACE::Length = 0
interface GENAPI_DECL_ABSTRACT bool GENAPI_NAMESPACE::Verify = true) = 0

Enumeration Type Documentation

Lists the cache usage strategies. The cache stores preprocessed camera description xml files providing faster access or smaller footprint.

Note:
The environment variable GENICAM_CACHE_VERSION, e.g. GENICAM_CACHE_V3_0, must contain the path to cache directory for using the cache.
Enumerator:
CacheUsage_Automatic 

The use of cache files is determined automatically.

CacheUsage_ForceWrite 

Forces the loading and preprocessing of the camera description xml file. If a cache directory is available the result of preprocessing is written to the cache.

CacheUsage_ForceRead 

Suppresses loading and preprocessing of the camera description xml file and forces reading a cache file from cache directory. Fails if no matching cache file is available.

CacheUsage_Ignore 

Forces the loading and preprocessing of the camera description xml file. No cache file is written.

Definition at line 49 of file NodeMapFactory.h.

Lists the processable file types.

Enumerator:
ContentType_Xml 

XML camera description file text.

ContentType_ZippedXml 

Zipped XML camera description file text.

Definition at line 63 of file NodeMapFactory.h.


Function Documentation

EAccessMode GENAPI_NAMESPACE::Combine ( EAccessMode  Peter,
EAccessMode  Paul 
) [inline]

Computes which access mode the two guards allow together.

Definition at line 248 of file INode.h.

EVisibility GENAPI_NAMESPACE::Combine ( EVisibility  Peter,
EVisibility  Paul 
) [inline]

Computes which visibility the two guards allow together.

Definition at line 277 of file INode.h.

ECachingMode GENAPI_NAMESPACE::Combine ( ECachingMode  Peter,
ECachingMode  Paul 
) [inline]

Computes which CachingMode results from a combination.

Definition at line 300 of file INode.h.

bool GENAPI_NAMESPACE::IsAvailable ( EAccessMode  AccessMode) [inline]

Tests if available.

Definition at line 230 of file INode.h.

bool GENAPI_NAMESPACE::IsAvailable ( const IBase *  p) [inline]

Checks if a node is available.

Definition at line 236 of file INode.h.

bool GENAPI_NAMESPACE::IsAvailable ( const IBase &  r) [inline]

Checks if a node is available.

Definition at line 242 of file INode.h.

bool GENAPI_NAMESPACE::IsCacheable ( ECachingMode  CachingMode) [inline]

Tests Cacheability.

Definition at line 294 of file INode.h.

bool GENAPI_NAMESPACE::IsImplemented ( EAccessMode  AccessMode) [inline]

Tests if implemented.

Definition at line 212 of file INode.h.

bool GENAPI_NAMESPACE::IsImplemented ( const IBase *  p) [inline]

Checks if a node is implemented.

Definition at line 218 of file INode.h.

bool GENAPI_NAMESPACE::IsImplemented ( const IBase &  r) [inline]

Checks if a node is implemented.

Definition at line 224 of file INode.h.

bool GENAPI_NAMESPACE::IsReadable ( EAccessMode  AccessMode) [inline]

Tests if readable.

Definition at line 176 of file INode.h.

bool GENAPI_NAMESPACE::IsReadable ( const IBase *  p) [inline]

Checks if a node is readable.

Definition at line 182 of file INode.h.

bool GENAPI_NAMESPACE::IsReadable ( const IBase &  r) [inline]

Checks if a node is readable.

Definition at line 188 of file INode.h.

bool GENAPI_NAMESPACE::IsVisible ( EVisibility  Visibility,
EVisibility  MaxVisiblity 
) [inline]

Tests Visibility.

CAVE : this relys on the EVisibility enum's coding

Definition at line 270 of file INode.h.

bool GENAPI_NAMESPACE::IsWritable ( EAccessMode  AccessMode) [inline]

Tests if writable.

Definition at line 194 of file INode.h.

bool GENAPI_NAMESPACE::IsWritable ( const IBase *  p) [inline]

Checks if a node is writable.

Definition at line 200 of file INode.h.

bool GENAPI_NAMESPACE::IsWritable ( const IBase &  r) [inline]

Checks if a node is writable.

Definition at line 206 of file INode.h.


Variable Documentation

Definition at line 55 of file IPort.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IBoolean

Interface for Boolean properties.

Definition at line 59 of file IBoolean.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ICategory

Gives access to a category node.

Definition at line 65 of file ICategory.h.

Interface for ports attached to a chunk.

Definition at line 67 of file IChunkPort.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ICommand

Interface for command like properties

Definition at line 57 of file ICommand.h.

Interface of single enum value.

Maps of Enum Values to symbolic values

Definition at line 58 of file IEnumEntry.h.

Interface for enumeration properties.

Definition at line 58 of file IEnumeration.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IFloat

Interface for float properties.

Definition at line 58 of file IFloat.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IInteger

Interface for integer properties.

Definition at line 58 of file IInteger.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INode

Interface common to all nodes.

Definition at line 58 of file INode.h.

Interface to access the node map.

Definition at line 54 of file INodeMapDyn.h.

interface GENAPI_DECL_ABSTRACT bool GENAPI_NAMESPACE::Invalidate = true ) = 0

Definition at line 70 of file IPortRecorder.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPort

Interface for ports.

Definition at line 55 of file IPort.h.

Interface for recording write commands on a port.

Definition at line 71 of file IPortRecorder.h.

Interface for replaying write commands on a port.

Definition at line 56 of file IPortRecorder.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IRegister

Interface for registers.

Definition at line 59 of file IRegister.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IString

Interface for string properties.

Definition at line 59 of file IString.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IValue

Interface for value properties.

Definition at line 59 of file IValue.h.

interface GENAPI_DECL_ABSTRACT int64_t GENAPI_NAMESPACE::Length = 0

Definition at line 55 of file IPort.h.

interface GENAPI_DECL_ABSTRACT bool GENAPI_NAMESPACE::Verify = true) = 0

Definition at line 59 of file IBoolean.h.



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