Abstract interface classes of the GenApi module

Files
file	ConcatenatedWrite.h
	This file contains the public definition of the node write concatenator 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	IPortStacked.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.
file	Autovector.h
	This file contains the public definition of the autovector classes.

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

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

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

Variables
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IBase
	Base interface common to all nodes.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IBoolean
	Interface for Boolean properties.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	ICategory
	Gives access to a category node.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IChunkPort
	Interface for ports attached to a chunk.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	ICommand
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IDeviceInfo
	Interface to get information about the device (= nodemap)
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IEnumEntry
	Interface of single enum value. More...
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IEnumeration
	Interface for enumeration properties.
template<typename EnumT >
GENICAM_INTERFACE	IEnumerationT
	Interface for enumeration properties.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IFloat
	Interface for float properties.
GENICAM_INTERFACE	IInteger
	Interface for integer properties.
GENICAM_INTERFACE	INode
	Interface common to all nodes.
GENICAM_INTERFACE	INodeMap
	Interface to access the node map.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	INodeMapDyn
	Interface to access the node map.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IPort
	Interface for ports.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IPortReplay
	Interface for replaying write commands on a port.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IPortRecorder
	Interface for recording write commands on a port.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IPortStacked
	Interface for ports.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IRegister
	Interface for registers.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IString
	Interface for string properties.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IValue
	Interface for value properties.

Detailed Description

Enumeration Type Documentation

ECacheUsage_t

enum ECacheUsage_t

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.

EContentType_t

enum EContentType_t

Enumerator
ContentType_Xml	XML camera description file text.
ContentType_ZippedXml	Zipped XML camera description file text.

Function Documentation

IsVisible()

bool GENAPI_NAMESPACE::IsVisible	(	EVisibility	Visibility,
		EVisibility	MaxVisiblity
	)

CAVE : this relys on the EVisibility enum's coding

Variable Documentation

ICommand

GENICAM_INTERFACE ICommand

Interface for command like properties

IEnumEntry

GENICAM_INTERFACE IEnumEntry

Maps of Enum Values to symbolic values