Spinnaker C++
4.0.0.116
Public Member Functions | Friends | List of all members
InterfaceList Class Reference

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

Inheritance diagram for InterfaceList:
IInterfaceList

Public Member Functions

 InterfaceList (void)
 
virtual ~InterfaceList (void)
 
 InterfaceList (const InterfaceList &iface)
 
InterfaceListoperator= (const InterfaceList &iface)
 Assignment operator. More...
 
InterfacePtr operator[] (unsigned int index)
 Array subscription operators. More...
 
unsigned int GetSize () const
 Returns the size of the interface list. More...
 
InterfacePtr GetByIndex (unsigned int index) const
 Returns a pointer to an Interface object at the "index". More...
 
InterfacePtr GetByInterfaceID (std::string interfaceID) const
 Returns a pointer to a interface object with the specified interface identifier. More...
 
void Clear ()
 Clears the list of interfaces and destroys their corresponding objects. More...
 
void Add (InterfacePtr iface)
 Adds a copy of an interface object. More...
 
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. More...
 
void Append (const InterfaceList *list)
 Appends a copy of the interfact list. More...
 
- Public Member Functions inherited from IInterfaceList
virtual ~IInterfaceList (void)
 

Friends

class SystemImpl
 
class ProducerImpl
 

Additional Inherited Members

- Protected Member Functions inherited from IInterfaceList
 IInterfaceList (void)
 
 IInterfaceList (const IInterfaceList &)
 
IInterfaceListoperator= (const IInterfaceList &)
 
- Protected Attributes inherited from IInterfaceList
InterfaceListData * m_pInterfaceListData
 

Detailed Description

A list of the available interfaces on the system.

Examples:
Enumeration.cpp, Enumeration_QuickSpin.cpp, EnumerationEvents.cpp, and NodeMapInfo_QuickSpin.cpp.

Constructor & Destructor Documentation

InterfaceList ( void  )
virtual ~InterfaceList ( void  )
virtual
InterfaceList ( const InterfaceList iface)

Member Function Documentation

void Add ( InterfacePtr  iface)
virtual

Adds a copy of an interface object.

Parameters
ifaceAn interface object to be added to this list.

Implements IInterfaceList.

void Append ( const InterfaceList list)
virtual

Appends a copy of the interfact list.

Parameters
listAnother InterfaceList object, whose elements are added to this list.

Implements IInterfaceList.

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:
Enumeration.cpp, Enumeration_QuickSpin.cpp, EnumerationEvents.cpp, and NodeMapInfo_QuickSpin.cpp.
InterfacePtr GetByIndex ( unsigned int  index) const
virtual

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

Parameters
indexThe index at which to retrieve the Interface object
Returns
A pointer to an Interface object.

Implements IInterfaceList.

Examples:
Enumeration.cpp, Enumeration_QuickSpin.cpp, EnumerationEvents.cpp, and NodeMapInfo_QuickSpin.cpp.
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
interfaceIDThe unique interface identifier of the interface object to retrieve
Returns
A pointer to an Interface object.
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:
Enumeration.cpp, Enumeration_QuickSpin.cpp, EnumerationEvents.cpp, and NodeMapInfo_QuickSpin.cpp.
InterfaceList& operator= ( const InterfaceList iface)

Assignment operator.

InterfacePtr operator[] ( unsigned int  index)
virtual

Array subscription operators.

Implements IInterfaceList.

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
ifacePointer to the interface that is to be removed

Implements IInterfaceList.

Friends And Related Function Documentation

friend class ProducerImpl
friend
friend class SystemImpl
friend

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference