Impact Acquire SDK Python
ComponentList Class Reference

A class to provide access to component lists. More...

Inheritance diagram for ComponentList:
[legend]

Public Member Functions

 __init__ (self, *args)
 Constructs a new mvIMPACT.acquire.ComponentList object.
 
 contentDescriptor (self)
 Returns a string containing information about what's in this list.
 
 size (self)
 Returns The number of valid component entries in the referenced list.
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

A class to provide access to component lists.

This class provides access to internal component lists of the driver.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args )

Constructs a new mvIMPACT.acquire.ComponentList object.

OVERLOAD 1:

Parameters
hList[in] A valid handle to a list object

OVERLOAD 2: Constructs a new unbound mvIMPACT.acquire.ComponentList object.

OVERLOAD 3: Constructs a new mvIMPACT.acquire.ComponentList from an existing one.

Parameters
src[in] A constant reference to the mvIMPACT.acquire.ComponentList object, this object shall be created from

Reimplemented from Component.

Member Function Documentation

◆ contentDescriptor()

contentDescriptor ( self)

Returns a string containing information about what's in this list.

This string might not be defined by every list but in any case this function will return a valid string. However this string might be empty.

◆ size()

size ( self)

Returns The number of valid component entries in the referenced list.

Returns
The number of valid component entries in the referenced list.

Property Documentation

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static