InterfaceList Class Reference

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

#include <InterfaceList.h>

Inheritance diagram for InterfaceList:

Public Member Functions
	InterfaceList (void)
virtual	~InterfaceList (void)
	InterfaceList (const InterfaceList &iface)
InterfaceList &	operator= (const InterfaceList &iface)
	Assignment operator.
InterfacePtr	operator[] (unsigned int index)
	Array subscription operators.
unsigned int	GetSize () const
	Returns the size of the interface list.
InterfacePtr	GetByIndex (unsigned int index) const
	Returns a pointer to an Interface object at the "index".
InterfacePtr	GetByInterfaceID (std::string interfaceID) const
	Returns a pointer to a interface object with the specified interface identifier.
void	Clear ()
	Clears the list of interfaces and destroys their corresponding objects.
void	Add (InterfacePtr iface)
	Adds a copy of an interface object.
void	Remove (InterfacePtr iface)
	Removes all occurences of an interface that is pointed to by the input interface pointer and destroys its corresponding reference counted object.
void	Append (const InterfaceList *list)
	Appends a copy of the interfact list.
Public Member Functions inherited from IInterfaceList
virtual	~IInterfaceList (void)
virtual InterfacePtr	operator[] (unsigned int index)=0
virtual unsigned int	GetSize () const =0
virtual InterfacePtr	GetByIndex (unsigned int index) const =0
virtual void	Clear ()=0
virtual void	Add (InterfacePtr iface)=0
virtual void	Remove (InterfacePtr iface)=0
virtual void	Append (const InterfaceList *list)=0

Friends
class	SystemImpl
class	ProducerImpl

Additional Inherited Members
Protected Member Functions inherited from IInterfaceList
	IInterfaceList (void)
	IInterfaceList (const IInterfaceList &)
IInterfaceList &	operator= (const IInterfaceList &)
Protected Attributes inherited from IInterfaceList
InterfaceListData *	m_pInterfaceListData

Detailed Description

A list of the available interfaces on the system.

Examples

NodeMapInfo_QuickSpin.cpp.

Constructor & Destructor Documentation

InterfaceList() [1/2]

InterfaceList

(

void

)

~InterfaceList()

virtual ~InterfaceList ( void  )

virtual

InterfaceList() [2/2]

InterfaceList

(

const InterfaceList &

iface

)

Member Function Documentation

Add()

void Add ( InterfacePtr  iface )

virtual

Adds a copy of an interface object.

Parameters

iface

An interface object to be added to this list.

Implements IInterfaceList.

Append()

void Append ( const InterfaceList *  list )

virtual

Appends a copy of the interfact list.

Parameters

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

Implements IInterfaceList.

Clear()

void Clear ( )

virtual

Clears the list of interfaces 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 interfaces is still in use this function will throw an exception.

Implements IInterfaceList.

Examples

NodeMapInfo_QuickSpin.cpp.

GetByIndex()

InterfacePtr GetByIndex ( unsigned int  index ) const

virtual

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

Parameters

index

The index at which to retrieve the Interface object

Returns

A pointer to an Interface object.

Implements IInterfaceList.

Examples

NodeMapInfo_QuickSpin.cpp.

GetByInterfaceID()

InterfacePtr GetByInterfaceID

(

std::string

interfaceID

)

const

Returns a pointer to a interface object with the specified interface identifier.

This function will return a NULL InterfacePtr if no matching interface identifier is found.

Parameters

interfaceID

The unique interface identifier of the interface object to retrieve

Returns

A pointer to an Interface object.

GetSize()

unsigned int GetSize ( ) const

virtual

Returns the size of the interface list.

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

Returns

An integer that represents the list size.

Implements IInterfaceList.

Examples

NodeMapInfo_QuickSpin.cpp.

operator=()

InterfaceList & operator=

(

const InterfaceList &

iface

)

Assignment operator.

operator[]()

InterfacePtr operator[] ( unsigned int  index )

virtual

Array subscription operators.

Implements IInterfaceList.

Remove()

void Remove ( InterfacePtr  iface )

virtual

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

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

Parameters

iface

Pointer to the interface that is to be removed

Implements IInterfaceList.

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/InterfaceList.h