Class Spinnaker::InterfaceList¶

ClassList > Spinnaker > InterfaceList

A list of the available interfaces on the system.

#include <InterfaceList.h>

Inherits the following classes: Spinnaker::IInterfaceList

Public Functions¶

Type	Name
virtual void	Add (InterfacePtr iface)
virtual void	Append (const InterfaceList * list)
virtual void	Clear ()
virtual InterfacePtr	GetByIndex (unsigned int index) const
InterfacePtr	GetByInterfaceID (std::string interfaceID) const
virtual unsigned int	GetSize () const
	InterfaceList (void)
	InterfaceList (const InterfaceList & iface)
virtual void	Remove (InterfacePtr iface)
InterfaceList &	operator= (const InterfaceList & iface)
virtual InterfacePtr	operator[] (unsigned int index)
virtual	~InterfaceList (void)

Public Functions inherited from Spinnaker::IInterfaceList¶

See Spinnaker::IInterfaceList

Type	Name
virtual void	Add (InterfacePtr iface) = 0
virtual void	Append (const InterfaceList * list) = 0
virtual void	Clear () = 0
virtual InterfacePtr	GetByIndex (unsigned int index) const = 0
virtual unsigned int	GetSize () const = 0
virtual void	Remove (InterfacePtr iface) = 0
virtual InterfacePtr	operator[] (unsigned int index) = 0
virtual	~IInterfaceList (void)

Protected Attributes inherited from Spinnaker::IInterfaceList¶

See Spinnaker::IInterfaceList

Type	Name
InterfaceListData *	m_pInterfaceListData

Protected Functions inherited from Spinnaker::IInterfaceList¶

See Spinnaker::IInterfaceList

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

Public Functions Documentation¶

function Add¶

virtual void Spinnaker::InterfaceList::Add (
    InterfacePtr iface
)

Adds a copy of an interface object.

Parameters:

iface An interface object to be added to this list.

Implements Spinnaker::IInterfaceList::Add

function Append¶

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

Appends a copy of the interfact list.

Parameters:

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

Implements Spinnaker::IInterfaceList::Append

function Clear¶

virtual void Spinnaker::InterfaceList::Clear ()

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

function GetByIndex¶

virtual InterfacePtr Spinnaker::InterfaceList::GetByIndex (
    unsigned int index
) const

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

function GetByInterfaceID¶

InterfacePtr Spinnaker::InterfaceList::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.

function GetSize¶

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

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

function InterfaceList [1/2]¶

Spinnaker::InterfaceList::InterfaceList (
    void
)

function InterfaceList [2/2]¶

Spinnaker::InterfaceList::InterfaceList (
    const InterfaceList & iface
)

function Remove¶

virtual void Spinnaker::InterfaceList::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. 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 Spinnaker::IInterfaceList::Remove

function operator=¶

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

Assignment operator.

function operator[]¶

virtual InterfacePtr Spinnaker::InterfaceList::operator[] (
    unsigned int index
)

Array subscription operators

Implements Spinnaker::IInterfaceList::operator[]

function ~InterfaceList¶

virtual Spinnaker::InterfaceList::~InterfaceList (
    void
)

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