Spinnaker SDK C++
4.1.0.157
 
 

 
Loading...
Searching...
No Matches

Macros

#define _UndefindedRepresentation   _UndefinedRepresentation
 

Typedefs

typedef GenICam::gcstring_vector StringList_t
 A list of strings.
 

Enumerations

enum  ESign { Signed , Unsigned , _UndefinedSign }
 signed or unsigned integers More...
 
enum  EAccessMode {
  NI , NA , WO , RO ,
  RW , _UndefinedAccesMode , _CycleDetectAccesMode
}
 access mode of a node More...
 
enum  EVisibility {
  Beginner = 0 , Expert = 1 , Guru = 2 , Invisible = 3 ,
  _UndefinedVisibility = 99
}
 recommended visibility of a node More...
 
enum  ECachingMode { NoCache , WriteThrough , WriteAround , _UndefinedCachingMode }
 caching mode of a register More...
 
enum  ERepresentation {
  Linear , Logarithmic , Boolean , PureNumber ,
  HexNumber , IPV4Address , MACAddress , _UndefinedRepresentation
}
 recommended representation of a node value More...
 
enum  EEndianess { BigEndian , LittleEndian , _UndefinedEndian }
 Endianess of a value in a register. More...
 
enum  ENameSpace { Custom , Standard , _UndefinedNameSpace }
 Defines if a node name is standard or custom. More...
 
enum  EStandardNameSpace {
  None , GEV , IIDC , CL ,
  USB , _UndefinedStandardNameSpace
}
 Defines from which standard namespace a node name comes from. More...
 
enum  EYesNo { Yes = 1 , No = 0 , _UndefinedYesNo = 2 }
 Defines the choices of a Yes/No alternative. More...
 
enum  ESlope {
  Increasing , Decreasing , Varying , Automatic ,
  _UndefinedESlope
}
 typedef for formula type More...
 
enum  EXMLValidation {
  xvLoad = 0x00000001L , xvCycles = 0x00000002L , xvSFNC = 0x00000004L , xvDefault = 0x00000000L ,
  xvAll = 0xffffffffL , _UndefinedEXMLValidation = 0x8000000L
}
 typedef describing the different validity checks which can be performed on an XML file More...
 
enum  EDisplayNotation { fnAutomatic , fnFixed , fnScientific , _UndefinedEDisplayNotation }
 typedef for float notation More...
 
enum  EInterfaceType {
  intfIValue , intfIBase , intfIInteger , intfIBoolean ,
  intfICommand , intfIFloat , intfIString , intfIRegister ,
  intfICategory , intfIEnumeration , intfIEnumEntry , intfIPort
}
 typedef for interface type More...
 
enum  ELinkType {
  ctParentNodes , ctReadingChildren , ctWritingChildren , ctInvalidatingChildren ,
  ctDependingNodes , ctTerminalNodes
}
 typedef for link type More...
 
enum  EIncMode { noIncrement , fixedIncrement , listIncrement }
 typedef for increment mode More...
 
enum  EInputDirection { idFrom , idTo , idNone }
 typedef for link type More...
 
enum  EGenApiSchemaVersion { v1_0 = 1 , v1_1 = 2 , _Undefined = -1 }
 GenApi schema version. More...
 

Detailed Description

Macro Definition Documentation

◆ _UndefindedRepresentation

#define _UndefindedRepresentation   _UndefinedRepresentation

Typedef Documentation

◆ StringList_t

typedef GenICam::gcstring_vector StringList_t

A list of strings.

Enumeration Type Documentation

◆ EAccessMode

access mode of a node

Enumerator
NI 
NA 

Not implemented.

WO 

Not available.

RO 

Write Only.

RW 

Read Only.

_UndefinedAccesMode 

Read and Write.

_CycleDetectAccesMode 

Object is not yet initialized.

used internally for AccessMode cycle detection

◆ ECachingMode

caching mode of a register

Enumerator
NoCache 
WriteThrough 

Do not use cache.

WriteAround 

Write to cache and register.

_UndefinedCachingMode 

Write to register, write to cache on read.

Not yet initialized

◆ EDisplayNotation

typedef for float notation

Enumerator
fnAutomatic 
fnFixed 

the notation if either scientific or fixed depending on what is shorter

fnScientific 

the notation is fixed, e.g.

123.4

_UndefinedEDisplayNotation 

