Class Spinnaker::ProducerList¶

ClassList > Spinnaker > ProducerList

A list of the available producers on the system.

#include <ProducerList.h>

Inherits the following classes: Spinnaker::IProducerList

Public Functions¶

Type	Name
virtual void	Add (ProducerPtr prod)
virtual void	Append (const ProducerList * list)
virtual void	Clear ()
virtual ProducerPtr	GetByIndex (unsigned int index) const
ProducerPtr	GetByProducerID (GenICam::gcstring producerID) const
virtual unsigned int	GetSize () const
	ProducerList (void)
	ProducerList (const ProducerList & prod)
virtual void	Remove (ProducerPtr prod)
ProducerList &	operator= (const ProducerList & prod)
virtual ProducerPtr	operator[] (unsigned int index)
virtual	~ProducerList (void)

Public Functions inherited from Spinnaker::IProducerList¶

See Spinnaker::IProducerList

Type	Name
virtual void	Add (ProducerPtr prod) = 0
virtual void	Append (const ProducerList * list) = 0
virtual void	Clear () = 0
virtual ProducerPtr	GetByIndex (unsigned int index) const = 0
virtual unsigned int	GetSize () const = 0
virtual void	Remove (ProducerPtr prod) = 0
virtual ProducerPtr	operator[] (unsigned int index) = 0
virtual	~IProducerList (void)

Protected Attributes inherited from Spinnaker::IProducerList¶

See Spinnaker::IProducerList

Type	Name
ProducerListData *	m_pProducerListData

Protected Functions inherited from Spinnaker::IProducerList¶

See Spinnaker::IProducerList

Type	Name
	IProducerList (void)
	IProducerList (const IProducerList &)
IProducerList &	operator= (const IProducerList &)

Public Functions Documentation¶

function Add¶

virtual void Spinnaker::ProducerList::Add (
    ProducerPtr prod
)

Adds a copy of an producer object.

Parameters:

prod An producer object to be added to this list.

Implements Spinnaker::IProducerList::Add

function Append¶

virtual void Spinnaker::ProducerList::Append (
    const ProducerList * list
)

Appends a copy of the producer list.

Parameters:

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

Implements Spinnaker::IProducerList::Append

function Clear¶

virtual void Spinnaker::ProducerList::Clear ()

Clears the list of producers and destroys their corresponding objects. It is important to first make sure there are no referenced cameras still in use before calling Clear(). If a camera on any of the producers is still in use this function will throw an exception.

Implements Spinnaker::IProducerList::Clear

function GetByIndex¶

virtual ProducerPtr Spinnaker::ProducerList::GetByIndex (
    unsigned int index
) const

Returns a pointer to an Producer object at the "index".

Parameters:

index The index at which to retrieve the Producer object

Returns:

A pointer to an Producer object.

Implements Spinnaker::IProducerList::GetByIndex

function GetByProducerID¶

ProducerPtr Spinnaker::ProducerList::GetByProducerID (
    GenICam::gcstring producerID
) const

Returns a pointer to a producer object with the specified producer identifier. This function will return a NULL ProducerPtr if no matching producer identifier is found.

Parameters:

producerID The unique producer identifier of the producer object to retrieve

Returns:

A pointer to an Producer object.

function GetSize¶

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

Returns the size of the producer list. The size is the number of Producer objects stored in the list.

Returns:

An integer that represents the list size.

Implements Spinnaker::IProducerList::GetSize

function ProducerList [1/2]¶

Spinnaker::ProducerList::ProducerList (
    void
)

function ProducerList [2/2]¶

Spinnaker::ProducerList::ProducerList (
    const ProducerList & prod
)

function Remove¶

virtual void Spinnaker::ProducerList::Remove (
    ProducerPtr prod
)

Removes all occurences of an producer that is pointed to by the input producer pointer and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLE error if no matching producer is found.

Parameters:

prod Pointer to the producer that is to be removed

Implements Spinnaker::IProducerList::Remove

function operator=¶

ProducerList & Spinnaker::ProducerList::operator= (
    const ProducerList & prod
)

Assignment operator.

function operator[]¶

virtual ProducerPtr Spinnaker::ProducerList::operator[] (
    unsigned int index
)

Array subscription operators

Implements Spinnaker::IProducerList::operator[]

function ~ProducerList¶

virtual Spinnaker::ProducerList::~ProducerList (
    void
)

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