Class SpinnakerNET::ManagedSystem¶

ClassList > SpinnakerNET > ManagedSystem

#include <ManagedSystem.h>

Inherits the following classes: SpinnakerNET::IManagedSystem

Public Attributes inherited from SpinnakerNET::IManagedSystem¶

Type	Name
property ManagedTransportLayerSystem	TLSystem = `/* multi line expression */`

Public Functions¶

Type	Name
virtual void	DisposeInterfaces (ManagedInterfaceList^ interfaceList)
virtual ManagedCameraList	GetCameras ()
virtual ManagedCameraList	GetCameras (bool updateInterfaces, bool updateCameras)
virtual ManagedInterfaceList	GetInterfaces ()
virtual ManagedInterfaceList	GetInterfaces (bool updateInterface)
virtual const LibraryVersion	GetLibraryVersion ()
virtual SpinnakerNET::ManagedLoggingLevel	GetLoggingEventPriorityLevel ()
virtual Spinnaker::SystemPtr *	GetNativeSystemPtr ()
virtual SpinnakerNET::GenApi::INodeMap	GetTLNodeMap ()
virtual bool	IsInUse (void)
	ManagedSystem ()
virtual void	RegisterEventHandler (ManagedEventHandler^ event)
virtual void	RegisterLoggingEventHandler (SpinnakerNET::ManagedLoggingEventHandler^ loggingCallback)
virtual List< ActionCommandResult^>	SendActionCommand (unsigned int deviceKey, unsigned int groupKey, unsigned int groupMask, Nullable< unsigned long long > actionTime, bool requestAck)
virtual void	SetLoggingEventPriorityLevel (SpinnakerNET::ManagedLoggingLevel level)
virtual void	UnregisterEventHandler (ManagedEventHandler^ event)
virtual void	UnregisterLoggingEventHandler (SpinnakerNET::ManagedLoggingEventHandler^ loggingCallback)
virtual void	UnregisterLoggingEventHandler ()
virtual bool	UpdateCameras ()
virtual bool	UpdateCameras (bool updateInterfaces)
virtual void	UpdateInterfaceList ()
virtual bool	UpdateProducers ()
virtual bool	UpdateProducers (::System::String ^ ctiPath)
	~ManagedSystem ()

Public Functions inherited from SpinnakerNET::IManagedSystem¶

See SpinnakerNET::IManagedSystem

Type	Name
void	DisposeInterfaces (ManagedInterfaceList^ interfaceList)
ManagedCameraList	GetCameras ()
ManagedCameraList	GetCameras (bool updateInterfaces, bool updateCameras)
ManagedInterfaceList	GetInterfaces ()
ManagedInterfaceList	GetInterfaces (bool updateInterface)
const LibraryVersion	GetLibraryVersion ()
SpinnakerNET::ManagedLoggingLevel	GetLoggingEventPriorityLevel ()
Spinnaker::SystemPtr *	GetNativeSystemPtr ()
SpinnakerNET::GenApi::INodeMap	GetTLNodeMap ()
bool	IsInUse (void)
void	RegisterEventHandler (ManagedEventHandler^ event)
void	RegisterLoggingEventHandler (ManagedLoggingEventHandler^ loggingCallback)
List< ActionCommandResult^>	SendActionCommand (unsigned int deviceKey, unsigned int groupKey, unsigned int groupMask, Nullable< unsigned long long > actionTime, bool requestAck)
void	SetLoggingEventPriorityLevel (ManagedLoggingLevel level)
void	UnregisterEventHandler (ManagedEventHandler^ event)
void	UnregisterLoggingEventHandler (ManagedLoggingEventHandler^ loggingCallback)
void	UnregisterLoggingEventHandler (void)
bool	UpdateCameras ()
bool	UpdateCameras (bool updateInterfaces)
void	UpdateInterfaceList ()
bool	UpdateProducers ()
bool	UpdateProducers (::System::String ^ ctiPath)

Public Functions Documentation¶

function DisposeInterfaces¶

virtual void SpinnakerNET::ManagedSystem::DisposeInterfaces (
    ManagedInterfaceList ^ interfaceList
)

Disposes of a list of interfaces. This call disposes of GigE, Usb2 and Usb3 interfaces. It will call the Dispose() method on each interface in the list. This helper function will force the Garbage collection of interface objects.

Parameters:

interfaceList An interface list that needs to be disposed off.

Returns:

List of ManagedInterface objects.

Implements SpinnakerNET::IManagedSystem::DisposeInterfaces

function GetCameras [1/2]¶

virtual ManagedCameraList SpinnakerNET::ManagedSystem::GetCameras ()

Returns a list of cameras available on the system. This call returns both GigE Vision and Usb3 Vision cameras from all interfaces after update InterfaceList and calling UpdateCameras().

