The system object is used to retrieve the list of interfaces and cameras available. More...

#include <System.h>

Inheritance diagram for System:

Public Member Functions
virtual	~System ()
	Default destructor.

virtual void	ReleaseInstance ()
	This call releases the referenced instance of the System Singleton.

virtual InterfaceList	GetInterfaces (bool updateInterface=true)
	Returns a list of interfaces available on the system.

virtual void	UpdateInterfaceList ()
	Updates the list of interfaces on the system.

virtual CameraList	GetCameras (bool updateInterfaces=true, bool updateCameras=true)
	Returns a list of cameras that are available on the system.

virtual bool	UpdateCameras (bool updateInterfaces=true)
	Updates the list of cameras on the system.

void	RegisterEventHandler (EventHandler &evtHandlerToRegister, bool updateInterface=false)
	Registers an event handler for the system.

void	UnregisterEventHandler (EventHandler &evtHandlerToUnregister)
	Unregisters an event handler for the system.

virtual void	RegisterLoggingEventHandler (LoggingEventHandler &handler)
	Registers a logging event.

virtual void	UnregisterAllLoggingEventHandlers ()
	Unregisters all previously registered logging events.

virtual void	UnregisterLoggingEventHandler (LoggingEventHandler &handler)
	Unregisters a logging event.

virtual void	SetLoggingEventPriorityLevel (SpinnakerLogLevel level)
	Sets a threshold priority level for logging event.

virtual SpinnakerLogLevel	GetLoggingEventPriorityLevel ()
	Retrieves the current logging event priority level.

virtual bool	IsInUse ()
	Checks if the system is in use by any interface or camera objects.

virtual void	SendActionCommand (unsigned int deviceKey, unsigned int groupKey, unsigned int groupMask, unsigned long long actionTime=0, bool requestAck=false, unsigned int *pResultSize=0, ActionCommandResult results[]=NULL)
	Broadcast an Action Command to all devices on system.

virtual const LibraryVersion	GetLibraryVersion ()
	Get current library version of Spinnaker.

virtual GenApi::INodeMap &	GetTLNodeMap () const
	Gets a reference to the system node map.

Public Member Functions inherited from ISystem
virtual	~ISystem ()

virtual void	ReleaseInstance ()=0

virtual InterfaceList	GetInterfaces (bool updateInterface=true)=0

virtual void	UpdateInterfaceList ()=0

virtual CameraList	GetCameras (bool updateInterfaces=true, bool updateCameras=true)=0

virtual bool	UpdateCameras (bool updateInterfaces=true)=0

virtual void	RegisterEventHandler (EventHandler &evtHandlerToRegister, bool updateInterface=false)=0

virtual void	UnregisterEventHandler (EventHandler &evtHandlerToUnregister)=0

virtual void	RegisterLoggingEventHandler (LoggingEventHandler &handler)=0

virtual void	UnregisterAllLoggingEventHandlers ()=0

virtual void	UnregisterLoggingEventHandler (LoggingEventHandler &handler)=0

virtual void	SetLoggingEventPriorityLevel (SpinnakerLogLevel level)=0

virtual SpinnakerLogLevel	GetLoggingEventPriorityLevel ()=0

virtual bool	IsInUse ()=0

virtual void	SendActionCommand (unsigned int deviceKey, unsigned int groupKey, unsigned int groupMask, unsigned long long actionTime=0, bool requestAck=false, unsigned int *pResultSize=0, ActionCommandResult results[]=NULL)=0

virtual const LibraryVersion	GetLibraryVersion ()=0

virtual GenApi::INodeMap &	GetTLNodeMap () const =0

Static Public Member Functions
static SystemPtr	GetInstance ()
	Returns a pointer to a Singleton instance of a System object.

Protected Member Functions
	System ()
	Default constructor.

Protected Member Functions inherited from ISystem
	ISystem ()

	ISystem (const ISystem &)

ISystem &	operator= (const ISystem &)

Additional Inherited Members
Public Attributes inherited from ISystem
TransportLayerSystem	TLSystem

Detailed Description

The system object is used to retrieve the list of interfaces and cameras available.

Constructor & Destructor Documentation

◆ ~System()

virtual ~System ( )

virtual

Default destructor.

◆ System()

System ( )

protected

Default constructor.

Member Function Documentation

◆ GetCameras()

virtual CameraList GetCameras	(	bool	updateInterfaces = `true`,
		bool	updateCameras = `true`
	)

virtual

Returns a list of cameras that are available on the system.

This call returns both GigE Vision and Usb3 Vision cameras from all interfaces. The camera list object will reference count the cameras it returns. It is important that the camera list is destroyed or is cleared before calling system->ReleaseInstance() or else the call to system->ReleaseInstance() will result in an error message thrown that a reference to the camera is still held.

See also: ReleaseInstance(); CameraList::Clear()

Parameters

updateInterfaces	Determines whether or not updateInterfaceList() is called before getting cameras from available interfaces on the system
updateCameras	Determines whether or not UpdateCameras() is called before getting cameras from available interfaces on the system

Returns: An CameraList object that contains a list of all cameras.

Implements ISystem.

◆ GetInstance()

static SystemPtr GetInstance ( )

static

Returns a pointer to a Singleton instance of a System object.

The System object may be used to get cameras or interfaces. When an application is done using the cameras it is necessary to free the System by calling ReleaseInstance().

See also: ReleaseInstance()

Returns: A const ref to a system object.

◆ GetInterfaces()

virtual InterfaceList GetInterfaces ( bool updateInterface = true )

virtual

Returns a list of interfaces available on the system.

This call returns GigE and Usb2 and Usb3 interfaces. Note that on MacOS only active GigE interfaces will be stored in the returned InterfaceList.

