CVB.Net 14.0
Stemmer.Cvb.GenApi Namespace Reference

Classes

class  BooleanNode
 Node representing a true/false value. More...
 
class  CategoryNode
 Node that logically groups other nodes. More...
 
class  CategoryNodeDebugView
 Debug visualization for category nodes. More...
 
class  CommandNode
 A node that can be executed. More...
 
class  EnumEntryNode
 One entry in an enumeration. More...
 
class  EnumerationNode
 A node that presents a choice of values. More...
 
class  FloatNode
 Represents a floating point number. More...
 
class  FloatRegNode
 Floating point value register. More...
 
struct  GenApiVersion
 Version information for GenICam related objects. More...
 
interface  IBooleanNode
 GenICam GenApi node with a bool value. More...
 
interface  ICategoryNode
 GenICam GenApi node grouping other INode objects. More...
 
interface  ICommandNode
 GenICam GenApi node that is executable. More...
 
interface  IEnumEntryNode
 GenICam GenApi node representing one enumeration entry. More...
 
interface  IEnumerationNode
 GenICam GenApi node containing named values. More...
 
interface  IFloatNode
 GenICam GenApi node that has a double value. More...
 
interface  IIntegerNode
 GenICam GenApi node that has a long value. More...
 
interface  INode
 Generic GenICam GenApi node. More...
 
interface  INodeMap
 Read-only dictionary holding all INodes of a device or module. More...
 
class  IntegerNode
 Represents a floating point number. More...
 
class  IntRegNode
 Integer value register. More...
 
interface  IPortNode
 GenICam GenApi node that enable read/write access to e.g. a device. More...
 
interface  IRegisterNode
 GenICam GenApi register node. More...
 
interface  ISelectorNode
 GenICam GenApi node that can select others. More...
 
interface  IStringNode
 GenICam GenApi node that has a string value. More...
 
interface  IValueNode
 GenICam GenApi node having a value. More...
 
class  NamespaceDoc
 The types in the namespace Stemmer.Cvb.Driver.GenApi expose and implement the functionality covered by the CVGenApi.dll. More...
 
class  Node
 Basic GenApi node for device feature access. More...
 
class  NodeMap
 Contains all nodes of a device or module. More...
 
class  NodeMapDebugView
 View for node map in the debugger. More...
 
class  NodeRef
 Helper view on other node. More...
 
class  PortNode
 Port nodes are the connection to the remote device. More...
 
class  RegisterNode
 Untyped register access (only memory). More...
 
class  SelectorNode
 Groups Nodes, that are dependent on this one More...
 
class  SelectorNodeRef
 Helper view on other selector node. More...
 
class  StringNode
 String value node. More...
 
class  StringRegNode
 String value register. More...
 
class  ValueNode
 Base class for all Nodes, that have a value. More...
 

Enumerations

enum  AccessMode {
  NI = 0 , NA , RO , WO ,
  RW
}
 Access possibility of the Node. More...
 
enum  Visibility { Invisible = -1 , Beginner = 0 , Expert , Guru }
 Feature complexity level. More...
 
enum  CacheMode { NoCache = 0 , WriteThrough , WriteAround }
 Defines how the value is cached. More...
 
enum  NodeMapInfo {
  Vendor = 0 , Model , SchemaVersionMajor , SchemaVersionMinor ,
  SchemaVersionSubMinor , DeviceVersionMajor , DeviceVersionMinor , DeviceVersionSubMinor ,
  Namespace , ProductGUID , VersionGUID , Tooltip
}
 NodeMap information retrieval commands. More...
 
enum  NumberRepresentation {
  Undefined = -1 , Linear , Logarithmic , Boolean ,
  PureNumber , HexNumber , IPv4 , MAC
}
 Defines how a number is to be interpreted/displayed in a graphical user interface. More...
 
enum  ReadWriteVerify { None , WriteOnly , ReadOnly , Both }
 Controls how read/write operations are verified by the GenApi. More...
 

Enumeration Type Documentation

◆ AccessMode

enum AccessMode

Access possibility of the Node.

The access mode can change dependent on the device state.

Enumerator
NI 

Node is not implemented on this device.

Attention: If the node ValueNode.IsSelected, it can be that the node is only not implemented regarding the current selector(s) value(s)!

NA 

Node is not available.

Node can become available when the state of the device changes.

RO 

Node can only be read.

WO 

Node can only be written to.

RW 

Node can be read and written to.

◆ CacheMode

enum CacheMode

Defines how the value is cached.

Enumerator
NoCache 

No caching used.

WriteThrough 

Write to cache and register.

WriteAround 

Write to register, cache written on next read.

◆ NodeMapInfo

enum NodeMapInfo
package

NodeMap information retrieval commands.

Enumerator
Vendor 

Gets the vendor name of XML provider.

Model 

Gets the model name of XML provider.

SchemaVersionMajor 

Gets the schema major version number.

SchemaVersionMinor 

Gets the schema minor version number.

SchemaVersionSubMinor 

Gets the schema sub-minor version number.

DeviceVersionMajor 

Gets the device major version number.

DeviceVersionMinor 

Gets the device minor version number.

DeviceVersionSubMinor 

Gets the device sub-minor version number.

Namespace 

Gets the description namespace (e.g. GEV).

ProductGUID 

Gets the product GUID.

VersionGUID 

Gets the version GUID.

Tooltip 

Gets the XML description tool tip.

◆ NumberRepresentation

Defines how a number is to be interpreted/displayed in a graphical user interface.

Enumerator
Undefined 

Not set in XML (treated as linear)

Linear 

Slider with linear behavior.

Logarithmic 

Slider with logarithmic behavior.

Boolean 

True/False representation.

PureNumber 

Decimal number in an edit control.

HexNumber 

Hex number in an edit control.

IPv4 

IPv4 address in an edit control.

MAC 

MAC address in an edit control.

◆ ReadWriteVerify

Controls how read/write operations are verified by the GenApi.

Enumerator
None 

No verification while reading or writing values.

WriteOnly 

Only write operations are validated (default).

ReadOnly 

Only read operations are validated.

Both 

Both read and write operations are validated.

◆ Visibility

enum Visibility

Feature complexity level.

The visibility can be used as a filter to hide more complex or even dangerous features in an user interface.

Enumerator
Invisible 

Node should not be displayed.

Beginner 

Simple feature usable by everybody.

Expert 

More complex feature, that requires deeper knowledge about the feature.

Guru 

Very complex and/or dangerous feature.

Attention: Wrong usage of these features may damage the device.