All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Files | Classes | Functions
GenApi Node Interfaces and Access Mode Check Functions
Collaboration diagram for GenApi Node Interfaces and Access Mode Check Functions:

Files

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  ICommand.h
 Definition of ICommand interface.
 
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  IPort.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  NodeMapRef.h
 Definition of CNodeMapRef.
 

Classes

struct  GenApi::IEnumerationT< EnumT >
 Interface for enumeration properties. More...
 
class  GenApi::CNodeMapRefT< TCameraParams >
 Smartpointer template for NodeMaps with create function. More...
 
class  GenApi::CGeneric_XMLLoaderParams
 Empty base class used by class CNodeMapRef as generic template argument. More...
 
class  GenApi::CNodeMapRef
 Smartpointer for NodeMaps with create function. More...
 

Functions

struct GenApi::__attribute__ ((visibility("default"))) IBase
 Base interface common to all nodes. More...
 
struct virtual __attribute__((visibility("default")))
IBoolean void 
GenApi::operator= (bool Value)
 Interface for Boolean properties. More...
 
virtual bool GenApi::operator() () const
 Get node value. More...
 
struct virtual __attribute__((visibility("default")))
IEnumEntry GenICam::gcstring 
GenApi::GetSymbolic () const =0
 Interface of single enum value. More...
 
struct virtual __attribute__((visibility("default")))
IEnumeration void 
GenApi::GetEntries (NodeList_t &Entries)=0
 Interface for enumeration properties. More...
 
struct virtual __attribute__((visibility("default")))
IFloat IFloat & 
GenApi::operator= (double Value)=0
 Interface for float properties. More...
 
struct virtual __attribute__((visibility("default")))
IInteger IInteger & 
GenApi::operator= (int64_t Value)=0
 Interface for integer properties. More...
 
struct virtual __attribute__((visibility("default")))
INode GenApi::ENameSpace 
GenApi::GetNameSpace () const =0
 Interface common to all nodes. More...
 
bool GenApi::IsReadable (EAccessMode AccessMode)
 Tests if readable.
 
bool GenApi::IsReadable (const IBase *p)
 Checks if a node is readable.
 
bool GenApi::IsReadable (const IBase &r)
 Checks if a node is readable.
 
bool GenApi::IsWritable (EAccessMode AccessMode)
 Tests if writable.
 
bool GenApi::IsWritable (const IBase *p)
 Checks if a node is writable.
 
bool GenApi::IsWritable (const IBase &r)
 Checks if a node is writable.
 
bool GenApi::IsImplemented (EAccessMode AccessMode)
 Tests if implemented.
 
bool GenApi::IsImplemented (const IBase *p)
 Checks if a node is implemented.
 
bool GenApi::IsImplemented (const IBase &r)
 Checks if a node is implemented.
 
bool GenApi::IsAvailable (EAccessMode AccessMode)
 Tests if available.
 
bool GenApi::IsAvailable (const IBase *p)
 Checks if a node is available.
 
bool GenApi::IsAvailable (const IBase &r)
 Checks if a node is available.
 
EAccessMode GenApi::Combine (EAccessMode Peter, EAccessMode Paul)
 Computes which access mode the two guards allow together.
 
bool GenApi::IsVisible (EVisibility Visibility, EVisibility MaxVisiblity)
 Tests Visibility. More...
 
EVisibility GenApi::Combine (EVisibility Peter, EVisibility Paul)
 Computes which visibility the two guards allow together.
 
bool GenApi::IsCacheable (ECachingMode CachingMode)
 Tests Cacheability.
 
ECachingMode GenApi::Combine (ECachingMode Peter, ECachingMode Paul)
 Computes which CachingMode results from a combination.
 
struct virtual __attribute__((visibility("default")))
IPort void 
GenApi::Write (const void *pBuffer, int64_t Address, int64_t Length)=0
 Interface for ports. More...
 
struct virtual __attribute__((visibility("default")))
IRegister void 
GenApi::Get (uint8_t *pBuffer, int64_t Length, bool Verify=false, bool IgnoreCache=false)=0
 Interface for registers. More...
 
virtual IEnumeration & GenApi::operator= (const GenICam::gcstring &ValueStr)=0
 Set string node value. More...
 

Detailed Description

Function Documentation

struct GenApi::__attribute__ ( (visibility("default"))  )

Base interface common to all nodes.

Basic interface to persist values to.

Interface for value properties.

Interface to access the node map.

Get the access mode of the node

Virtual destructor enforcing virtual destructor on all derived classes

Retrieves all nodes in the node map

Retrieves the node from the central map by Name

Invalidates all nodes

Connects a port to a port node with given name

Connects a port to the standard port "Device"

Get device name

The device name identifies a device instance, e.g. for debuggin purposes.

The default ist "Device".

Fires nodes which have a polling time

Returns the lock which guards the node map

Get the number of nodes in the map

sets information about the node map

Stores a feature

Retrieves all nodes in the node map

Retrieves the node from the central map by Name

Invalidates all nodes

Connects a port to a port node with given name

Connects a port to the standard port "Device"

Get device name

The device name identifies a device instance, e.g. for debuggin purposes.

The default ist "Device".

Fires nodes which have a polling time

Returns the lock which guards the node map

Get the number of nodes in the map

sets information about the node map

Stores a feature

struct virtual __attribute__ ((visibility("default"))) IRegister void GenApi::Get ( uint8_t *  pBuffer,
int64_t  Length,
bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtual

Interface for registers.

Parameters
pBufferThe buffer containing the data to set
LengthThe number of bytes in pBuffer
VerifyEnables AccessMode and Range verification (default = true)Fills a buffer with the register's contents
pBufferThe buffer receiving the data to read
LengthThe number of bytes to retrieve
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
struct virtual __attribute__ ((visibility("default"))) IEnumeration void GenApi::GetEntries ( NodeList_t &  Entries)
pure virtual

Interface for enumeration properties.

Get list of entry nodes

struct virtual __attribute__ ((visibility("default"))) INode GenApi::ENameSpace GenApi::GetNameSpace ( ) const
pure virtual

Interface common to all nodes.

Get name space

struct virtual __attribute__ ((visibility("default"))) IEnumEntry GenICam::gcstring GenApi::GetSymbolic ( ) const
pure virtual

Interface of single enum value.

Maps of Enum Values to symbolic values Get symbolic enum value

bool GenApi::IsVisible ( EVisibility  Visibility,
EVisibility  MaxVisiblity 
)
inline

Tests Visibility.

CAVE : this relys on the EVisibility enum's coding

GenICam::gcstring GenApi::operator() ( )
virtual

Get node value.

Interface for command like properties

Parameters
VerifyEnables AccessMode and Range verification (default = true)Execute the command
struct virtual __attribute__ ((visibility("default"))) IFloat IFloat& GenApi::operator= ( double  Value)
pure virtual

Interface for float properties.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)Set node value
struct virtual __attribute__ ((visibility("default"))) IInteger IInteger& GenApi::operator= ( int64_t  Value)
pure virtual

Interface for integer properties.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)Set node value
struct virtual __attribute__ ((visibility("default"))) IBoolean void GenApi::operator= ( bool  Value)
virtual

Interface for Boolean properties.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)Set node value
virtual IEnumeration& GenApi::operator= ( const GenICam::gcstring Value)
pure virtual

Set string node value.

Interface for string properties.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)Set node value
struct virtual __attribute__ ((visibility("default"))) IPort void GenApi::Write ( const void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
pure virtual

Interface for ports.

Writes a chunk of bytes to the port


pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)