Python Reference Guide
 
Loading...
Searching...
No Matches
FBPlugList Class Reference

FBPlugList class. More...

#include <pyfbsdk.h>

Public Member Functions

 FBPlugList ()
 Constructor.
 
int GetCount ()
 Get number of plugs in list.
 
int __len__ ()
 Returns the number of elements.
 
FBPlug __getitem__ (int pIndex)
 Returns the ith plug.
 

Detailed Description

FBPlugList class.

A list container for FBPlug objects. This class supports basic list access for querying plugs.

# Supported list protocol methods:
len(l)
print l[0]
FBPlugList()
Constructor.

Constructor & Destructor Documentation

◆ FBPlugList()

Constructor.

Member Function Documentation

◆ __getitem__()

FBPlug __getitem__ ( int pIndex)

Returns the ith plug.

Corresponds to python: print l[0]

Parameters
pIndexIndex of the plug to get (0 based).
Returns
The plug at pIndex.

◆ __len__()

int __len__ ( )

Returns the number of elements.

Corresponds to python: len(object)

Returns
Number of plugs.

◆ GetCount()

int GetCount ( )

Get number of plugs in list.

Returns
Number of plugs.