Returns:

A list of ManagedCamera objects.

Implements SpinnakerNET::IManagedSystem::GetCameras

function GetCameras [2/2]¶

virtual ManagedCameraList SpinnakerNET::ManagedSystem::GetCameras (
    bool updateInterfaces,
    bool updateCameras
)

Returns a list of cameras available on the system. This call returns both GigE Vision and Usb3 Vision cameras from all interfaces.

Parameters:

updateInterface Determines whether or not InterfaceList is updated before getting available interfaces
updateCameras Determines whether or not UpdateCameras() is called before getting cameras from available interfaces on the system

Returns:

A list of ManagedCamera objects.

Implements SpinnakerNET::IManagedSystem::GetCameras

function GetInterfaces [1/2]¶

virtual ManagedInterfaceList SpinnakerNET::ManagedSystem::GetInterfaces ()

Returns a list of interfaces available on the system. This call returns both GigE and Usb2 and Usb3 interfaces. InterfaceList is updated before getting available interfaces.

Returns:

List of ManagedInterface objects.

Implements SpinnakerNET::IManagedSystem::GetInterfaces

function GetInterfaces [2/2]¶

virtual ManagedInterfaceList SpinnakerNET::ManagedSystem::GetInterfaces (
    bool updateInterface
)

Returns a list of interfaces available on the system. This call returns both GigE and Usb2 and Usb3 interfaces.

Parameters:

updateInterface Determines whether or not InterfaceList is updated before getting available interfaces

Returns:

List of ManagedInterface objects.

Implements SpinnakerNET::IManagedSystem::GetInterfaces

function GetLibraryVersion¶

virtual const  LibraryVersion SpinnakerNET::ManagedSystem::GetLibraryVersion ()

Get current library version of Spinnaker.

Returns:

A struct containing the current version of Spinnaker (major, minor, type, build).

Implements SpinnakerNET::IManagedSystem::GetLibraryVersion

function GetLoggingEventPriorityLevel¶

virtual SpinnakerNET::ManagedLoggingLevel SpinnakerNET::ManagedSystem::GetLoggingEventPriorityLevel ()

Retrieve current logging event priority level.

Spinnaker uses multiple levels of logging: * Fatal - failures that are non-recoverable without user intervention. * Error - failures that may or may not be recoverable without user intervention (use case dependent). * Warning - failures that are recoverable without user intervention. * Notice - information about events such as camera arrival and removal, initialization and deinitialization, starting and stopping image acquisition, and feature modification. * Info - information about recurring events that are generated regularly such as information on individual images. * Debug - information that can be used to troubleshoot the system.

Implements SpinnakerNET::IManagedSystem::GetLoggingEventPriorityLevel

function GetNativeSystemPtr¶

virtual Spinnaker::SystemPtr * SpinnakerNET::ManagedSystem::GetNativeSystemPtr ()

Implements SpinnakerNET::IManagedSystem::GetNativeSystemPtr

function GetTLNodeMap¶

virtual SpinnakerNET::GenApi::INodeMap SpinnakerNET::ManagedSystem::GetTLNodeMap ()

Implements SpinnakerNET::IManagedSystem::GetTLNodeMap

function IsInUse¶

virtual bool SpinnakerNET::ManagedSystem::IsInUse (
    void
)

Retrieves a boolean indicating whether or not the system is in use.

Implements SpinnakerNET::IManagedSystem::IsInUse

function ManagedSystem¶

SpinnakerNET::ManagedSystem::ManagedSystem ()

function RegisterEventHandler¶

virtual void SpinnakerNET::ManagedSystem::RegisterEventHandler (
    ManagedEventHandler^ event
)

Implements SpinnakerNET::IManagedSystem::RegisterEventHandler

function RegisterLoggingEventHandler¶

virtual void SpinnakerNET::ManagedSystem::RegisterLoggingEventHandler (
    SpinnakerNET::ManagedLoggingEventHandler^ loggingCallback
)

Register a logging event handler with ManagedSystem

function SendActionCommand¶

virtual List< ActionCommandResult ^> SpinnakerNET::ManagedSystem::SendActionCommand (
    unsigned  int deviceKey,
    unsigned  int groupKey,
    unsigned  int groupMask,
    Nullable < unsigned  long  long > actionTime,
    bool requestAck
)

Broadcast an Action Command to all devices on system

Parameters:

deviceKey The Action Command's device key
groupKey The Action Command's group key
groupMask The Action Command's group mask
actionTime (Optional) Time when to assert a future action. Zero means immediate action.

Returns:

A list of ActionCommandResult received following Action Command. An empty list means no devices responded to Action Command

Implements SpinnakerNET::IManagedSystem::SendActionCommand

function SetLoggingEventPriorityLevel¶

