ItalaApiNET  1.3.3
Namespaces | Classes | Enumerations | Functions
Itala Namespace Reference

Namespaces

Classes

struct  DeviceInfo
 This class stores information about a device and represents its identity. When an enumeration (also known as "discovery") is performed via the ISystem interface, a list of DeviceInfo is returned as result. To initialize and use a particular connected device, the user must pass the corresponding DeviceInfo instance to the ISystem interface. More...
 
interface  IDefectDetection
 Interface for defective pixel detection. The description of the process principles is provided in Opto Engineering's camera manuals. The instance must be disposed via IDefectDetection.Dispose when it's no longer required. More...
 
interface  IDevice
 Interface representing a device. Provides functions for image acquisition, camera configuration and event handling. It encloses the functionalities of GenTL's Datastream and Local Device modules. The instance must be disposed via IDevice.Dispose when it's no longer required. More...
 
interface  IImage
 Image interface. It represents the image buffer grabbed from the device. The instance must be disposed when it's no longer required via IImage.Dispose. More...
 
struct  InterfaceInfo
 This class stores information about an available interface and represents its identity. When an enumeration is performed via the ISystem interface, a list of InterfaceInfo is returned as result. To enumerate the available devices under a specific interface, the user must pass the corresponding InterfaceInfo instance to the dedicated ISystem.EnumerateDevices function. More...
 
interface  ISystem
 Public interface for the system instance. The system is the core and unique element from which cameras can be retrived and used accordingly with GenICam standards. More...
 
struct  PolarComponents
 Convenient POD structure used as container for ExtractAllPolarComponents 's multi-result. More...
 
struct  PolarComponentsColor
 Convenient POD structure used as container for ExtractAllPolarComponentsColor 's multi-result. More...
 
struct  StokesVectors
 Convenient POD structure used as container for ComputeAllStokes 's multi-result. More...
 

Enumerations

enum  DeviceAccessStatus {
  DeviceAccessStatus.UnknownAccessStatus = 0, DeviceAccessStatus.AvailableReadWrite = 1, DeviceAccessStatus.AvailableReadOnly = 2, DeviceAccessStatus.Unreachable = 3,
  DeviceAccessStatus.Busy = 4, DeviceAccessStatus.AlreadyOpenReadWrite = 5, DeviceAccessStatus.AlreadyOpenReadOnly = 6
}
 
enum  Sign { Sign.Signed = 0, Sign.Unsigned = 1, Sign._UndefinedSign = 2 }
 
enum  AccessMode {
  AccessMode.NI, AccessMode.NA, AccessMode.WO, AccessMode.RO,
  AccessMode.RW, AccessMode._UndefinedAccesMode, AccessMode._CycleDetectAccesMode
}
 
enum  Visibility {
  Visibility.Beginner = 0, Visibility.Expert = 1, Visibility.Guru = 2, Visibility.Invisible = 3,
  Visibility._UndefinedVisibility = 99
}
 
enum  CachingMode { CachingMode.NoCache = 0, CachingMode.WriteThrough = 1, CachingMode.WriteAround = 2, CachingMode._UndefinedCachingMode = 3 }
 
enum  Representation {
  Representation.Linear = 0, Representation.Logarithmic = 1, Representation.Boolean = 2, Representation.PureNumber = 3,
  Representation.HexNumber = 4, Representation.IPV4Address = 5, Representation.MACAddress = 6
}
 
enum  Endianess { Endianess.BigEndian = 0, Endianess.LittleEndian = 1, Endianess._UndefinedEndian = 2 }
 
enum  NameSpace { NameSpace.Custom = 0, NameSpace.Standard = 1, NameSpace._UndefinedNameSpace = 2 }
 
enum  StandardNameSpace {
  StandardNameSpace.None = 0, StandardNameSpace.GEV = 1, StandardNameSpace.IIDC = 2, StandardNameSpace.CL = 3,
  StandardNameSpace.USB = 4, StandardNameSpace._UndefinedStandardNameSpace = 5
}
 
