CameraList Class Reference

Used to hold a list of camera objects. More...

#include <CameraList.h>

Inheritance diagram for CameraList:

Public Member Functions
	CameraList (void)
	Default constructor.
virtual	~CameraList (void)
	Virtual destructor.
	CameraList (const CameraList &iface)
	Copy constructor.
CameraList &	operator= (const CameraList &iface)
	Assignment operator.
CameraPtr	operator[] (unsigned int index)
	Array subscription operators.
unsigned int	GetSize () const
	Returns the size of the camera list.
CameraPtr	GetByIndex (unsigned int index) const
	Returns a pointer to a camera object at the "index".
CameraPtr	GetBySerial (std::string serialNumber) const
	Returns a pointer to a camera object with the specified serial number.
CameraPtr	GetByDeviceID (std::string deviceID) const
	Returns a pointer to a camera object with the specified device identifier.
void	Clear ()
	Clears the list of cameras and destroys their corresponding reference counted objects.
void	Add (CameraPtr camera)
	Adds a copy of an camera object.
void	Remove (CameraPtr camera)
	Removes all occurences of an camera that is pointed to by the input camera pointer and destroys its corresponding reference counted object.
void	RemoveByIndex (unsigned int index)
	Removes a camera at "index" and destroys its corresponding reference counted object.
void	RemoveBySerial (std::string serialNumber)
	Removes a camera using its serial number and destroys its corresponding reference counted object.
void	RemoveByDeviceID (std::string deviceID)
	Removes a camera using its unique device identifier and destroys its corresponding reference counted object.
void	Append (const CameraList &list)
	Appends a copy of the camera list.
Public Member Functions inherited from ICameraList
virtual	~ICameraList ()
virtual CameraPtr	operator[] (unsigned int index)=0
virtual unsigned int	GetSize () const =0
virtual CameraPtr	GetByIndex (unsigned int index) const =0
virtual CameraPtr	GetBySerial (std::string serialNumber) const =0
virtual CameraPtr	GetByDeviceID (std::string deviceID) const =0
virtual void	Clear ()=0
virtual void	Add (CameraPtr camera)=0
virtual void	Remove (CameraPtr camera)=0
virtual void	RemoveBySerial (std::string serialNumber)=0
virtual void	RemoveByIndex (unsigned int index)=0
virtual void	RemoveByDeviceID (std::string deviceID)=0
virtual void	Append (const CameraList &list)=0

Additional Inherited Members
Protected Member Functions inherited from ICameraList
	ICameraList ()
	ICameraList (const ICameraList &)
ICameraList &	operator= (const ICameraList &)
Protected Attributes inherited from ICameraList
CameraListData *	m_pCameraListData

Detailed Description

Used to hold a list of camera objects.

Examples

Acquisition.cpp, AcquisitionMultipleCameraRecovery.cpp, AcquisitionMultipleCamerasWriteToFile.cpp, AcquisitionMultipleThread.cpp, AcquisitionUserBuffer.cpp, BufferHandling.cpp, Compression.cpp, CounterAndTimer.cpp, Exposure.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, NodeMapInfo.cpp, NodeMapInfo_QuickSpin.cpp, Polarization.cpp, SaveToVideo.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

Constructor & Destructor Documentation

CameraList() [1/2]

CameraList

(

void

)

Default constructor.

~CameraList()

virtual ~CameraList ( void  )

virtual

Virtual destructor.

CameraList() [2/2]

CameraList

(

const CameraList &

iface

)

Copy constructor.

Member Function Documentation

Add()

void Add ( CameraPtr  camera )

virtual

Adds a copy of an camera object.

Parameters

camera

A camera object to be added to this list.

Implements ICameraList.

Append()

void Append ( const CameraList &  list )

virtual

Appends a copy of the camera list.

Parameters

list	Another CameraList object, whose elements are added to this list.

Implements ICameraList.

Clear()

void Clear ( )

virtual

