Spinnaker C++
2.6.0.0
Public Member Functions | List of all members
CameraList Class Reference

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

Inheritance diagram for CameraList:
ICameraList

Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from ICameraList
 ICameraList ()
 
 ICameraList (const ICameraList &)
 
ICameraListoperator= (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, AcquisitionMultipleThread.cpp, ActionCommand.cpp, BufferHandling.cpp, ChunkData.cpp, Compression.cpp, CounterAndTimer.cpp, DeviceEvents.cpp, Enumeration.cpp, Enumeration_QuickSpin.cpp, EnumerationEvents.cpp, ExceptionHandling.cpp, Exposure.cpp, Exposure_QuickSpin.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageEvents.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, Logging.cpp, LogicBlock.cpp, LookupTable.cpp, NodeMapCallback.cpp, NodeMapInfo.cpp, Polarization.cpp, SaveToAvi.cpp, Sequencer.cpp, SerialRxTx.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

Constructor & Destructor Documentation

CameraList ( void  )

Default constructor.

virtual ~CameraList ( void  )
virtual

Virtual destructor.

CameraList ( const CameraList iface)

Copy constructor.

Member Function Documentation

void Append ( const CameraList list)
virtual

Appends a copy of the camera list.

Parameters
listAnother CameraList object, whose elements are added to this list.

Implements ICameraList.

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, AcquisitionMultipleCameraRecovery.cpp, AcquisitionMultipleThread.cpp, ActionCommand.cpp, BufferHandling.cpp, ChunkData.cpp, Compression.cpp, CounterAndTimer.cpp, DeviceEvents.cpp, Enumeration.cpp, Enumeration_QuickSpin.cpp, EnumerationEvents.cpp, Exposure.cpp, Exposure_QuickSpin.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageEvents.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, Logging.cpp, LogicBlock.cpp, LookupTable.cpp, NodeMapCallback.cpp, NodeMapInfo.cpp, Polarization.cpp, SaveToAvi.cpp, Sequencer.cpp, SerialRxTx.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.
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
deviceIDThe unique device identifier of the camera object to retrieve
Returns
A pointer to a camera object.

Implements ICameraList.

CameraPtr GetByIndex ( unsigned int  index) const
virtual
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
serialNumberThe serial number of the camera object to retrieve
Returns
A pointer to a camera object.

Implements ICameraList.

Examples:
AcquisitionMultipleCameraRecovery.cpp.
unsigned int GetSize ( ) const
virtual
CameraList& operator= ( const CameraList iface)

Assignment operator.

CameraPtr operator[] ( unsigned int  index)
virtual

Array subscription operators.

Implements ICameraList.

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
deviceIDThe unique device identifier of the camera object to retrieve

Implements ICameraList.

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
indexThe index at which to remove the Camera object

Implements ICameraList.

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
serialNumberThe serial number of the Camera object to remove

Implements ICameraList.


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference