Class Spinnaker::CameraList¶

ClassList > Spinnaker > CameraList

Used to hold a list of camera objects.

#include <CameraList.h>

Inherits the following classes: Spinnaker::ICameraList

Public Functions¶

Type	Name
virtual void	Add (CameraPtr camera)
virtual void	Append (const CameraList & list)
	CameraList (void)
	CameraList (const CameraList & iface)
virtual void	Clear ()
virtual CameraPtr	GetByDeviceID (std::string deviceID) const
virtual CameraPtr	GetByIndex (unsigned int index) const
virtual CameraPtr	GetBySerial (std::string serialNumber) const
virtual unsigned int	GetSize () const
virtual void	Remove (CameraPtr camera)
virtual void	RemoveByDeviceID (std::string deviceID)
virtual void	RemoveByIndex (unsigned int index)
virtual void	RemoveBySerial (std::string serialNumber)
CameraList &	operator= (const CameraList & iface)
virtual CameraPtr	operator[] (unsigned int index)
virtual	~CameraList (void)

Public Functions inherited from Spinnaker::ICameraList¶

See Spinnaker::ICameraList

Type	Name
virtual void	Add (CameraPtr camera) = 0
virtual void	Append (const CameraList & list) = 0
virtual void	Clear () = 0
virtual CameraPtr	GetByDeviceID (std::string deviceID) const = 0
virtual CameraPtr	GetByIndex (unsigned int index) const = 0
virtual CameraPtr	GetBySerial (std::string serialNumber) const = 0
virtual unsigned int	GetSize () const = 0
virtual void	Remove (CameraPtr camera) = 0
virtual void	RemoveByDeviceID (std::string deviceID) = 0
virtual void	RemoveByIndex (unsigned int index) = 0
virtual void	RemoveBySerial (std::string serialNumber) = 0
virtual CameraPtr	operator[] (unsigned int index) = 0
virtual	~ICameraList ()

Protected Attributes inherited from Spinnaker::ICameraList¶

See Spinnaker::ICameraList

Type	Name
CameraListData *	m_pCameraListData

Protected Functions inherited from Spinnaker::ICameraList¶

See Spinnaker::ICameraList

Type	Name
	ICameraList ()
	ICameraList (const ICameraList &)
ICameraList &	operator= (const ICameraList &)

Public Functions Documentation¶

function Add¶

virtual void Spinnaker::CameraList::Add (
    CameraPtr camera
)

Adds a copy of an camera object.

Parameters:

camera A camera object to be added to this list.

Implements Spinnaker::ICameraList::Add

function Append¶

virtual void Spinnaker::CameraList::Append (
    const CameraList & list
)

Appends a copy of the camera list.

Parameters:

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

Implements Spinnaker::ICameraList::Append

function CameraList [1/2]¶

Spinnaker::CameraList::CameraList (
    void
)

Default constructor.

function CameraList [2/2]¶

Spinnaker::CameraList::CameraList (
    const CameraList & iface
)

Copy constructor

function Clear¶

virtual void Spinnaker::CameraList::Clear ()

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 Spinnaker::ICameraList::Clear

function GetByDeviceID¶

virtual CameraPtr Spinnaker::CameraList::GetByDeviceID (
    std::string deviceID
) const

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 Spinnaker::ICameraList::GetByDeviceID

function GetByIndex¶

virtual CameraPtr Spinnaker::CameraList::GetByIndex (
    unsigned int index
) const

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 Spinnaker::ICameraList::GetByIndex

function GetBySerial¶

virtual CameraPtr Spinnaker::CameraList::GetBySerial (
    std::string serialNumber
) const

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 Spinnaker::ICameraList::GetBySerial

function GetSize¶

virtual unsigned int Spinnaker::CameraList::GetSize () const

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 Spinnaker::ICameraList::GetSize

function Remove¶

virtual void Spinnaker::CameraList::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. 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 Spinnaker::ICameraList::Remove

function RemoveByDeviceID¶

virtual void Spinnaker::CameraList::RemoveByDeviceID (
    std::string deviceID
)

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 Spinnaker::ICameraList::RemoveByDeviceID

function RemoveByIndex¶

virtual void Spinnaker::CameraList::RemoveByIndex (
    unsigned int index
)

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 Spinnaker::ICameraList::RemoveByIndex

function RemoveBySerial¶

virtual void Spinnaker::CameraList::RemoveBySerial (
    std::string serialNumber
)

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 Spinnaker::ICameraList::RemoveBySerial

function operator=¶

CameraList & Spinnaker::CameraList::operator= (
    const CameraList & iface
)

Assignment operator.

function operator[]¶

virtual CameraPtr Spinnaker::CameraList::operator[] (
    unsigned int index
)

Array subscription operators.

Implements Spinnaker::ICameraList::operator[]

function ~CameraList¶

virtual Spinnaker::CameraList::~CameraList (
    void
)

Virtual destructor.

The documentation for this class was generated from the following file C:/workspace/include/CameraList.h