ItalaApiC  1.3.3
Typedefs | Enumerations
Definitions_GenApi

Typedefs

typedef int32_t Sign
 
typedef int32_t AccessMode
 
typedef int32_t Visibility
 
typedef int32_t CachingMode
 
typedef int32_t Representation
 
typedef int32_t Endianess
 
typedef int32_t NameSpace
 
typedef int32_t StandardNameSpace
 
typedef int32_t YesNo
 
typedef int32_t Slope
 
typedef int32_t XMLValidation
 
typedef int32_t DisplayNotation
 
typedef int32_t InterfaceType
 
typedef int32_t LinkType
 
typedef int32_t IncMode
 
typedef int32_t InputDirection
 
typedef int32_t GenApiSchemaVersion
 

Enumerations

enum  _Sign { Signed = 0, Unsigned = 1, _UndefinedSign = 2 }
 
enum  _AccessMode {
  NI = 0, NA = 1, WO = 2, RO = 3,
  RW = 4, _UndefinedAccesMode = 5, _CycleDetectAccesMode = 6
}
 
enum  _Visibility {
  Beginner = 0, Expert = 1, Guru = 2, Invisible = 3,
  _UndefinedVisibility = 99
}
 
enum  _CachingMode { NoCache = 0, WriteThrough = 1, WriteAround = 2, _UndefinedCachingMode = 3 }
 
enum  _Representation {
  Linear = 0, Logarithmic = 1, Boolean = 2, PureNumber = 3,
  HexNumber = 4, IPV4Address = 5, MACAddress = 6
}
 
enum  _Endianess { BigEndian = 0, LittleEndian = 1, _UndefinedEndian = 2 }
 
enum  _NameSpace { Custom = 0, Standard = 1, _UndefinedNameSpace = 2 }
 
enum  _StandardNameSpace {
  None = 0, GEV = 1, IIDC = 2, CL = 3,
  USB = 4, _UndefinedStandardNameSpace = 5
}
 
enum  _YesNo { Yes = 1, No = 0, _UndefinedYesNo = 2 }
 
enum  _Slope {
  Increasing = 0, Decreasing = 1, Varying = 2, Automatic = 3,
  _UndefinedESlope = 4
}
 
enum  _XMLValidation {
  xvLoad = 0x00000001L, xvCycles = 0x00000002L, xvSFNC, xvDefault = 0x00000000L,
  xvAll = 0xffffffffL, _UndefinedEXMLValidation = 0x8000000L
}
 
enum  _DisplayNotation { fnAutomatic = 0, fnFixed = 1, fnScientific = 2, _UndefinedEDisplayNotation = 3 }
 
enum  _InterfaceType {
  intfIValue = 0, intfIBase = 1, intfIInteger = 2, intfIBoolean = 3,
  intfICommand = 4, intfIFloat = 5, intfIString = 6, intfIRegister = 7,
  intfICategory = 8, intfIEnumeration = 9, intfIEnumEntry = 10, intfIPort = 11
}
 
enum  _LinkType {
  ctParentNodes = 0, ctReadingChildren = 1, ctWritingChildren = 2, ctInvalidatingChildren = 3,
  ctDependingNodes = 4, ctTerminalNodes = 5, ctValueChangingChildren = 6
}
 
enum  _IncMode
 
enum  _InputDirection { idFrom = 0, idTo = 1, idNone = 2 }
 
enum  _GenApiSchemaVersion
 

Detailed Description

All the methods related to nodes managed by GenApi.

Typedef Documentation

◆ Sign

See also
_Sign

◆ AccessMode

See also
_AccessMode

◆ Visibility

See also
_Visibility

◆ CachingMode

See also
_CachingMode

◆ Representation

See also
_Representation

◆ Endianess

See also
_Endianess

◆ NameSpace

See also
_NameSpace

◆ StandardNameSpace

◆ YesNo

See also
_YesNo

◆ Slope

See also
_Slope

◆ XMLValidation

See also
_XMLValidation

◆ DisplayNotation

◆ InterfaceType

See also
_InterfaceType

◆ LinkType

See also
_LinkType

◆ IncMode

See also
_IncMode

◆ InputDirection

See also
_InputDirection

◆ GenApiSchemaVersion