See also: UpdateInterfaceList()

Parameters

updateInterface Determines whether or not UpdateInterfaceList() is called before getting available interfaces

Returns: An InterfaceList object that contains a list of all interfaces.

Implements ISystem.

◆ GetLibraryVersion()

virtual const LibraryVersion GetLibraryVersion ( )

virtual

Get current library version of Spinnaker.

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

Implements ISystem.

◆ GetLoggingEventPriorityLevel()

virtual SpinnakerLogLevel GetLoggingEventPriorityLevel ( )

virtual

Retrieves the 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.

See also: SpinnakerLogLevel

Returns: Level The threshold level

Implements ISystem.

◆ GetTLNodeMap()

virtual GenApi::INodeMap & GetTLNodeMap ( ) const

virtual

Gets a reference to the system node map.

The system must be initialized by a call to System::GetInstance() first before a node map reference can be successfully acquired.

Returns: A reference to the System INodeMap.

Implements ISystem.

◆ IsInUse()

virtual bool IsInUse ( )

virtual

Checks if the system is in use by any interface or camera objects.

Returns: Returns true if the system is in use and false otherwise.

Implements ISystem.

◆ RegisterEventHandler()

void RegisterEventHandler	(	EventHandler &	evtHandlerToRegister,
		bool	updateInterface = `false`
	)

virtual

Registers an event handler for the system.

See also: SystemEventHandler

Parameters

evtHandlerToRegister	The event handler to register for the system
updateInterface	Determines whether or not UpdateInterfaceList() is called before registering event for available interfaces on the system

Implements ISystem.

◆ RegisterLoggingEventHandler()

virtual void RegisterLoggingEventHandler ( LoggingEventHandler & handler )

virtual

Registers a logging event.

Parameters

handler The logging event handler to register

Implements ISystem.

◆ ReleaseInstance()

virtual void ReleaseInstance ( )

virtual

This call releases the referenced instance of the System Singleton.

After successfully releasing the System instance, the pointer returned by GetInstance() will be invalid. Once the final System instance is released, all remaining Spinnaker resources will be released. If the final System instance is released while an interface or camera reference is still held, this function will throw an error of type SPINNAKER_ERR_RESOURCE_IN_USE.

See also: Error; GetInstance()

Implements ISystem.

◆ SendActionCommand()

virtual void SendActionCommand	(	unsigned int	deviceKey,
		unsigned int	groupKey,
		unsigned int	groupMask,
		unsigned long long	actionTime = `0`,
		bool	requestAck = `false`,
		unsigned int *	pResultSize = `0`,
		ActionCommandResult	results[] = `NULL`
	)

virtual

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.
pResultSize	(Optional) The number of results in the results array. The value passed should be equal to the expected number of devices that acknowledge the command. Returns the number of received results. If this parameter is 0 or NULL, the function will return as soon as the command has been broadcasted.
results	(Optional) An Array with *pResultSize elements to hold the action command result status. The buffer is filled starting from index 0. If received results are less than expected number of devices that acknowledge the command, remaining results are not changed. If received results are more than expected number of devices that acknowledge the command, extra results are ignored and not appended to array. This parameter is ignored if pResultSize is 0. Thus this parameter can be NULL if pResultSize is 0 or NULL.

Implements ISystem.

◆ SetLoggingEventPriorityLevel()

virtual void SetLoggingEventPriorityLevel ( SpinnakerLogLevel level )

virtual

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.

See also: SpinnakerLogLevel

Parameters

level The threshold level

Implements ISystem.

◆ UnregisterAllLoggingEventHandlers()

virtual void UnregisterAllLoggingEventHandlers ( )

virtual

Unregisters all previously registered logging events.

Implements ISystem.

◆ UnregisterEventHandler()

void UnregisterEventHandler ( EventHandler & evtHandlerToUnregister )

virtual

Unregisters an event handler for the system.

See also: SystemEventHandler

Parameters

evtHandlerToUnregister The event handler to unregister from the system

Implements ISystem.

◆ UnregisterLoggingEventHandler()

virtual void UnregisterLoggingEventHandler ( LoggingEventHandler & handler )

virtual

Unregisters a logging event.

Parameters

handler The logging event handler to unregister

Implements ISystem.

◆ UpdateCameras()

virtual bool UpdateCameras ( bool updateInterfaces = true )

virtual

Updates the list of cameras on the system.

Note that System::GetCameras() internally calls UpdateCameras() for each interface it enumerates. If the list changed between this call and the last time UpdateCameras was called then the return value will be true, otherwise it is false.

See also: GetCameras()

Parameters

updateInterfaces Determines whether or not UpdateInterfaceList() is called before updating cameras for available interfaces on the system

Returns: True if cameras changed on interface and false otherwise.

Implements ISystem.

◆ UpdateInterfaceList()

virtual void UpdateInterfaceList ( )

virtual

Updates the list of interfaces on the system.

If desired, local copies of InterfaceList should be updated by calling GetInterfaces.

See also: GetInterfaces()

Implements ISystem.

The documentation for this class was generated from the following file:

include/System.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~System()

◆ System()

Member Function Documentation

◆ GetCameras()

◆ GetInstance()

◆ GetInterfaces()

◆ GetLibraryVersion()

◆ GetLoggingEventPriorityLevel()

◆ GetTLNodeMap()

◆ IsInUse()

◆ RegisterEventHandler()

◆ RegisterLoggingEventHandler()

◆ ReleaseInstance()

◆ SendActionCommand()

◆ SetLoggingEventPriorityLevel()

◆ UnregisterAllLoggingEventHandlers()

◆ UnregisterEventHandler()

◆ UnregisterLoggingEventHandler()

◆ UpdateCameras()

◆ UpdateInterfaceList()