|
| | __init__ (self, *args) |
| | Constructs a new mvIMPACT.acquire.ComponentList object.
|
| | changedCounter (self) |
| | Returns the current changed counter for the component referenced by this object.
|
| | changedCounterAttr (self) |
| | Returns the current attribute changed counter for the component referenced by this object.
|
| | contentDescriptor (self) |
| | Returns a string containing information about what's in this list.
|
| | displayName (self) |
| | Returns the display name of the component referenced by this object.
|
| | docString (self) |
| | Returns a string containing general information about the component referenced by this object.
|
| | firstChild (self) |
| | Moves to the first child of this component(moves down one level).
|
| | firstSibling (self) |
| | Moves to the first sibling(the first feature in the current list of features).
|
| | flags (self) |
| | Returns the flags associated with this component.
|
| | flagsAsString (self, *args) |
| | Returns the flags associated with this component as a string.
|
| | getIsDefault (self) |
| | Checks if this component is currently referencing the default for this component.
|
| | getIsList (self) |
| | Checks if this component is of type mvIMPACT.acquire.ComponentList.
|
| | getIsMeth (self) |
| | Checks if this component is of type mvIMPACT.acquire.Method.
|
| | getIsProp (self) |
| | Checks if this component is of type mvIMPACT.acquire.Property or a derived type.
|
| | getIsValid (self) |
| | Checks if the internal component referenced by this object is still valid.
|
| | getIsVisible (self) |
| | Checks if the component is currently shadowed due to a settings made elsewhere or not.
|
| | getIsWriteable (self) |
| | Checks if the caller has write/modify access to the component.
|
| | hObj (self) |
| | Returns a unique identifier for the component referenced by this object.
|
| | lastSibling (self) |
| | Moves to the last sibling(the last feature in the current list of features).
|
| | name (self) |
| | Returns the name of the component referenced by this object.
|
| | nextSibling (self) |
| | Moves to the next sibling(the next feature in the current list of features).
|
| | parent (self) |
| | Moves to the parent of this component(moves up one level).
|
| | representation (self) |
| | Returns the recommended representation for this component.
|
| | representationAsString (self) |
| | Returns the recommended representation of the referenced component as a string.
|
| | restoreDefault (self) |
| | Restores the default for the referenced component.
|
| | selectedFeature (self, index) |
| | Retrieves a component that is selected by the current one.
|
| | selectedFeatureCount (self) |
| | Returns the number of features selected by the current one.
|
| | selectedFeatures (self, v) |
| | Retrieves the list of components that are selected by the current one.
|
| | selectingFeature (self, index) |
| | Retrieves a component that is selecting the current one.
|
| | selectingFeatureCount (self) |
| | Returns the number of features selecting the current one.
|
| | selectingFeatures (self, v) |
| | Retrieves the list of components that are selecting the current one.
|
| | size (self) |
| | Returns The number of valid component entries in the referenced list.
|
| | type (self) |
| | Returns the type of the referenced component.
|
| | typeAsString (self) |
| | Returns the type of the referenced component as a string.
|
| | visibility (self) |
| | Returns the recommended visibility for this component.
|
| | visibilityAsString (self) |
| | Returns the recommended visibility of the referenced component as a string.
|
|
| | isDefault = property (getIsDefault, None, None, None) |
| | A bool property (read-only) which checks if this component is currently referencing the default for this component.
|
| | isList = property (getIsList, None, None, None) |
| | A bool property (read-only) which checks if this component is of type mvIMPACT.acquire.ComponentList.
|
| | isMeth = property (getIsMeth, None, None, None) |
| | A bool property (read-only) which checks if this component is of type mvIMPACT.acquire.Method.
|
| | isProp = property (getIsProp, None, None, None) |
| | A bool property (read-only) which checks if this component is of type mvIMPACT.acquire.Property or a derived type.
|
| | isValid = property (getIsValid, None, None, None) |
| | A bool property (read-only) which checks if the internal component referenced by this object is still valid.
|
| | isVisible = property (getIsVisible, None, None, None) |
| | A bool property (read-only) which checks if the component is currently shadowed due to settings made elsewhere or not.
|
| | isWriteable = property (getIsWriteable, None, None, None) |
| | A bool property (read-only) which checks if the caller has write/modify access to the component.
|
| | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") |
A class to provide access to component lists.
This class provides access to internal component lists of the driver.
Checks if the component is currently shadowed due to a settings made elsewhere or not.
Settings applied to certain components might affect the behaviour of others. For example an activated automatic gain control might shadow the value written to the gain property by the user as the gain is calculated internally. In order to check if modifying the actual component will affect the behaviour of the system this function may be used. When it returns true, the mvIMPACT.acquire.Component will have an impact on the system, if false is returned, the feature might be modified, but this will currently NOT influence the acquisition process or the overall behaviour of the device or driver.
This is what is called visibility. The user still might modify or read the current mvIMPACT.acquire.Component when it's not visible however the actual data will be used only if the Component is visible (mvIMPACT.acquire.cfInvisible must NOT be set).
The visibility of a mvIMPACT.acquire.Component object will change only if other mvIMPACT.acquire.Component objects are modified and NEVER when a program runs but does not change any mvIMPACT.acquire.Component.
| selectedFeature |
( |
| self, |
|
|
| index ) |
|
inherited |
Retrieves a component that is selected by the current one.
This function retrieves a component that is selected by the current one. This information is mainly useful for GUI applications that want to arrange features in a way that dependencies between features can easily been spotted.
When a component 'selects' other components, this indicates that selected components may change whenever the selecting component changes. An example for a selector might be a property defining the index within a LUT while the value of a particular LUT entry could be a selected feature. Assuming 2 properties LUTIndex and LUTValue then changing LUTIndex will invalidate and possibly change LUTValue.
To find out how many mvIMPACT.acquire.Component objects are selected by the current one call mvIMPACT.acquire.Component.selectedFeatureCount. This value minus 1 will also be the max. value for index.
- See also
- mvIMPACT.acquire.Component.selectedFeatureCount,
mvIMPACT.acquire.Component.selectedFeatures
- Since
- 1.11.20
- Returns
- A mvIMPACT.acquire.Component that is selected by the current one.
- Parameters
-
| index | [in] The index for the component to query. |
| selectedFeatures |
( |
| self, |
|
|
| v ) |
|
inherited |
Retrieves the list of components that are selected by the current one.
This function retrieves the list of components that are selected by the current one. This information is mainly useful for GUI applications that want to arrange features in a way that dependencies between features can easily been spotted.
When a component 'selects' other components, this indicates that selected components may change whenever the selecting component changes. An example for a selector might be a property defining the index within a LUT while the value of a particular LUT entry could be a selected feature. Assuming 2 properties LUTIndex and LUTValue then changing LUTIndex will invalidate and possibly change LUTValue.
- See also
- mvIMPACT.acquire.Component.selectedFeatureCount,
mvIMPACT.acquire.Component.selectedFeature
- Since
- 1.11.20
- Returns
- The number of features selected by the current one.
- Parameters
-
| v | [out] An array that will retrieve the list of components that are selected by the current one. |
| selectingFeature |
( |
| self, |
|
|
| index ) |
|
inherited |
Retrieves a component that is selecting the current one.
This function retrieves a component that is selecting the current one. This information is mainly useful for GUI applications that want to arrange features in a way that dependencies between features can easily been spotted.
When a component 'selects' other components, this indicates that selected components may change whenever the selecting component changes. An example for a selector might be a property defining the index within a LUT while the value of a particular LUT entry could be a selected feature. Assuming 2 properties LUTIndex and LUTValue then changing LUTIndex will invalidate and possibly change LUTValue.
To find out how many mvIMPACT.acquire.Component objects are selecting the current one call mvIMPACT.acquire.Component.selectingFeatureCount. This value minus 1 will also be the max. value for index.
- See also
- mvIMPACT.acquire.Component.selectingFeatureCount,
mvIMPACT.acquire.Component.selectingFeatures
- Since
- 1.11.20
- Returns
- A mvIMPACT.acquire.Component that is selecting the current one.
- Parameters
-
| index | [in] The index for the component to query. |
| selectingFeatures |
( |
| self, |
|
|
| v ) |
|
inherited |
Retrieves the list of components that are selecting the current one.
This function retrieves the list of components that are selecting the current one. This information is mainly useful for GUI applications that want to arrange features in a way that dependencies between features can easily been spotted.
When a component 'selects' other components, this indicates that selected components may change whenever the selecting component changes. An example for a selector might be a property defining the index within a LUT while the value of a particular LUT entry could be a selected feature. Assuming 2 properties LUTIndex and LUTValue then changing LUTIndex will invalidate and possibly change LUTValue.
- See also
- mvIMPACT.acquire.Component.selectingFeatureCount,
mvIMPACT.acquire.Component.selectingFeature
- Since
- 1.11.20
- Returns
- The number of features selecting the current one.
- Parameters
-
| v | [out] An array that will retrieve the list of components that are selecting the current one. |
3.7.0