Spinnaker C
4.3.0.189
 
Enumerations
Spinnaker C GenICam Enumerations

Enumeration definitions for Spinnaker C GenICam API. More...

Enumerations

enum  _spinNodeType {
  ValueNode, BaseNode, IntegerNode, BooleanNode,
  FloatNode, CommandNode, StringNode, RegisterNode,
  EnumerationNode, EnumEntryNode, CategoryNode, PortNode,
  UnknownNode = -1
}
 
enum  _spinSign { Signed, Unsigned, _UndefinedSign }
 
enum  _spinAccessMode {
  NI, NA, WO, RO,
  RW, _UndefinedAccesMode, _CycleDetectAccesMode
}
 
enum  _spinVisibility {
  Beginner = 0, Expert = 1, Guru = 2, Invisible = 3,
  _UndefinedVisibility = 99
}
 
enum  _spinCachingMode { NoCache, WriteThrough, WriteAround, _UndefinedCachingMode }
 
enum  _spinRepresentation {
  Linear, Logarithmic, Boolean, PureNumber,
  HexNumber, IPV4Address, MACAddress, _UndefinedRepresentation
}
 recommended representation of a node value More...
 
enum  _spinEndianess { BigEndian, LittleEndian, _UndefinedEndian }
 Endianess of a value in a register. More...
 
enum  _spinNameSpace { Custom, Standard, _UndefinedNameSpace }
 Defines if a node name is standard or custom. More...
 
enum  _spinStandardNameSpace {
  None, GEV, IIDC, CL,
  USB, _UndefinedStandardNameSpace
}
 Defines from which standard namespace a node name comes from. More...
 
enum  _spinYesNo { Yes = 1, No = 0, _UndefinedYesNo = 2 }
 Defines the chices of a Yes/No alternaitve. More...
 
enum  _spinSlope {
  Increasing, Decreasing, Varying, Automatic,
  _UndefinedESlope
}
 typedef for fomula type More...
 
enum  _spinXMLValidation {
  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  _spinDisplayNotation { fnAutomatic, fnFixed, fnScientific, _UndefinedEDisplayNotation }
 typedef for float notation More...
 
enum  _spinInterfaceType {
  intfIValue, intfIBase, intfIInteger, intfIBoolean,
  intfICommand, intfIFloat, intfIString, intfIRegister,
  intfICategory, intfIEnumeration, intfIEnumEntry, intfIPort
}
 typedef for interface type More...
 
enum  _spinLinkType {
  ctAllDependingNodes, ctAllTerminalNodes, ctInvalidators, ctReadingChildren,
  ctWritingChildren, ctDependingChildren
}
 typedef for link type More...
 
enum  _spinIncMode { noIncrement, fixedIncrement, listIncrement }
 typedef for increment mode More...
 
enum  _spinInputDirection { idFrom, idTo, idNone }
 typedef for link type More...
 

Detailed Description

Enumeration definitions for Spinnaker C GenICam API.

Enumeration Type Documentation

◆ _spinAccessMode

Enumerator
NI 
NA 
WO 
RO 
RW 
_UndefinedAccesMode 
_CycleDetectAccesMode 

◆ _spinCachingMode

Enumerator
NoCache 
WriteThrough 
WriteAround 
_UndefinedCachingMode 

◆ _spinDisplayNotation

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

◆ _spinEndianess

Endianess of a value in a register.

Enumerator
BigEndian 

Register is big endian.

LittleEndian 

Register is little endian.

_UndefinedEndian 

Object is not yet initialized.

◆ _spinIncMode

typedef for increment mode

Enumerator
noIncrement 
fixedIncrement 
listIncrement 

◆ _spinInputDirection

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

◆ _spinInterfaceType

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

◆ _spinLinkType

typedef for link type

Enumerator
ctAllDependingNodes 
ctAllTerminalNodes 

All nodes which will be invalidated if this node becomes invalid

ctInvalidators 

All terminal nodes which may be written to by this node

ctReadingChildren 

List of references to nodes which may invalidate this node

ctWritingChildren 

All child nodes which influence this node's AccessMode

ctDependingChildren 

All child nodes which may be written to

All child nodes which will cause this node to be invalidated

◆ _spinNameSpace

Defines if a node name is standard or custom.

Enumerator
Custom 

name resides in custom namespace

Standard 

name resides in one of the standard namespaces

_UndefinedNameSpace 

Object is not yet initialized.

◆ _spinNodeType

Enumerator
ValueNode 
BaseNode 
IntegerNode 
BooleanNode 
FloatNode 
CommandNode 
StringNode 
RegisterNode 
EnumerationNode 
EnumEntryNode 
CategoryNode 
PortNode 
UnknownNode 

◆ _spinRepresentation

recommended representation of a node value

Enumerator
Linear 

Slider with linear behavior.

Logarithmic 

Slider with logarithmic behaviour.

Boolean 

Check box.

PureNumber 

Decimal number in an edit control.

HexNumber 

Hex number in an edit control.

IPV4Address 

IP-Address.

MACAddress 

MAC-Address.

_UndefinedRepresentation 

◆ _spinSign

enum _spinSign
Enumerator
Signed 
Unsigned 
_UndefinedSign 

◆ _spinSlope

enum _spinSlope

typedef for fomula 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

◆ _spinStandardNameSpace

Defines from which standard namespace a node name comes from.

Enumerator
None 

name resides in custom namespace

GEV 

name resides in GigE Vision namespace

IIDC 

name resides in 1394 IIDC namespace

CL 

name resides in camera link namespace

USB 

name resides in USB namespace

_UndefinedStandardNameSpace 

Object is not yet initialized.

◆ _spinVisibility

Enumerator
Beginner 
Expert 
Guru 
Invisible 
_UndefinedVisibility 

◆ _spinXMLValidation

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

The enum values for a bitfield of lenght 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

Object is not yet initialized

◆ _spinYesNo

enum _spinYesNo

Defines the chices of a Yes/No alternaitve.

Enumerator
Yes 

yes

No 

no

_UndefinedYesNo 

Object is not yet initialized.