Files | Classes | Enumerations | Functions | Variables
GenApi_PublicInterface

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.
 

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...
 

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. 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. More...
 
EVisibility GENAPI_NAMESPACE::Combine (EVisibility Peter, EVisibility Paul)
 Computes which visibility the two guards allow together. More...
 
ECachingMode GENAPI_NAMESPACE::Combine (ECachingMode Peter, ECachingMode Paul)
 Computes which CachingMode results from a combination. More...
 
bool GENAPI_NAMESPACE::IsAvailable (EAccessMode AccessMode)
 Tests if available. More...
 
bool GENAPI_NAMESPACE::IsAvailable (const IBase *p)
 Checks if a node is available. More...
 
bool GENAPI_NAMESPACE::IsAvailable (const IBase &r)
 Checks if a node is available. More...
 
bool GENAPI_NAMESPACE::IsCacheable (ECachingMode CachingMode)
 Tests Cacheability. More...
 
bool GENAPI_NAMESPACE::IsImplemented (EAccessMode AccessMode)
 Tests if implemented. More...
 
bool GENAPI_NAMESPACE::IsImplemented (const IBase *p)
 Checks if a node is implemented. More...
 
bool GENAPI_NAMESPACE::IsImplemented (const IBase &r)
 Checks if a node is implemented. More...
 
bool GENAPI_NAMESPACE::IsReadable (EAccessMode AccessMode)
 Tests if readable. More...
 
bool GENAPI_NAMESPACE::IsReadable (const IBase *p)
 Checks if a node is readable. More...
 
bool GENAPI_NAMESPACE::IsReadable (const IBase &r)
 Checks if a node is readable. More...
 
bool GENAPI_NAMESPACE::IsVisible (EVisibility Visibility, EVisibility MaxVisiblity)
 Tests Visibility. More...
 
bool GENAPI_NAMESPACE::IsWritable (EAccessMode AccessMode)
 Tests if writable. More...
 
bool GENAPI_NAMESPACE::IsWritable (const IBase *p)
 Checks if a node is writable. More...
 
bool GENAPI_NAMESPACE::IsWritable (const IBase &r)
 Checks if a node is writable. More...
 

Variables

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

Detailed Description

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 250 of file INode.h.

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

Computes which visibility the two guards allow together.

Definition at line 279 of file INode.h.

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

Computes which CachingMode results from a combination.

Definition at line 302 of file INode.h.

bool GENAPI_NAMESPACE::IsAvailable ( EAccessMode  AccessMode)
inline

Tests if available.

Definition at line 232 of file INode.h.

bool GENAPI_NAMESPACE::IsAvailable ( const IBase p)
inline

Checks if a node is available.

Definition at line 238 of file INode.h.

bool GENAPI_NAMESPACE::IsAvailable ( const IBase r)
inline

Checks if a node is available.

Definition at line 244 of file INode.h.

bool GENAPI_NAMESPACE::IsCacheable ( ECachingMode  CachingMode)
inline

Tests Cacheability.

Definition at line 296 of file INode.h.

bool GENAPI_NAMESPACE::IsImplemented ( EAccessMode  AccessMode)
inline

Tests if implemented.

Definition at line 214 of file INode.h.

bool GENAPI_NAMESPACE::IsImplemented ( const IBase p)
inline

Checks if a node is implemented.

Definition at line 220 of file INode.h.

bool GENAPI_NAMESPACE::IsImplemented ( const IBase r)
inline

Checks if a node is implemented.

Definition at line 226 of file INode.h.

bool GENAPI_NAMESPACE::IsReadable ( EAccessMode  AccessMode)
inline

Tests if readable.

Definition at line 178 of file INode.h.

bool GENAPI_NAMESPACE::IsReadable ( const IBase p)
inline

Checks if a node is readable.

Definition at line 184 of file INode.h.

bool GENAPI_NAMESPACE::IsReadable ( const IBase r)
inline

Checks if a node is readable.

Definition at line 190 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 272 of file INode.h.

bool GENAPI_NAMESPACE::IsWritable ( EAccessMode  AccessMode)
inline

Tests if writable.

Definition at line 196 of file INode.h.

bool GENAPI_NAMESPACE::IsWritable ( const IBase p)
inline

Checks if a node is writable.

Definition at line 202 of file INode.h.

bool GENAPI_NAMESPACE::IsWritable ( const IBase r)
inline

Checks if a node is writable.

Definition at line 208 of file INode.h.

Variable Documentation

interface GENAPI_DECL_ABSTRACT int64_t GENAPI_NAMESPACE::Address

Definition at line 57 of file IPort.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IBase
Initial value:
{
virtual EAccessMode GetAccessMode() const = 0
enum GENAPI_NAMESPACE::_EAccessMode EAccessMode
access mode of a node

Base interface common to all nodes.

Definition at line 55 of file IBase.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IBoolean

Interface for Boolean properties.

Definition at line 61 of file IBoolean.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ICategory

Gives access to a category node.

Definition at line 66 of file ICategory.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IChunkPort

Interface for ports attached to a chunk.

Definition at line 69 of file IChunkPort.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ICommand

Interface for command like properties.

Definition at line 59 of file ICommand.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IDeviceInfo
Initial value:
{
virtual GENICAM_NAMESPACE::gcstring GetModelName() = 0
A string class which is a clone of std::string.
Definition: GCString.h:52

Interface to get information about the device (= nodemap)

Definition at line 53 of file IDeviceInfo.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IEnumEntry

Interface of single enum value.

Maps of Enum Values to symbolic values

Definition at line 60 of file IEnumEntry.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IEnumeration

Interface for enumeration properties.

Definition at line 60 of file IEnumeration.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IFloat

Interface for float properties.

Definition at line 60 of file IFloat.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IInteger

Interface for integer properties.

Definition at line 61 of file IInteger.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INode

Interface common to all nodes.

Definition at line 60 of file INode.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INodeMap
Initial value:
{
virtual void GetNodes(NodeList_t &Nodes) const = 0
node_vector NodeList_t
a list of node references
Definition: INode.h:55

Interface to access the node map.

Definition at line 56 of file INodeMap.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INodeMapDyn

Interface to access the node map.

Definition at line 56 of file INodeMapDyn.h.

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

Definition at line 72 of file IPortRecorder.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPort

Interface for ports.

Definition at line 57 of file IPort.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPortRecorder

Interface for recording write commands on a port.

Definition at line 73 of file IPortRecorder.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPortReplay

Interface for replaying write commands on a port.

Definition at line 58 of file IPortRecorder.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IRegister

Interface for registers.

Definition at line 61 of file IRegister.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IString

Interface for string properties.

Definition at line 61 of file IString.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IValue

Interface for value properties.

Definition at line 61 of file IValue.h.

interface GENAPI_DECL_ABSTRACT int64_t GENAPI_NAMESPACE::Length = 0

Definition at line 57 of file IPort.h.

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

Definition at line 61 of file IBoolean.h.



rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:54