IDS peak 2.10.0 / uEye+ firmware 3.34

IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.

Use EventNotification to specify whether the specified event should be sent to the host application. The event that should be sent to the host application is defined in the EventSelector.

Values description

•Off: The event notification is disabled. No event is generated.

•On: The event notification is enabled. If the event occurs, that is defined in the EventSelector, the event is sent to the host application.

•Once: The event notification is enabled once for the defined event. After the defined event occurs, EventNotification returns to "Off".

Code example

C++

// Before accessing EventNotification, make sure EventSelector is set correctly
// Set EventSelector to "EventDropped"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("EventSelector")->SetCurrentEntry("EventDropped");
// Determine the current entry of EventNotification
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("EventNotification")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of EventNotification
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("EventNotification")->Entries();
std::vector<std::shared_ptr<peak::core::nodes::EnumerationEntryNode>> availableEntries;
for(const auto & entry : allEntries)
{
  if ((entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotAvailable)
          && (entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotImplemented))
  {
      availableEntries.emplace_back(entry);
  }
}
// Set EventNotification to "On"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("EventNotification")->SetCurrentEntry("On");

C#

// Before accessing EventNotification, make sure EventSelector is set correctly
// Set EventSelector to "EventDropped"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("EventSelector").SetCurrentEntry("EventDropped");
// Determine the current entry of EventNotification
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("EventNotification").CurrentEntry().SymbolicValue();
// Get a list of all available entries of EventNotification
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("EventNotification").Entries();
List<string> availableEntries = new List<string>();
for(int i = 0; i < allEntries.Count(); ++i)
{
  if ((allEntries[i].AccessStatus() != peak.core.nodes.NodeAccessStatus.NotAvailable)
          && (allEntries[i].AccessStatus() != peak.core.nodes.NodeAccessStatus.NotImplemented))
  {
      availableEntries.Add(allEntries[i].SymbolicValue());
  }
}
// Set EventNotification to "On"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("EventNotification").SetCurrentEntry("On");

Python

# Before accessing EventNotification, make sure EventSelector is set correctly
# Set EventSelector to "EventDropped" (str)
nodeMapRemoteDevice.FindNode("EventSelector").SetCurrentEntry("EventDropped")
# Determine the current entry of EventNotification (str)
value = nodeMapRemoteDevice.FindNode("EventNotification").CurrentEntry().SymbolicValue()
# Get a list of all available entries of EventNotification
allEntries = nodeMapRemoteDevice.FindNode("EventNotification").Entries()
availableEntries = []
for entry in allEntries:
  if (entry.AccessStatus() != ids_peak.NodeAccessStatus_NotAvailable
          and entry.AccessStatus() != ids_peak.NodeAccessStatus_NotImplemented):
      availableEntries.append(entry.SymbolicValue())
 
# Set EventNotification to "On" (str)
nodeMapRemoteDevice.FindNode("EventNotification").SetCurrentEntry("On")