PySpin.InterfaceList¶

class InterfaceList(*args)¶

A list of the available interfaces on the system.

Add(self, iface)¶

Parameters¶

iface: Spinnaker::InterfacePtr

Spinnaker::InterfaceList::Add Adds a copy of an interface object.

param iface:: An interface object to be added to this list.

Append(self, list)¶

Parameters¶

list: Spinnaker::InterfaceList const *

Spinnaker::InterfaceList::Append Appends a copy of the interfact list.

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

Clear(self)¶: 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.

GetByIndex(self, index) → InterfacePtr¶

Parameters¶

index: unsigned int

Spinnaker::InterfaceList::GetByIndex Returns a pointer to an Interface object at the “index”.

param index:: The index at which to retrieve the Interface object

A pointer to an Interface object.

GetByInterfaceID(self, interfaceID) → InterfacePtr¶

Parameters¶

interfaceID: std::string

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

param interfaceID:: The unique interface identifier of the interface object to retrieve

A pointer to an Interface object.

GetSize(self) → unsigned int¶

Spinnaker::InterfaceList::GetSize Returns the size of the interface list. The size is the number of Interface objects stored in the list.

An integer that represents the list size.

Remove(self, iface)¶

Parameters¶

iface: Spinnaker::InterfacePtr

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

param iface:: Pointer to the interface that is to be removed