VisionBox .NET Library
VIB_NET::TriggerOverEthernet Class Reference
+ Inheritance diagram for VIB_NET::TriggerOverEthernet:

Detailed Description

This class represents the TriggerOverEthernet (ToE) module which allows the generation of GigE Action Commands.

See class VIB::TriggerOverEthernet in the VisionBox Interface Library for a detailed description.

+ C# example code

Public Types

enum  eTOE_ACTIONCOMMAND_SOURCE
 The source signal definitions for the Action Command trigger, used by ConfigureTriggerSource() More...
 

Public Member Functions

void ConfigureActionCommand (const UInt32 CommandID, const UInt32 DeviceKey, UInt32 GroupKey, UInt32 GroupMask)
 Configures the GigE Action Command parameters for the given command id More...
 
void ConfigureTriggerSource (const UInt32 CommandID, const VIB_NET::TriggerOverEthernet::eTOE_ACTIONCOMMAND_SOURCE src, const bool Invert)
 Selects the source signal for the Action Command for the given command id More...
 
void Reset ()
 Resets the device to default settings. More...
 
void ResetActionCommand (const UInt32 CommandID)
 Disables and clears the configuration for the given command id More...
 
 TriggerOverEthernet ()
 Default constructor for the device object More...
 
- Public Member Functions inherited from VIB_NET::iDevice
void Close ()
 Closes a device More...
 
bool isOpen ()
 Returns the open state of a device object More...
 
void Open ()
 Opens a device More...
 
void Open (unsigned int Index)
 Opens a device More...
 

Properties

UInt32 NumberOfCommands [get]
 Contains the number of supported Action Commands More...
 
virtual VIB_NET::eDEVICE_TYPE Type [get]
 Returns the device type for the current instance, see eDEVICE_TYPE More...
 
- Properties inherited from VIB_NET::iDevice
virtual VIB_NET::eDEVICE_TYPE Type [get]
 Returns the device type for the current instance, see eDEVICE_TYPE More...
 

Member Enumeration Documentation

◆ eTOE_ACTIONCOMMAND_SOURCE

The source signal definitions for the Action Command trigger, used by ConfigureTriggerSource()


Enumerator
MUX_OUT0 

Multiplexer Output 0.

MUX_OUT1 

Multiplexer Output 1.

MUX_OUT2 

Multiplexer Output 2.

MUX_OUT3 

Multiplexer Output 3.

MUX_OUT4 

Multiplexer Output 4.

MUX_OUT5 

Multiplexer Output 5.

MUX_OUT6 

Multiplexer Output 6.

MUX_OUT7 

Multiplexer Output 7.

MUX_OUT8 

Multiplexer Output 8.

MUX_OUT9 

Multiplexer Output 9.

MUX_OUT10 

Multiplexer Output 10.

MUX_OUT11 

Multiplexer Output 11.

MUX_OUT12 

Multiplexer Output 12.

MUX_OUT13 

Multiplexer Output 13.

MUX_OUT14 

Multiplexer Output 14.

MUX_OUT15 

Multiplexer Output 15.

Constructor & Destructor Documentation

◆ TriggerOverEthernet()

VIB_NET::TriggerOverEthernet::TriggerOverEthernet ( )

Default constructor for the device object

The device must be opened with Open() before it can be used.

Member Function Documentation

◆ ConfigureActionCommand()

void VIB_NET::TriggerOverEthernet::ConfigureActionCommand ( const UInt32  CommandID,
const UInt32  DeviceKey,
UInt32  GroupKey,
UInt32  GroupMask 
)

Configures the GigE Action Command parameters for the given command id

Parameters
CommandIDIndex of the Action Command, 0 ... (NumberOfCommands - 1)
DeviceKeyGigE Action Device Key
GroupKeyGigE Action Group Key
GroupMaskGigE Action Group Mask

◆ ConfigureTriggerSource()

void VIB_NET::TriggerOverEthernet::ConfigureTriggerSource ( const UInt32  CommandID,
const VIB_NET::TriggerOverEthernet::eTOE_ACTIONCOMMAND_SOURCE  src,
const bool  Invert 
)

Selects the source signal for the Action Command for the given command id

Parameters
CommandIDIndex of the Action Command, 0 ... (NumberOfCommands - 1)
srcSource signal
InvertPolarity of the trigger signal for the Action Command

◆ Reset()

void VIB_NET::TriggerOverEthernet::Reset ( )

Resets the device to default settings.

See also VIB::TriggerOverEthernet::Reset().

◆ ResetActionCommand()

void VIB_NET::TriggerOverEthernet::ResetActionCommand ( const UInt32  CommandID)

Disables and clears the configuration for the given command id

Parameters
CommandIDIndex of the Action Command, 0 ... (NumberOfCommands - 1)

Property Documentation

◆ NumberOfCommands

VIB_NET::TriggerOverEthernet::NumberOfCommands
get

Contains the number of supported Action Commands

◆ Type

VIB_NET::TriggerOverEthernet::Type
get

Returns the device type for the current instance, see eDEVICE_TYPE

VIB_NET
All relevant classes and functions are residing in this namespace.
Definition: CameraLinkIn.cpp:6
VIB_NET::Multiplexer
This class controls the Multiplexer unit which connects signal sources and sinks with each other.
Definition: VIB_NET.h:978
VIB_NET::Multiplexer::eMUX_SOURCE
eMUX_SOURCE
Source signal definitions for the Multiplexer
Definition: VIB_NET.h:983
VIB_NET::TriggerOverEthernet::eTOE_ACTIONCOMMAND_SOURCE
eTOE_ACTIONCOMMAND_SOURCE
The source signal definitions for the Action Command trigger, used by ConfigureTriggerSource()
Definition: VIB_NET.h:1558
VIB_NET::TriggerOverEthernet
This class represents the TriggerOverEthernet (ToE) module which allows the generation of GigE Action...
Definition: VIB_NET.h:1553
VIB_NET::VIBSystem::OpenDevice
VIB_NET::iDevice ^ OpenDevice(VIB_NET::eDEVICE_TYPE Type, Int32 Index)
Opens a device and creates a device object
Definition: VIBSystem.cpp:245
VIB_NET::VIBSystem
Factory for devices
Definition: VIB_NET.h:1707