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.

Returns the current status of the optic controller.

Values description

•NotConnected: The optic controller is physically not connected.

•NotInitialized: The optic controller is not initialized.

•NotSupported: The optic controller is physically connected but not supported.

•Busy: The optic controller executes a feature access/command.

•Ready (default): The optic controller is ready to use.

•Error: The optic controller encountered an error.

Code example

C++

// Before accessing OpticControllerStatus, make sure OpticControllerSelector is set correctly
// Set OpticControllerSelector to "OpticController0"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("OpticControllerSelector")->SetCurrentEntry("OpticController0");
// Determine the current entry of OpticControllerStatus
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("OpticControllerStatus")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of OpticControllerStatus
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("OpticControllerStatus")->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);
  }
}
 

C#

// Before accessing OpticControllerStatus, make sure OpticControllerSelector is set correctly
// Set OpticControllerSelector to "OpticController0"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("OpticControllerSelector").SetCurrentEntry("OpticController0");
// Determine the current entry of OpticControllerStatus
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("OpticControllerStatus").CurrentEntry().SymbolicValue();
// Get a list of all available entries of OpticControllerStatus
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("OpticControllerStatus").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());
  }
}
 

Python

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