Clears the list of cameras and destroys their corresponding reference counted objects.

This is necessary in order to clean up the parent interface. 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

System:ReleaseInstance()

Implements ICameraList.

Examples

Acquisition.cpp, AcquisitionMultipleCamerasWriteToFile.cpp, AcquisitionMultipleThread.cpp, AcquisitionUserBuffer.cpp, BufferHandling.cpp, Compression.cpp, CounterAndTimer.cpp, Exposure.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, NodeMapInfo.cpp, NodeMapInfo_QuickSpin.cpp, Polarization.cpp, SaveToVideo.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

GetByDeviceID()

CameraPtr GetByDeviceID ( std::string  deviceID ) const

virtual

Returns a pointer to a camera object with the specified device identifier.

This function will return a NULL CameraPtr if no matching device identifier is found.

Parameters

deviceID

The unique device identifier of the camera object to retrieve

Returns

A pointer to a camera object.

Implements ICameraList.

GetByIndex()

CameraPtr GetByIndex ( unsigned int  index ) const

virtual

Returns a pointer to a camera object at the "index".

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

Parameters

index

The index at which to retrieve the camera object

Returns

A pointer to a camera object.

Implements ICameraList.

Examples

Acquisition.cpp, AcquisitionMultipleCamerasWriteToFile.cpp, AcquisitionMultipleThread.cpp, AcquisitionUserBuffer.cpp, BufferHandling.cpp, Compression.cpp, CounterAndTimer.cpp, Exposure.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, NodeMapInfo.cpp, NodeMapInfo_QuickSpin.cpp, Polarization.cpp, SaveToVideo.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

GetBySerial()

CameraPtr GetBySerial ( std::string  serialNumber ) const

virtual

Returns a pointer to a camera object with the specified serial number.

This function will return a NULL CameraPtr if no matching camera serial is found.

Parameters

serialNumber

The serial number of the camera object to retrieve

Returns

A pointer to a camera object.

Implements ICameraList.

GetSize()

unsigned int GetSize ( ) const

virtual

Returns the size of the camera list.

The size is the number of Camera objects stored in the list.

Returns

An integer that represents the list size.

Implements ICameraList.

Examples

Acquisition.cpp, AcquisitionMultipleCamerasWriteToFile.cpp, AcquisitionMultipleThread.cpp, AcquisitionUserBuffer.cpp, BufferHandling.cpp, Compression.cpp, CounterAndTimer.cpp, Exposure.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, NodeMapInfo.cpp, NodeMapInfo_QuickSpin.cpp, Polarization.cpp, SaveToVideo.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

operator=()

CameraList & operator=

(

const CameraList &

iface

)

Assignment operator.

operator[]()

CameraPtr operator[] ( unsigned int  index )

virtual

Array subscription operators.

Implements ICameraList.

Remove()

void Remove ( CameraPtr  camera )

virtual

Removes all occurences of an camera that is pointed to by the input camera pointer and destroys its corresponding reference counted object.

This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLEerror if no matching camera is found.

Parameters

camera

Pointer to the camera that is to be removed

Implements ICameraList.

RemoveByDeviceID()

void RemoveByDeviceID ( std::string  deviceID )

virtual

Removes a camera using its unique device identifier and destroys its corresponding reference counted object.

This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLE error if no matching device identifier is found.

Parameters

deviceID

The unique device identifier of the camera object to retrieve

Implements ICameraList.

RemoveByIndex()

void RemoveByIndex ( unsigned int  index )

virtual

Removes a camera at "index" and destroys its corresponding reference counted object.

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

Parameters

index

The index at which to remove the Camera object

Implements ICameraList.

RemoveBySerial()

void RemoveBySerial ( std::string  serialNumber )

virtual

Removes a camera using its serial number and destroys its corresponding reference counted object.

This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLE error if no matching camera serial is found.

Parameters

serialNumber

The serial number of the Camera object to remove

Implements ICameraList.

---

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

• include/CameraList.h