Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Static Private Attributes | List of all members
Leap::DeviceList Class Reference

#include <Leap.h>

Inheritance diagram for Leap::DeviceList:
Inheritance graph
[legend]

Public Types

typedef ConstListIterator< DeviceList, Deviceconst_iterator
 

Public Member Functions

def __getitem__ (self, index)
 
def __init__ (self)
 
def __iter__ (self)
 
def __len__ (self)
 
def append (self, other)
 
LEAP_EXPORT DeviceListappend (const DeviceList &other)
 
LEAP_EXPORT const_iterator begin () const
 
LEAP_EXPORT int count () const
 
 DeviceList (const ListBaseImplementation< Device > &)
 
LEAP_EXPORT DeviceList ()
 
LEAP_EXPORT const_iterator end () const
 
LEAP_EXPORT bool isEmpty () const
 
LEAP_EXPORT Device operator[] (int index) const
 
- Public Member Functions inherited from Leap::Interface
def __init__ (self, args, kwargs)
 

Public Attributes

 this
 

Static Public Attributes

 is_empty = _swig_property(LeapPython.DeviceList_is_empty_get)
 

Static Private Attributes

 __getattr__ = lambda self, name: _swig_getattr(self, DeviceList, name)
 
 __repr__ = _swig_repr
 
 __setattr__ = lambda self, name, value: _swig_setattr(self, DeviceList, name, value)
 
 __swig_destroy__ = LeapPython.delete_DeviceList
 
dictionary __swig_getmethods__ = {}
 
dictionary __swig_setmethods__ = {}
 

Additional Inherited Members

- Protected Member Functions inherited from Leap::Interface
template<typename T >
T * get () const
 
LEAP_EXPORT Interface (void *owner)
 
LEAP_EXPORT Interface (Implementation *reference, void *owner)
 
LEAP_EXPORT Interface (const Interface &rhs)
 
 Interface (class SharedObject *object)
 
LEAP_EXPORT Interfaceoperator= (const Interface &rhs)
 
virtual LEAP_EXPORT ~Interface ()
 
- Static Protected Member Functions inherited from Leap::Interface
static LEAP_EXPORT void deleteCString (const char *cstr)
 
- Protected Attributes inherited from Leap::Interface
class SharedObject * m_object
 

Detailed Description

The DeviceList class represents a list of Device objects.

Get a DeviceList object by calling Controller::devices().

Since
1.0

Definition at line 4114 of file Leap.h.

Member Typedef Documentation

◆ const_iterator

A C++ iterator type for this DeviceList objects.

Since
1.0

Definition at line 4162 of file Leap.h.

Constructor & Destructor Documentation

◆ DeviceList() [1/2]

Leap::DeviceList::DeviceList ( const ListBaseImplementation< Device > &  )

◆ DeviceList() [2/2]

LEAP_EXPORT Leap::DeviceList::DeviceList ( )

Constructs an empty list of devices.

Since
1.0

◆ __init__()

def Leap.DeviceList.__init__ (   self)

Definition at line 1696 of file Leap.py.

Member Function Documentation

◆ __getitem__()

def Leap.DeviceList.__getitem__ (   self,
  index 
)

Definition at line 1706 of file Leap.py.

◆ __iter__()

def Leap.DeviceList.__iter__ (   self)

Definition at line 1714 of file Leap.py.

◆ __len__()

def Leap.DeviceList.__len__ (   self)

Definition at line 1703 of file Leap.py.

◆ append() [1/2]

def Leap.DeviceList.append (   self,
  other 
)

Definition at line 1709 of file Leap.py.

◆ append() [2/2]

LEAP_EXPORT DeviceList& Leap::DeviceList::append ( const DeviceList other)

Appends the members of the specified DeviceList to this DeviceList.

Parameters
otherA DeviceList object containing Device objects to append to the end of this DeviceList.
Since
1.0

◆ begin()

LEAP_EXPORT const_iterator Leap::DeviceList::begin ( ) const

The C++ iterator set to the beginning of this DeviceList.

Since
1.0

◆ count()

LEAP_EXPORT int Leap::DeviceList::count ( ) const

Returns the number of devices in this list.

Returns
The number of devices in this list.
Since
1.0

◆ end()

LEAP_EXPORT const_iterator Leap::DeviceList::end ( ) const

The C++ iterator set to the end of this DeviceList.

Since
1.0

◆ isEmpty()

LEAP_EXPORT bool Leap::DeviceList::isEmpty ( ) const

Reports whether the list is empty.

Returns
True, if the list has no members.
Since
1.0

◆ operator[]()

LEAP_EXPORT Device Leap::DeviceList::operator[] ( int  index) const

Access a list member by its position in the list.

Parameters
indexThe zero-based list position index.
Returns
The Device object at the specified index.
Since
1.0

Member Data Documentation

◆ __getattr__

Leap.DeviceList.__getattr__ = lambda self, name: _swig_getattr(self, DeviceList, name)
staticprivate

Definition at line 1693 of file Leap.py.

◆ __repr__

Leap.DeviceList.__repr__ = _swig_repr
staticprivate

Definition at line 1694 of file Leap.py.

◆ __setattr__

Leap.DeviceList.__setattr__ = lambda self, name, value: _swig_setattr(self, DeviceList, name, value)
staticprivate

Definition at line 1689 of file Leap.py.

◆ __swig_destroy__

Leap.DeviceList.__swig_destroy__ = LeapPython.delete_DeviceList
staticprivate

Definition at line 1720 of file Leap.py.

◆ __swig_getmethods__

dictionary Leap.DeviceList.__swig_getmethods__ = {}
staticprivate

Definition at line 1690 of file Leap.py.

◆ __swig_setmethods__

dictionary Leap.DeviceList.__swig_setmethods__ = {}
staticprivate

Definition at line 1686 of file Leap.py.

◆ is_empty

Leap.DeviceList.is_empty = _swig_property(LeapPython.DeviceList_is_empty_get)
static

Definition at line 1713 of file Leap.py.

◆ this

Leap.DeviceList.this

Definition at line 1701 of file Leap.py.


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


leap_motion
Author(s): Florian Lier , Mirza Shah , Isaac IY Saito
autogenerated on Mon Feb 28 2022 22:41:08