CVB++ 15.0
Cvb::GevServer Namespace Reference

Describes a GenICam Pixel Format Naming Convention (PFNC) compatible image memory buffer with possibly additional data. More...

Classes

class  BooleanNode
 GenApi::BooleanNode that is configurable. More...
 
class  CategoryNode
 Node that logically groups other nodes. More...
 
class  ChunkImageBufferDescription
 Describes a GenICam Pixel Format Naming Convention (PFNC) compatible image memory buffer with possibly additional data. More...
 
class  CommandNode
 A node that can be executed. More...
 
class  EnumEntryNode
 One entry in an enumeration. More...
 
class  EnumerationNode
 A GenApi::EnumerationNode that is configurable. More...
 
class  Float32RegNode
 An float32 FloatRegNode node. More...
 
class  Float64RegNode
 An float64 FloatRegNode node. More...
 
class  FloatBaseNode
 Represents a floating point number. More...
 
class  FloatNode
 Represents a floating point number. More...
 
class  FloatRegNode
 Floating point value register. More...
 
class  ImageBufferDescription
 Describes a GenICam Pixel Format Naming Convention (PFNC) compatible image memory buffer. More...
 
class  Int32RegNode
 An Int32 IntRegNode node. More...
 
class  Int64RegNode
 An Int64 IntRegNode node. More...
 
class  IntegerBaseNode
 Represents an integer number. More...
 
class  IntegerNode
 Represents a integer number. More...
 
class  IntRegNode
 Integer value register. More...
 
class  IntSwissKnifeNode
 Read only node to calculate formulas on the client side with integer arithmetic. More...
 
class  LogicalNetworkInterface
 An IP network interface the GevServer can be bound to. More...
 
class  Node
 Basic GevServer node for device feature access. More...
 
class  NodeMap
 Contains all nodes of the GevServer. More...
 
class  SelectorNode
 Groups other nodes that are dependent on this one. More...
 
class  Server
 Common Vision Blox GigE Vision Server implements a GigE Vision camera in software. More...
 
class  Stream
 The stream to send Images or other data. 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...
 

Typedefs

using ServerPtr = std::shared_ptr< Server >
 Convenience shared pointer for GevServer.
 
using NodePtr = std::shared_ptr< Node >
 Convenience shared pointer for Node.
 
using NodeMapPtr = std::shared_ptr< NodeMap >
 Convenience shared pointer for NodeMap.
 
using StreamPtr = std::shared_ptr< Stream >
 Convenience shared pointer for Stream.
 
using ValueNodePtr = std::shared_ptr< ValueNode >
 Convenience shared pointer for ValueNode.
 
using StringNodePtr = std::shared_ptr< StringNode >
 Convenience shared pointer for StringNode.
 
using StringRegNodePtr = std::shared_ptr< StringRegNode >
 Convenience shared pointer for StringRegNode.
 
using BooleanNodePtr = std::shared_ptr< BooleanNode >
 Convenience shared pointer for BooleanNode.
 
using CategoryNodePtr = std::shared_ptr< CategoryNode >
 Convenience shared pointer for CategoryNode.
 
using IntegerBaseNodePtr = std::shared_ptr< IntegerBaseNode >
 Convenience shared pointer for IntegerBaseNode.
 
using FloatBaseNodePtr = std::shared_ptr< FloatBaseNode >
 Convenience shared pointer for FloatBaseNode.
 
using IntegerNodePtr = std::shared_ptr< IntegerNode >
 Convenience shared pointer for IntegerNode.
 
using FloatNodePtr = std::shared_ptr< FloatNode >
 Convenience shared pointer for FloatNode.
 
using Float32RegNodePtr = std::shared_ptr< Float32RegNode >
 Convenience shared pointer for Float43RegNode.
 
using Float64RegNodePtr = std::shared_ptr< Float64RegNode >
 Convenience shared pointer for Float64RegNode.
 
using FloatRegNodePtr = std::shared_ptr< FloatRegNode >
 Convenience shared pointer for FloatNode.
 
using IntRegNodePtr = std::shared_ptr< IntRegNode >
 Convenience shared pointer for IntRegNode.
 
using SelectorNodePtr = std::shared_ptr< SelectorNode >
 Convenience shared pointer for SelectorNode.
 
using EnumEntryNodePtr = std::shared_ptr< EnumEntryNode >
 Convenience shared pointer for EnumEntryNode.
 
using CommandNodePtr = std::shared_ptr< CommandNode >
 Convenience shared pointer for CommandNode.
 
using Int32RegNodePtr = std::shared_ptr< Int32RegNode >
 Convenience shared pointer for Int32RegNode.
 
using Int64RegNodePtr = std::shared_ptr< Int64RegNode >
 Convenience shared pointer for Int32RegNode.
 
using EnumerationNodePtr = std::shared_ptr< EnumerationNode >
 Convenience shared pointer for EnumerationNode.
 
using IntSwissKnifeNodePtr = std::shared_ptr< IntSwissKnifeNode >
 Convenience shared pointer for IntSwissKnifeNode.
 

Enumerations

enum class  State
 The possible states this GevServer can be in.
 
enum class  DriverType { Auto = CExports::DT_Auto , Socket = CExports::DT_Socket , Filter = CExports::DT_Filter }
 GigE Vision driver to use for communication and streaming. More...
 
enum class  Namespace { Standard = CExports::GSNS_Standard , Custom = CExports::GSNS_Custom , Private = CExports::GSNS_Private }
 The possible name spaces a node can be in. More...
 
enum class  NodeEvent { Read = CExports::GSNE_Read , Write = CExports::GSNE_Write }
 Node event. More...
 
enum class  NodeType {
  Invalid = CExports::GSNT_Invalid , Unknown = CExports::GSNT_Unknown , Category = CExports::GSNT_Category , IntReg = CExports::GSNT_IntReg ,
  StringReg = CExports::GSNT_StringReg , String = CExports::GSNT_String , Integer = CExports::GSNT_Integer , Boolean = CExports::GSNT_Boolean ,
  Command = CExports::GSNT_Command , Enumeration = CExports::GSNT_Enumeration , EnumEntry = CExports::GSNT_EnumEntry , IntSwissKnife = CExports::GSNT_IntSwissKnife ,
  Float = CExports::GSNT_Float , FloatReg = CExports::GSNT_FloatReg
}
 Available node types. More...
 
enum class  Info {
  XMLVersionMajor = CExports::GSI_XMLVersionMajor , XMLVersionMinor = CExports::GSI_XMLVersionMinor , XMLVersionSubMinor = CExports::GSI_XMLVersionSubMinor , ServerUserVersion = CExports::GSI_ServerUserVersion ,
  AcquisitionActive = CExports::GSI_AcquisitionActive
}
 General version and acquisition information. More...
 
enum class  NodeInfo {
  Name = CExports::GSNI_Name , DisplayName = CExports::GSNI_DisplayName , AccessMode = CExports::GSNI_AccessMode , Max = CExports::GSNI_Max ,
  Min = CExports::GSNI_Min , Increment = CExports::GSNI_Increment , NumEnumEntries = CExports::GSNI_NumEnumEntries , Streamable = CExports::GSNI_Streamable ,
  CachingMode = CExports::GSNI_CachingMode , ToolTip = CExports::GSNI_Tooltip , Description = CExports::GSNI_Description , Visibility = CExports::GSNI_Visibility ,
  PollingTime = CExports::GSNI_PollingTime , EventID = CExports::GSNI_EventID , NameSpace = CExports::GSNI_Namespace , RegisterLength = CExports::GSNI_RegisterLength ,
  RegisterAddress = CExports::GSNI_RegisterAddress , NumberRepresentation = CExports::GSNI_NumberRepresentation , Value = CExports::GSNI_Value , OnValue = CExports::GSNI_OnValue ,
  OffValue = CExports::GSNI_OffValue , Formula = CExports::GSNI_Formula , ImposedAccessMode , IsImplemented = CExports::GSNI_IsImplemented ,
  IsAvailable = CExports::GSNI_IsAvailable , IsLocked = CExports::GSNI_IsLocked , Alias = CExports::GSNI_Alias , Sign = CExports::GSNI_Sign ,
  Unit = CExports::GSNI_Unit , DisplayPrecision = CExports::GSNI_DisplayPrecision , Last = CExports::GSNI_Last
}
 Possible information a node can hold. More...
 
enum class  NumberRepresentation {
  None = CExports::GSNR_None , Linear = CExports::GSNR_Linear , Logarithmic = CExports::GSNR_Logarithmic , Boolean = CExports::GSNR_Boolean ,
  PureNumber = CExports::GSNR_PureNumber , HexNumber = CExports::GSNR_HexNumber
}
 Defines how a number is to be interpreted/displayed in a graphical user interface. More...
 
enum class  NumberSign { Unsigned = CExports::GSNS_Unsigned , Signed = CExports::GSNS_Signed }
 The signedness of the number. More...
 
enum class  NodeList { Child = CExports::GSNL_Child , Selected = CExports::GSNL_Selected , Invalidator = CExports::GSNL_Invalidator , Addresses = CExports::GSNL_Addresses }
 Node access. More...
 
enum class  PayloadType { Image = CExports::GSPT_Image , File = CExports::GSPT_File , ChunkImage = CExports::GSPT_ChunkImage }
 The type of the payload. More...
 

Detailed Description

Describes a GenICam Pixel Format Naming Convention (PFNC) compatible image memory buffer with possibly additional data.

Namespace for GevServer based device configuration.

This buffer needn't be CVB Image compatible. You can use all PFNC values even packed ones.

Online Manual
Common Vision Blox-Tool GigE Vision Server
Example
GevServer/QmlGevServer
Remarks
CMake users: Link to imported target CVB::CvbGevServer

Enumeration Type Documentation

◆ DriverType

enum class DriverType
strong

GigE Vision driver to use for communication and streaming.

Enumerator
Auto 

Auto select driver type.

Socket 

Socket driver.

Filter 

Filter driver.

◆ Info

enum class Info
strong

General version and acquisition information.

Enumerator
XMLVersionMajor 

Major XML version info.

XMLVersionMinor 

Minor XML version info.

XMLVersionSubMinor 

Sub minor XML version info.

ServerUserVersion 

User version of the server.

AcquisitionActive 

Acquisition active info.

◆ Namespace

enum class Namespace
strong

The possible name spaces a node can be in.

Enumerator
Standard 

Standard name space.

Custom 

Custom name space.

Private 

Private name space.

◆ NodeEvent

enum class NodeEvent
strong

Node event.

Enumerator
Read 

Read from node.

Write 

"Write to node.

◆ NodeInfo

enum class NodeInfo
strong

Possible information a node can hold.

Enumerator
Name 

Gets the full name of the node.

DisplayName 

Gets the display name of the node.

AccessMode 

Gets the access mode of the node.

Max 

Gets the maximum value.

Min 

Gets the minimum value.

Increment 

Gets the increment.

NumEnumEntries 

Number of enumeration entries for NInfoEnum.

Streamable 

Information on the streamability of the node.

CachingMode 

Gets the caching mode.

ToolTip 

Gets the tool tip (short description).

Description 

Gets the long descriptive text.

Visibility 

Gets the visibility level.

PollingTime 

Gets the polling time in ms.

EventID 

Gets the event ID if available.

NameSpace 

Gets the node namespace.

RegisterLength 

Gets the register nodes length in bytes.

RegisterAddress 

Gets the current address of the register (can change).

NumberRepresentation 

Accesses the representation of a number.

Value 

Accesses the value configuration.

OnValue 

Boolean specific: accesses the integer value for true. Command specific: accesses the integer value for execute.

OffValue 

Boolean specific: accesses the integer value for false.

Formula 

Formula for swiss knife nodes.

ImposedAccessMode 

Accesses the TAccessMode of the node overriding the nodes it depends on.

IsImplemented 

Access the IInteger node defining whether the node is implemented.

IsAvailable 

Accesses the IInteger node defining whether the node is available.

IsLocked 

Accesses the IInteger node defining whether the node is read only.

Alias 

Accesses the alias node of this node.

Sign 

Accesses the signed or unsigned state of integer registers.

Unit 

Accesses the unit of a node as string.

DisplayPrecision 

Accesses the float node's display precision configuration.

Last 

Node last.

◆ NodeList

enum class NodeList
strong

Node access.

Enumerator
Child 

Node accesses the child nodes. Category: Nodes in category. Enumeration: EnumEntry nodes. SwissKnifes: Variables (Ex version only).

Selected 

Node accesses the selected nodes.

Invalidator 

Node accesses the invalidator nodes.

Addresses 

Node accesses the register address nodes (not constants).

◆ NodeType

enum class NodeType
strong

Available node types.

Enumerator
Invalid 

Node is invalid.

Unknown 

Node is of unknown type.

Category 

Node is a category node.

IntReg 

Node is an integer register node.

StringReg 

Node is a string register node.

String 

Node is a string node (no reg).

Integer 

Node is an integer node (no reg).

Boolean 

Node is a boolean node (no reg).

Command 

Node is a command node (no reg).

Enumeration 

Node is an enumeration node (no reg).

EnumEntry 

Node is an enumeration entry node (no reg).

IntSwissKnife 

Node is an integer swiss knife node (no reg).

Float 

Node is a float node (no reg).

FloatReg 

Node is a float register node.

◆ NumberRepresentation

enum class NumberRepresentation
strong

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

Enumerator
None 

No number representation.

Linear 

Linear number representation.

Logarithmic 

Logarithmic number representation.

Boolean 

Boolean number representation.

PureNumber 

Pure number representation.

HexNumber 

Hexadecimal number representation.

◆ NumberSign

enum class NumberSign
strong

The signedness of the number.

Enumerator
Unsigned 

Unsigned.

Signed 

Signed.

◆ PayloadType

enum class PayloadType
strong

The type of the payload.

Enumerator
Image 

Image payload.

File 

File payload.

ChunkImage 

Chunk image payload.