IDS peak 2.20.0 / uEye+ firmware 3.80

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

Returns the current status of the focus.

Values description

•NotConnected: The focus controller is physically not connected.

•NotInitialized: The focus controller is not initialized.

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

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

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

•Error: The focus controller encountered an error.

•Waiting: The focus controller is waiting for scene to stabilize.

Code example

C++

// Before accessing FocusStatus, make sure OpticControllerSelector is set correctly
// Set OpticControllerSelector to "OpticController0"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("OpticControllerSelector")->SetCurrentEntry("OpticController0");
// Determine the current entry of FocusStatus
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("FocusStatus")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of FocusStatus
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("FocusStatus")->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 FocusStatus, make sure OpticControllerSelector is set correctly
// Set OpticControllerSelector to "OpticController0"
nodeMapRemoteDevice.FindNode<IDSImaging.Peak.API.Core.Nodes.EnumerationNode>("OpticControllerSelector").SetCurrentEntry("OpticController0");
// Determine the current entry of FocusStatus
string value = nodeMapRemoteDevice.FindNode<IDSImaging.Peak.API.Core.Nodes.EnumerationNode>("FocusStatus").CurrentEntry().SymbolicValue();
// Get a list of all available entries of FocusStatus
allEntries = nodeMapRemoteDevice.FindNode<IDSImaging.Peak.API.Core.Nodes.EnumerationNode>("FocusStatus").Entries();
List<string> availableEntries = new List<string>();
for(int i = 0; i < allEntries.Count(); ++i)
{
  if ((allEntries[i].AccessStatus() != IDSImaging.Peak.API.Core.Nodes.NodeAccessStatus.NotAvailable)
          && (allEntries[i].AccessStatus() != IDSImaging.Peak.API.Core.Nodes.NodeAccessStatus.NotImplemented))
  {
      availableEntries.Add(allEntries[i].SymbolicValue());
  }
}
 

Python

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