virtual void SpinnakerNET::ManagedSystem::SetLoggingEventPriorityLevel (
    SpinnakerNET::ManagedLoggingLevel level
)

Sets a threshold priority level for logging event. Logging events below such level will not trigger callbacks.

Spinnaker uses multiple levels of logging: * Fatal - failures that are non-recoverable without user intervention. * Error - failures that may or may not be recoverable without user intervention (use case dependent). * Warning - failures that are recoverable without user intervention. * Notice - information about events such as camera arrival and removal, initialization and deinitialization, starting and stopping image acquisition, and feature modification. * Info - information about recurring events that are generated regularly such as information on individual images. * Debug - information that can be used to troubleshoot the system.

Implements SpinnakerNET::IManagedSystem::SetLoggingEventPriorityLevel

function UnregisterEventHandler¶

virtual void SpinnakerNET::ManagedSystem::UnregisterEventHandler (
    ManagedEventHandler^ event
)

Implements SpinnakerNET::IManagedSystem::UnregisterEventHandler

function UnregisterLoggingEventHandler [1/2]¶

virtual void SpinnakerNET::ManagedSystem::UnregisterLoggingEventHandler (
    SpinnakerNET::ManagedLoggingEventHandler^ loggingCallback
)

Unregister a logging event handler with ManagedSystem

function UnregisterLoggingEventHandler [2/2]¶

virtual void SpinnakerNET::ManagedSystem::UnregisterLoggingEventHandler ()

Unregister all logging event handlers with ManagedSystem

Implements SpinnakerNET::IManagedSystem::UnregisterLoggingEventHandler

function UpdateCameras [1/2]¶

virtual bool SpinnakerNET::ManagedSystem::UpdateCameras ()

Updates the list of cameras on the system. InterfaceList is updated before getting available interfaces

Returns:

True if cameras changed on interface and false otherwise.

Implements SpinnakerNET::IManagedSystem::UpdateCameras

function UpdateCameras [2/2]¶

virtual bool SpinnakerNET::ManagedSystem::UpdateCameras (
    bool updateInterfaces
)

Updates the list of cameras on the system.

Parameters:

updateInterface Determines whether or not InterfaceList is updated before updating cameras for available interfaces on the system

Returns:

True if cameras changed on interface and false otherwise.

Implements SpinnakerNET::IManagedSystem::UpdateCameras

function UpdateInterfaceList¶

virtual void SpinnakerNET::ManagedSystem::UpdateInterfaceList ()

Updates the list of interfaces on the system. If desired, local copies of InterfaceList should be updated by calling GetInterfaces.

See also: GetInterfaces()

Implements SpinnakerNET::IManagedSystem::UpdateInterfaceList

function UpdateProducers [1/2]¶

virtual bool SpinnakerNET::ManagedSystem::UpdateProducers ()

Updates the list of GenICam producers discoverable by the system given a producer library path. Only producers with the "cti" extension representing "Common Transport Interface" will be loaded. Spinnaker GenTL producer will be loaded by default.

Please see section "Working with GenICam GenTL Devices" in the Spinnaker C++ API Documentation for more information on GenTL producers.

Note: Only the Teledyne CoaXPress producer is supported at this time.

Producer loading will behave as follows: * System loads all third party CTIs found in GENICAM_GENTL path when an empty path is provided * System loads a specific producer when the full path to producer is provided * System loads a specific producer based on GENICAM_GENTL paths when only the CTI file name is provided

Returns:

True if new producers have loaded and false otherwise.

Implements SpinnakerNET::IManagedSystem::UpdateProducers

function UpdateProducers [2/2]¶

virtual bool SpinnakerNET::ManagedSystem::UpdateProducers (
    ::System::String ^ ctiPath
)

Updates the list of GenICam producers discoverable by the system given a producer library path. Only producers with the "cti" extension representing "Common Transport Interface" will be loaded. Spinnaker GenTL producer will be loaded by default.

Please see section "Working with GenICam GenTL Devices" in the Spinnaker C++ API Documentation for more information on GenTL producers.

Note: Only the Teledyne CoaXPress producer is supported at this time.

Producer loading will behave as follows: * System loads all third party CTIs found in GENICAM_GENTL path when an empty path is provided * System loads a specific producer when the full path to producer is provided * System loads a specific producer based on GENICAM_GENTL paths when only the CTI file name is provided

Parameters:

ctiPath The CTI file name or full path including the CTI file name to load in the system

Returns:

True if new producers have loaded and false otherwise.

Implements SpinnakerNET::IManagedSystem::UpdateProducers

function ~ManagedSystem¶

SpinnakerNET::ManagedSystem::~ManagedSystem ()

The documentation for this class was generated from the following file C:/workspace/src/SpinnakerNET/ManagedSystem.h