the notation is scientific, e.g.

1.234e2 Object is not yet initialized

◆ EEndianess

enum EEndianess

Endianess of a value in a register.

Enumerator
BigEndian 
LittleEndian 

Register is big endian.

_UndefinedEndian 

Register is little endian.

Object is not yet initialized

◆ EGenApiSchemaVersion

GenApi schema version.

Enumerator
v1_0 
v1_1 
_Undefined 

◆ EIncMode

enum EIncMode

typedef for increment mode

Enumerator
noIncrement 
fixedIncrement 

The feature has no increment.

listIncrement 

The feature has a fix increment.

◆ EInputDirection

typedef for link type

Enumerator
idFrom 
idTo 

Indicates a swiss knife that it is used as worker for a converter computing FROM.

idNone 

Indicates a swiss knife that it is used as worker for a converter computing TO.

SwissKnife is not used within a converter

◆ EInterfaceType

typedef for interface type

Enumerator
intfIValue 
intfIBase 

IValue interface.

intfIInteger 

IBase interface.

intfIBoolean 

IInteger interface.

intfICommand 

IBoolean interface.

intfIFloat 

ICommand interface.

intfIString 

IFloat interface.

intfIRegister 

IString interface.

intfICategory 

IRegister interface.

intfIEnumeration 

ICategory interface.

intfIEnumEntry 

IEnumeration interface.

intfIPort 

IEnumEntry interface.

IPort interface

◆ ELinkType

enum ELinkType

typedef for link type

Enumerator
ctParentNodes 
ctReadingChildren 

All nodes for which this node is at least an invalidating child.

ctWritingChildren 

All nodes which can be read from.

ctInvalidatingChildren 

All nodes which can write a value further down the node stack.

ctDependingNodes 

All directly connected nodes which invalidate this node.

ctTerminalNodes 

All directly or indirectly connected nodes which are invalidated by this nodes (i.e.

which are dependent on this node) All indirectly connected terminal nodes

◆ ENameSpace

enum ENameSpace

Defines if a node name is standard or custom.

Enumerator
Custom 
Standard 

name resides in custom namespace

_UndefinedNameSpace 

name resides in one of the standard namespaces

Object is not yet initialized

◆ ERepresentation

recommended representation of a node value

Enumerator
Linear 
Logarithmic 

Slider with linear behavior.

Boolean 

Slider with logarithmic behavior.

PureNumber 

Check box.

HexNumber 

Decimal number in an edit control.

IPV4Address 

Hex number in an edit control.

MACAddress 

IP-Address.

_UndefinedRepresentation 

MAC-Address.

◆ ESign

enum ESign

signed or unsigned integers

Enumerator
Signed 
Unsigned 

Integer is signed.

_UndefinedSign 

Integer is unsigned.

Object is not yet initialized

◆ ESlope

enum ESlope

typedef for formula type

Enumerator
Increasing 
Decreasing 

strictly monotonous increasing

Varying 

strictly monotonous decreasing

Automatic 

slope changes, e.g.

at run-time

_UndefinedESlope 

slope is determined automatically by probing the function

Object is not yet initialized

◆ EStandardNameSpace

Defines from which standard namespace a node name comes from.

Enumerator
None 
GEV 

name resides in custom namespace

IIDC 

name resides in GigE Vision namespace

CL 

name resides in 1394 IIDC namespace

USB 

name resides in camera link namespace

_UndefinedStandardNameSpace 

name resides in USB namespace

Object is not yet initialized

◆ EVisibility

recommended visibility of a node

Enumerator
Beginner 
Expert 

Always visible.

Guru 

Visible for experts or Gurus.

Invisible 

Visible for Gurus.

_UndefinedVisibility 

Not Visible.

◆ EXMLValidation

typedef describing the different validity checks which can be performed on an XML file

The enum values for a bit field of length uint32_t

Enumerator
xvLoad 
xvCycles 

Creates a dummy node map.

xvSFNC 

checks for write and dependency cycles (implies xvLoad)

xvDefault 

checks for conformance with the standard feature naming convention (SFNC)

xvAll 

checks performed if nothing else is said

_UndefinedEXMLValidation 

all possible checks

◆ EYesNo

enum EYesNo

Defines the choices of a Yes/No alternative.

Enumerator
Yes 
No 

yes

_UndefinedYesNo 

no