enum  YesNo { YesNo.Yes = 1, YesNo.No = 0, YesNo._UndefinedYesNo = 2 }
 
enum  Slope {
  Slope.Increasing = 0, Slope.Decreasing = 1, Slope.Varying = 2, Slope.Automatic = 3,
  Slope._UndefinedESlope = 4
}
 
enum  DisplayNotation { DisplayNotation.fnAutomatic = 0, DisplayNotation.fnFixed = 1, DisplayNotation.fnScientific = 2, DisplayNotation._UndefinedEDisplayNotation = 3 }
 
enum  InterfaceType {
  InterfaceType.intfIValue = 0, InterfaceType.intfIBase = 1, InterfaceType.intfIInteger = 2, InterfaceType.intfIBoolean = 3,
  InterfaceType.intfICommand = 4, InterfaceType.intfIFloat = 5, InterfaceType.intfIString = 6, InterfaceType.intfIRegister = 7,
  InterfaceType.intfICategory = 8, InterfaceType.intfIEnumeration = 9, InterfaceType.intfIEnumEntry = 10, InterfaceType.intfIPort = 11
}
 
enum  LinkType {
  LinkType.ctParentNodes = 0, LinkType.ctReadingChildren = 1, LinkType.ctWritingChildren = 2, LinkType.ctInvalidatingChildren = 3,
  LinkType.ctDependingNodes = 4, LinkType.ctTerminalNodes = 5, LinkType.ctValueChangingChildren = 6
}
 
enum  InputDirection { InputDirection.idFrom = 0, InputDirection.idTo = 1, InputDirection.idNone = 2 }
 

Functions

delegate void DeviceEventHandler (IDevice device, UInt64 eventId)
 Type used to detect and handle events coming from the device by the DeviceEvent event. More...
 

Enumeration Type Documentation

◆ DeviceAccessStatus

Enumerator
UnknownAccessStatus 

Unknown access status.

AvailableReadWrite 

Available read and write.

AvailableReadOnly 

Available read only.

Unreachable 

Unreachable.

Busy 

Busy.

AlreadyOpenReadWrite 

Already open read and write.

AlreadyOpenReadOnly 

Already open read only.

◆ Sign

enum Itala.Sign
strong
Enumerator
Signed 

Integer is signed.

Unsigned 

Integer is unsigned.

_UndefinedSign 

Object is not yet initialized.

◆ AccessMode

enum Itala.AccessMode
strong
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

enum Itala.Visibility
strong
Enumerator
Beginner 

Always visible.

Expert 

Visible for experts or Gurus.

Guru 

Visible for Gurus.

Invisible 

Not Visible.

_UndefinedVisibility 

Object is not yet initialized.

◆ CachingMode

enum Itala.CachingMode
strong
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

enum Itala.Representation
strong
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 Itala.Endianess
strong
Enumerator
BigEndian 

Register is big endian.

LittleEndian 

Register is little endian.

_UndefinedEndian 

Object is not yet initialized.

◆ NameSpace

enum Itala.NameSpace
strong
Enumerator
Custom 

name resides in custom namespace

Standard 

name resides in one of the standard namespaces

_UndefinedNameSpace 

Object is not yet initialized.

◆ StandardNameSpace

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 Itala.YesNo
strong
Enumerator
Yes 

yes

No 

no

_UndefinedYesNo 

Object is not yet initialized.

◆ Slope

enum Itala.Slope
strong
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.

◆ DisplayNotation

enum Itala.DisplayNotation
strong
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

enum Itala.InterfaceType
strong
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 Itala.LinkType
strong
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.

◆ InputDirection

enum Itala.InputDirection
strong
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.

Function Documentation

◆ DeviceEventHandler()

delegate void Itala.DeviceEventHandler ( IDevice  device,
UInt64  eventId 
)

Type used to detect and handle events coming from the device by the DeviceEvent event.