ProducerList Class Reference

A list of the available producers on the system. More...

#include <ProducerList.h>

Inheritance diagram for ProducerList:

Public Member Functions
	ProducerList (void)
virtual	~ProducerList (void)
	ProducerList (const ProducerList &prod)
ProducerList &	operator= (const ProducerList &prod)
	Assignment operator.
ProducerPtr	operator[] (unsigned int index)
	Array subscription operators.
unsigned int	GetSize () const
	Returns the size of the producer list.
ProducerPtr	GetByIndex (unsigned int index) const
	Returns a pointer to an Producer object at the "index".
ProducerPtr	GetByProducerID (GenICam::gcstring producerID) const
	Returns a pointer to a producer object with the specified producer identifier.
void	Clear ()
	Clears the list of producers and destroys their corresponding objects.
void	Add (ProducerPtr prod)
	Adds a copy of an producer object.
void	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.
void	Append (const ProducerList *list)
	Appends a copy of the producer list.
Public Member Functions inherited from IProducerList
virtual	~IProducerList (void)
virtual ProducerPtr	operator[] (unsigned int index)=0
virtual unsigned int	GetSize () const =0
virtual ProducerPtr	GetByIndex (unsigned int index) const =0
virtual void	Clear ()=0
virtual void	Add (ProducerPtr prod)=0
virtual void	Remove (ProducerPtr prod)=0
virtual void	Append (const ProducerList *list)=0

Friends
class	SystemImpl
class	ProducerImpl

Additional Inherited Members
Protected Member Functions inherited from IProducerList
	IProducerList (void)
	IProducerList (const IProducerList &)
IProducerList &	operator= (const IProducerList &)
Protected Attributes inherited from IProducerList
ProducerListData *	m_pProducerListData

Detailed Description

A list of the available producers on the system.

Examples

ImageRelay.cpp.

Constructor & Destructor Documentation

ProducerList() [1/2]

ProducerList

(

void

)

~ProducerList()

virtual ~ProducerList ( void  )

virtual

ProducerList() [2/2]

ProducerList

(

const ProducerList &

prod

)

Member Function Documentation

Add()

void Add ( ProducerPtr  prod )

virtual

Adds a copy of an producer object.

Parameters

prod	An producer object to be added to this list.

Implements IProducerList.

Append()

void Append ( const ProducerList *  list )

virtual

Appends a copy of the producer list.

Parameters

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

Implements IProducerList.

Clear()

void Clear ( )

virtual

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 IProducerList.

Examples

ImageRelay.cpp.

GetByIndex()

ProducerPtr GetByIndex ( unsigned int  index ) const

virtual

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 IProducerList.

Examples

ImageRelay.cpp.

GetByProducerID()

ProducerPtr 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.

GetSize()

unsigned int GetSize ( ) const

virtual

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 IProducerList.

Examples

ImageRelay.cpp.

operator=()

ProducerList & operator=

(

const ProducerList &

prod

)

Assignment operator.

operator[]()

ProducerPtr operator[] ( unsigned int  index )

virtual

Array subscription operators.

Implements IProducerList.

Remove()

void Remove ( ProducerPtr  prod )

virtual

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 IProducerList.

Friends And Related Symbol Documentation

ProducerImpl

friend class ProducerImpl

friend

SystemImpl

friend class SystemImpl

friend

---

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

• include/ProducerList.h