Enumeration Type Documentation

◆ _Sign

enum _Sign

Enumeration for sign value.

Enumerator
Signed 

Integer is signed.

Unsigned 

Integer is unsigned.

_UndefinedSign 

Object is not yet initialized.

◆ _AccessMode

Enumeration for access mode value.

Enumerator
NI 

Not implemented.

NA 

Not available.

WO 

Write Only.

RO 

Read Only.

RW 

Read and Write.

_UndefinedAccesMode 

Object is not yet initialized.

_CycleDetectAccesMode 

used internally for AccessMode cycle detection

◆ _Visibility

Enumeration for visibility value.

Enumerator
Beginner 

Always visible.

Expert 

Visible for experts or Gurus.

Guru 

Visible for Gurus.

Invisible 

Not Visible.

_UndefinedVisibility 

Object is not yet initialized.

◆ _CachingMode

Enumeration for caching mode value.

Enumerator
NoCache 

Do not use cache.

WriteThrough 

Write to cache and register.

WriteAround 

Write to register, write to cache on read.

_UndefinedCachingMode 

Not yet initialized.

◆ _Representation

Enumeration for representation 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.

◆ _Endianess

enum _Endianess

Enumeration for endianess value.

Enumerator
BigEndian 

Register is big endian.

LittleEndian 

Register is little endian.

_UndefinedEndian 

Object is not yet initialized.

◆ _NameSpace

enum _NameSpace

Enumeration for namespace value.

Enumerator
Custom 

name resides in custom namespace

Standard 

name resides in one of the standard namespaces

_UndefinedNameSpace 

Object is not yet initialized.

◆ _StandardNameSpace

Enumeration for standard namespace value.

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.

◆ _YesNo

enum _YesNo

Enumeration for yes/no value.

Enumerator
Yes 

yes

No 

no

_UndefinedYesNo 

Object is not yet initialized.

◆ _Slope

enum _Slope

Enumeration for slope value.

Enumerator
Increasing 

strictly monotonous increasing

Decreasing 

strictly monotonous decreasing

Varying 

slope changes, e.g. at run-time

Automatic 

slope is determined automatically by probing the function

_UndefinedESlope 

Object is not yet initialized.

◆ _XMLValidation

Enumeration for xml validation value.

Enumerator
xvLoad 

Creates a dummy node map.

xvCycles 

checks for write and dependency cycles (implies xvLoad)

xvSFNC 

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

xvDefault 

checks performed if nothing else is said

xvAll 

all possible checks

_UndefinedEXMLValidation 

Object is not yet initialized.

◆ _DisplayNotation

Enumeration for display notation value.

Enumerator
fnAutomatic 

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

fnFixed 

the notation is fixed, e.g. 123.4

fnScientific 

the notation is scientific, e.g. 1.234e2

_UndefinedEDisplayNotation 

Object is not yet initialized.

◆ _InterfaceType

Enumeration for interface type value.

Enumerator
intfIValue 

IValue interface.

intfIBase 

IBase interface.

intfIInteger 

IInteger interface.

intfIBoolean 

IBoolean interface.

intfICommand 

ICommand interface.

intfIFloat 

IFloat interface.

intfIString 

IString interface.

intfIRegister 

IRegister interface.

intfICategory 

ICategory interface.

intfIEnumeration 

IEnumeration interface.

intfIEnumEntry 

IEnumEntry interface.

intfIPort 

IPort interface.

◆ _LinkType

enum _LinkType

Enumeration for link type value.

Enumerator
ctParentNodes 

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

ctReadingChildren 

All nodes which can be read from.

ctWritingChildren 

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

ctInvalidatingChildren 

All directly connected nodes which invalidate this node.

ctDependingNodes 

All directly or indirectly connected nodes which are invalidated by this nodes (i.e. which are dependent on this node)

ctTerminalNodes 

All indirectly connected terminal nodes.

ctValueChangingChildren 

All child node used to compute the value.

◆ _IncMode

enum _IncMode

Enumeration for increment mode value.

◆ _InputDirection

Enumeration for input direction value.

Enumerator
idFrom 

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

idTo 

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

idNone 

SwissKnife is not used within a converter.

◆ _GenApiSchemaVersion

Enumeration for gen api schema version value.