PropertyIImageProcessingOptimization Class Reference

A template class to represent 32 bit integer properties and 32 bit enumerated integer properties. More...

Inheritance diagram for PropertyIImageProcessingOptimization:

Public Member Functions
	__init__ (self, *args)
	Constructs a new unbound mvIMPACT.acquire.PropertyI 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.
	dictSize (self)
	Returns the size of the properties translation dictionary.
	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.
	getAllowsValueCombinations (self)
	Checks if this enumerated property allows the combination of enum values.
	getHasDict (self)
	Returns whether this property defines a translation dictionary or not.
	getHasMaxValue (self)
	Checks if a maximum value is defined for this property.
	getHasMinValue (self)
	Checks if a minimum value is defined for this property.
	getHasStepWidth (self)
	Checks if a step width is defined for this property.
	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.
	getMaxValue (self)
	Reads the maximum value from a property.
	getMinValue (self)
	Reads the minimum value from a property.
	getStepWidth (self)
	Reads the step width from a property.
	getTranslationDict (self, sequence)
	This function queries the property's translation table.
	getTranslationDictString (self, index=0)
	This function reads a single translation table string entry from a property.
	getTranslationDictStrings (self, sequence)
	This function queries a list of valid strings for this property.
	getTranslationDictValue (self, index=0)
	This function reads a single translation table value entry from a property.
	getTranslationDictValues (self, sequence)
	This function queries a list of valid values for this property.
	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).
	maxValCount (self)
	Returns maximum number of values that can be managed by this property.
	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).
	read (self, *args)
	Reads a value from a property.
	readS (self, *args)
	Reads data from this property as a string.
	readSArray (self, *args)
	Reads data from this property as a string.
	removeValue (self, index=0)
	Removes a certain value from the property's data.
	representation (self)
	Returns the recommended representation for this component.
	representationAsString (self)
	Returns the recommended representation of the referenced component as a string.
	resizeValArray (self, newSize)
	Resizes the property's data array.
	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.
	stringFormatString (self)
	Returns the internal format string this property uses to convert data to strings.
	type (self)
	Returns the type of the referenced component.
	typeAsString (self)
	Returns the type of the referenced component as a string.
	valCount (self)
	Returns the current number of values managed by this property.
	visibility (self)
	Returns the recommended visibility for this component.
	visibilityAsString (self)
	Returns the recommended visibility of the referenced component as a string.
	write (self, *args)
	Writes one value to the property.
	writeS (self, *args)
	Assigns a new value to this property.

Static Public Member Functions
	getRepresentationAsString (representation)
	Returns the recommended representation converted to a string.
	getType (hObj)
	Returns the type of the component referenced by hObj.
	getVisibilityAsString (visibility)
	Returns the recommended visibility converted to a string.

Properties
	allowsValueCombinations = property (getAllowsValueCombinations, None, None, None)
	A bool property (read-only) which checks if this enumerated property allows the combination of enum values.
	hasDict = property (getHasDict, None, None, None)
	A bool property (read-only) which checks whether this property defines a translation dictionary or not.
	hasMaxValue = property (getHasMaxValue, None, None, None)
	A bool property (read-only) which checks if a maximum value is defined for this property.
	hasMinValue = property (getHasMinValue, None, None, None)
	A bool property (read-only) which checks if a minimum value is defined for this property.
	hasStepWidth = property (getHasStepWidth, None, None, None)
	A bool property (read-only) which checks if a step width is defined for this property.
	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")

Detailed Description

A template class to represent 32 bit integer properties and 32 bit enumerated integer properties.

The template parameter specifies the enum to use as the value type for this enumerated property. The class itself however is restricted for integer values. To use a normal int (not enumerated) properties use the mvIMPACT.acquire.PropertyI type.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args )

Constructs a new unbound mvIMPACT.acquire.PropertyI object.

OVERLOAD 1:

OVERLOAD 2: Constructs a new mvIMPACT.acquire.PropertyI object.

Parameters

hProp

[in] A valid handle to an integer property

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

Parameters

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

Member Function Documentation

changedCounter()

changedCounter ( self )

inherited

Returns the current changed counter for the component referenced by this object.

This changed counter is incremented internally each time the component is modified. To check if this component has been modified since the last time, this check has been performed, keep track of the last return value of this function and compare it with the new value. This can be helpful e.g. to keep a GUI up to date. The value returned by this function will always be larger than or equal to the value returned by mvIMPACT.acquire.ComponentAccess.changedCounterAttr (except in case of a wrap around) when called at the same time for the same object as it's always incremented when the component has been modified in any way while the latter one will only be incremented if the attributes (e.g. the flags) but NOT if e.g. the value(s) of a property has been modified.

class ComponentRef
  def __init__(self, c):
    self.c_ = c
    self.lastChangedCount_ = 0
 
def fn(cr):
  if cr.c_.isValid:
    currentChangedCount = cr.c_.changedCounter()
    if currentChangedCount != cr.lastChangedCount_:
      # something has happened since the last check!
      doWhatNeedsToBeDone()
      # and remember the current changed counter
      cr.lastChangedCount_ = currentChangedCount

Returns

The current changed counter of this object.

changedCounterAttr()

changedCounterAttr ( self )

inherited

Returns the current attribute changed counter for the component referenced by this object.

This changed counter is incremented internally each time the components attributes have been modified. To check if this components attributes have been modified since the last time, this check has been performed, keep track of the last return value of this function and compare it with the new value. This can be helpful e.g. to keep a GUI up to date.

Note

Attributes changes are e.g. a modification to a property's translation dictionary, but NOT a property's value. Because of this the value returned by this function will always be less or equal than the value returned by the function mvIMPACT.acquire.ComponentAccess.changedCounter (except in case of a wrap around) when called at the same time for the same object.

See also

mvIMPACT.acquire.ComponentAccess.changedCounter

Returns

The current attributes changed counter of this object.

dictSize()

dictSize ( self )

inherited

Returns the size of the properties translation dictionary.

If the property does define a translation dictionary this function returns the number of elements contained in this dictionary.

Returns

• The size of the properties translation dictionary.
• 0 If this property does not define a translation dictionary.

displayName()

displayName ( self )

inherited

Returns the display name of the component referenced by this object.

Since

1.11.20

Returns

The display name of the component referenced by this object. This might be an empty string if no display name has been specified.

docString()

docString ( self )

inherited

Returns a string containing general information about the component referenced by this object.

Returns

A string containing general information about the component referenced by this object.

firstChild()

firstChild ( self )

inherited

Moves to the first child of this component(moves down one level).

Calling this function will only succeed, if the current mvIMPACT.acquire.Component references a list.

Returns

A new mvIMPACT.acquire.Component object

firstSibling()

firstSibling ( self )

inherited

Moves to the first sibling(the first feature in the current list of features).

Returns

A new mvIMPACT.acquire.Component object

flags()

flags ( self )

inherited

Returns the flags associated with this component.

Returns

The flags associated with this component.

flagsAsString()

flagsAsString ( self, * args )

inherited

Returns the flags associated with this component as a string.

Returns

The flags associated with this component as a string.

Parameters

separator

[in] A user definable string to separate the individual flags. The default value is ' | ' resulting in the string to look e.g. like this: 'cfWriteAccess | cfReadAccess'

getAllowsValueCombinations()

getAllowsValueCombinations ( self )

inherited

Checks if this enumerated property allows the combination of enum values.

If this function returns true, the enum constants can be 'ored' together. This works for the enum constants as well as for the string representations returned in the properties translation dictionary.

if a property e.g. defines a dictionary (('1', "one"), ('2', "two")) the following write operations will be valid:

prop = getPropFromSomewhere()
prop.write( 1 | 2 )
prop.write( "one | two" )

If this function returns true code like this will be valid:

prop = getPropFromSomewhere()
prop.write(1 | 2)
prop.write("one | two")

Returns

• true if this property allows the combination of enum values.
• false otherwise.

getHasDict()

getHasDict ( self )

inherited

Returns whether this property defines a translation dictionary or not.

Returns

• true if this property defines a translation table
• false otherwise

getHasMaxValue()

getHasMaxValue ( self )

inherited

Checks if a maximum value is defined for this property.

Since

1.12.63

Returns

• true if this property defines a maximum value
• false otherwise

getHasMinValue()

getHasMinValue ( self )

inherited

Checks if a minimum value is defined for this property.

Since

1.12.63

Returns

• true if this property defines a minimum value
• false otherwise

getHasStepWidth()

getHasStepWidth ( self )

inherited

Checks if a step width is defined for this property.

Since

1.12.63

Returns

• true if this property defines a step width
• false otherwise

getIsDefault()

getIsDefault ( self )

inherited

Checks if this component is currently referencing the default for this component.

This function will return true only for derived components that have not been modified.

Returns

• true if the component is currently set to its default value
• false otherwise.

getIsList()

getIsList ( self )

inherited

Checks if this component is of type mvIMPACT.acquire.ComponentList.

Returns

• true if the component references a list
• false otherwise

getIsMeth()

getIsMeth ( self )

inherited

Checks if this component is of type mvIMPACT.acquire.Method.

Returns

• true if the component references a method
• false otherwise

getIsProp()

getIsProp ( self )

inherited

Checks if this component is of type mvIMPACT.acquire.Property or a derived type.

Returns

• true if the component references a property
• false otherwise

getIsValid()

getIsValid ( self )

inherited

Checks if the internal component referenced by this object is still valid.

This function can be used to verify whether a referenced component is still valid or not. When e.g. referencing a driver property after mvIMPACT.acquire.Device.close has been called this function would return false. Calling any other function that tries to access the referenced component in that case would raise an exception.

Returns

• true if this object currently references a valid component
• false otherwise.

getIsVisible()

getIsVisible ( self )

inherited

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.

getIsWriteable()

getIsWriteable ( self )

inherited

Checks if the caller has write/modify access to the component.

Returns

• true if the caller is allowed to call write/modify operation for this component.
• false otherwise.

getMaxValue()

getMaxValue

(

self

)

Reads the maximum value from a property.

Note

To find out if the property defines a maximum value mvIMPACT.acquire.Property.hasMaxValue should be called first.

If the property does not define a maximum value calling this function will raise an exception.

Since

1.12.63

getMinValue()

getMinValue

(

self

)

Reads the minimum value from a property.

Note

To find out if the property defines a minimum value mvIMPACT.acquire.Property.hasMinValue should be called first.

If the property does not define a minimum value calling this function will raise an exception.

Since

1.12.63

getRepresentationAsString()

getRepresentationAsString ( representation )

staticinherited

Returns the recommended representation converted to a string.

Since

2.14.0

Returns

The recommended representation converted to a string.

Parameters

representation

[in] The representation to query the string representation for

getStepWidth()

getStepWidth

(

self

)

Reads the step width from a property.

Note

To find out if the property defines a step width mvIMPACT.acquire.Property.hasStepWidth should be called first.

If the property does not define a step width calling this function will raise an exception.

Since

1.12.63

getTranslationDict()

getTranslationDict	(		self,
			sequence )

This function queries the property's translation table.

If this property defines a translation table the strings and their corresponding translation values will be written into sequence. If the property does NOT define a translation table sequence will be empty after this function call.

Note

This function is much more efficient than calling mvIMPACT.acquire.PropertyI.getTranslationDictString and mvIMPACT.acquire.PropertyI.getTranslationDictValue multiple times and therefore this function should be called whenever all entries are required.

Returns

A const reference to the calling property.

Parameters

sequence

[out] A reference to a container which will receive the data from the properties translation dictionary.

getTranslationDictString()

getTranslationDictString	(		self,
			index = 0 )

This function reads a single translation table string entry from a property.

If this property defines a translation table and index specifies a valid entry the string representation of this entry will be returned. If the property does NOT define a translation table or index specifies an invalid entry an exception will be thrown.

Parameters

index

[in] The index of the entry to read from the property.

getTranslationDictStrings()

getTranslationDictStrings	(		self,
			sequence )

This function queries a list of valid strings for this property.

If this property defines a translation table all valid strings will be written into sequence. If the property does NOT define a translation table sequence will be empty after this function call.

Note

This function is much more efficient than calling mvIMPACT.acquire.PropertyI.getTranslationDictString multiple times and therefore this function should be called whenever all entries are required.

Since

2.5.0

Returns

A const reference to the calling property.

Parameters

sequence

[out] A reference to a container to store the data read from the property into.

getTranslationDictValue()

getTranslationDictValue	(		self,
			index = 0 )

This function reads a single translation table value entry from a property.

If this property defines a translation table and index specifies a valid entry the value of this entry will be returned. If the property does NOT define a translation table or index specifies an invalid entry an exception will be thrown.

See also

mvIMPACT.acquire.PropertyI.getTranslationDictValues to query all valid values efficiently in a single call.

Parameters

index

[in] The index of the entry to read from the property.

getTranslationDictValues()

getTranslationDictValues	(		self,
			sequence )

This function queries a list of valid values for this property.

If this property defines a translation table all valid values will be written into sequence. If the property does NOT define a translation table sequence will be empty after this function call.

Note

This function is much more efficient than calling mvIMPACT.acquire.PropertyI.getTranslationDictValue multiple times and therefore this function should be called whenever all entries are required.

Since

1.12.68

Returns

A const reference to the calling property.

Parameters

sequence

[out] A reference to a container to store the data read from the property into.

getType()

getType ( hObj )

staticinherited

Returns the type of the component referenced by hObj.

Returns

The type of the component referenced by hObj.

Parameters

hObj	[in] The component the type shall be retrieved for

getVisibilityAsString()

getVisibilityAsString ( visibility )

staticinherited

Returns the recommended visibility converted to a string.

Returns

The recommended visibility converted to a string.

Parameters

visibility

[in] The visibility to query the string representation for

hObj()

hObj ( self )

inherited

Returns a unique identifier for the component referenced by this object.

Returns

A unique identifier for the component referenced by this object.

lastSibling()

lastSibling ( self )

inherited

Moves to the last sibling(the last feature in the current list of features).

Since

1.10.64

Returns

A new mvIMPACT.acquire.Component object

maxValCount()

maxValCount ( self )

inherited

Returns maximum number of values that can be managed by this property.

For the majority of properties this function will return '1', but as properties might manage more than a single value, this value might be interesting from time to time.

Returns

the maximum number of values that can be managed by this property.

name()

name ( self )

inherited

Returns the name of the component referenced by this object.

Returns

The name of the component referenced by this object.

nextSibling()

nextSibling ( self )

inherited

Moves to the next sibling(the next feature in the current list of features).

Returns

A new mvIMPACT.acquire.Component object

parent()

parent ( self )

inherited

Moves to the parent of this component(moves up one level).

Returns

A new mvIMPACT.acquire.Component object

read()

read	(		self,
		*	args )

Reads a value from a property.

OVERLOAD 1:

This function queries a single value stored under index index in the property.

Returns

The value stored at index within the property.

Parameters

index

[in] The index of the value to read from the property.

OVERLOAD 2: Reads a set of values from a property.

This function queries a set of values from a property and stores these values into sequence.

Parameters

sequence	[out] A reference to a container to store the data read from the property into.
start	[in] The index from where to start reading values from the property.
end	[in] The index where to stop reading values from the property.

OVERLOAD 3: Reads a set of values from a property.

This function queries a set of values from a property and stores these values into sequence.

Parameters

sequence	[out] A reference to a container to store the data read from the property into.
start	[in] The index from where to start reading values from the property.
end	[in] The index where to stop reading values from the property.

OVERLOAD 4: Reads a set of values from a property.

This function queries a set of values from a property and stores these values into sequence.

Parameters

sequence	[out] A reference to a container to store the data read from the property into.
start	[in] The index from where to start reading values from the property.
end	[in] The index where to stop reading values from the property.

OVERLOAD 5: Reads a set of values from a property.

This function queries a set of values from a property and stores these values into sequence.

Parameters

sequence	[out] A reference to a container to store the data read from the property into.
boAtomic	[in] Set this parameter to true to get all values at once(recommended). If set to false the function will need more time and all values in sequence will be read one after the other
start	[in] The index from where to start reading values from the property.
end	[in] The index where to stop reading values from the property.

OVERLOAD 6: Reads a set of values from a property.

This function queries a set of values from a property and stores these values into sequence.

Parameters

sequence	[out] A reference to a container to store the data read from the property into.
boAtomic	[in] Set this parameter to true to get all values at once(recommended). If set to false the function will need more time and all values in sequence will be read one after the other
start	[in] The index from where to start reading values from the property.
end	[in] The index where to stop reading values from the property.

OVERLOAD 7: Reads a set of values from a property.

This function queries a set of values from a property and stores these values into sequence.

Parameters

sequence	[out] A reference to a container to store the data read from the property into.
boAtomic	[in] Set this parameter to true to get all values at once(recommended). If set to false the function will need more time and all values in sequence will be read one after the other
start	[in] The index from where to start reading values from the property.
end	[in] The index where to stop reading values from the property.

readS()

readS ( self, * args )

inherited

Reads data from this property as a string.

Note

If the caller does not have the needed rights this function might throw an exception of the type mvIMPACT.acquire.ImpactAcquireException.

Returns

A string containing the data questioned.

Parameters

index	[in] The index of the desired value(only necessary for properties containing more than one value)
format	[in] The format string telling the function how to format the result. If left empty the property uses its standard way of converting its data into a string

readSArray()

readSArray ( self, * args )

inherited

Reads data from this property as a string.

This function can be used to query a set of values if this property stores more than a single value which might be useful for GUI applications.

PropertyI p = getPropFromSomewhere()
p.write(1)
p.write(2, 1)
p.write(666, 2)
s = p.readSArray("%d", "&&:", 1)
# now s should contain '2&&:666'
s = p.readSArray("%4d", " ", 0, 1)
# now s should contain '   1,   2'

Note

If the caller does not have the needed rights this function might throw an exception of the type mvIMPACT.acquire.ImpactAcquireException.

Returns

A string containing the data questioned.

Parameters

format	[in] The format string telling the function how to format the result. If left empty the property uses its standard way of converting its data into a string
delimiter	[in] This string is used to separate the individual values from one another. If left empty, a single blank will separate the data.
startIndex	[in] The index of the first of the desired values
endIndex	[in] The index of the last of the desired values. If INT_MAX is passed, every from startIndex to the last value stored by the property will be returned.
mode	[in] Specifies the mode this function operates in. Currently only the LSB affects the behaviour of this function. When the LSB is set, the translation dictionary (if defined) will be ignored for this call.

removeValue()

removeValue ( self, index = 0 )

inherited

Removes a certain value from the property's data.

Returns

A const reference to the calling property.

Parameters

index

[in] The index of the value to be removed

representation()

representation ( self )

inherited

Returns the recommended representation for this component.

The representation can be used e.g. to develop a GUI that creates convenient controls for certain features.

Valid values for this property may be: mvIMPACT.acquire.crUndefined, mvIMPACT.acquire.crLinear, mvIMPACT.acquire.crLogarithmic, mvIMPACT.acquire.crBoolean, mvIMPACT.acquire.crPureNumber, mvIMPACT.acquire.crHexNumber, mvIMPACT.acquire.crIPv4Address, mvIMPACT.acquire.crMACAddress, mvIMPACT.acquire.crFileName, mvIMPACT.acquire.crDirectoryName.

Since

2.14.0

Returns

The recommended representation for this component.

representationAsString()

representationAsString ( self )

inherited

Returns the recommended representation of the referenced component as a string.

Since

2.14.0

Returns

The recommended representation of the referenced component as a string.

resizeValArray()

resizeValArray ( self, newSize )

inherited

Resizes the property's data array.

This function resizes the internal data array of this property. The size of this array represents the number of values, which can be stored within the property. This function will only succeed, if the mvIMPACT.acquire.cfFixedSize is NOT set for this property and the user has "write rights" for this property. Otherwise an exception will be thrown. Whenever the user successfully writes an array of values to a property and this array contains more elements than the current internal data array can accommodate at the desired offset the internal data array will be increased automatically.

Note

If the caller does not have the needed rights this function might throw an exception of the type mvIMPACT.acquire.ImpactAcquireException.

In order to be allowed to modify the number of values a property can store, the mvIMPACT.acquire.cfFixedSize flag must NOT be set.

See also

mvIMPACT.acquire.Component.isWriteable

Returns

A const reference to the calling property.

Parameters

newSize

[in] The new number of values this property shall be allowed to store

restoreDefault()

restoreDefault ( self )

inherited

Restores the default for the referenced component.

Calling this function will restore the default value for the component referenced by this object.

If this function is called for an object of type mvIMPACT.acquire.ComponentList every component in that list is restored to the default value.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

selectedFeature()

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.

selectedFeatureCount()

selectedFeatureCount ( self )

inherited

Returns the number of features selected by the current one.

See also

mvIMPACT.acquire.Component.selectedFeatures,
mvIMPACT.acquire.Component.selectedFeature

Since

1.11.20

Returns

The number of features selected by the current one.

selectedFeatures()

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()

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.

selectingFeatureCount()

selectingFeatureCount ( self )

inherited

Returns the number of features selecting the current one.

See also

mvIMPACT.acquire.Component.selectingFeatures,
mvIMPACT.acquire.Component.selectingFeature

Since

1.11.20

Returns

The number of features selecting the current one.

selectingFeatures()

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.

stringFormatString()

stringFormatString ( self )

inherited

Returns the internal format string this property uses to convert data to strings.

Returns

A string containing the format string internally used by the property whenever the user reads a value as a string without specifying a format string and the property is not a string type one.

type()

type ( self )

inherited

Returns the type of the referenced component.

Returns

The type of the referenced component.

typeAsString()

typeAsString ( self )

inherited

Returns the type of the referenced component as a string.

Returns

The type of the referenced component as a string.

valCount()

valCount ( self )

inherited

Returns the current number of values managed by this property.

For the majority of properties this function will return '1', but as properties might manage more than a single value, this value might be interesting from time to time.

Returns

the current number of values managed by this property.

visibility()

visibility ( self )

inherited

Returns the recommended visibility for this component.

The visibility can be used e.g. to develop a GUI that displays a crucial subset of features only.

Valid values for this property may be: mvIMPACT.acquire.cvBeginner, mvIMPACT.acquire.cvExpert, mvIMPACT.acquire.cvGuru, mvIMPACT.acquire.cvInvisible.

Returns

The recommended visibility for this component.

visibilityAsString()

visibilityAsString ( self )

inherited

Returns the recommended visibility of the referenced component as a string.

Returns

The recommended visibility of the referenced component as a string.

write()

write	(		self,
		*	args )

Writes one value to the property.

OVERLOAD 1:

This function writes a single value under index index to the property.

Returns

A const 'self' reference.

Parameters

value	[in] The value to write to the property.
index	[in] The index defining at which position to write the value.

OVERLOAD 2: Writes a set of values to the property.

This function writes a set of values starting at index to the property.

Returns

A const 'self' reference.

Parameters

sequence	[in] An array containing the values to write to the property.
index	[in] The index where to write the first value to the property.

OVERLOAD 3: Writes a set of values to the property.

This function writes a set of values starting at index to the property.

Returns

A const 'self' reference.

Parameters

sequence	[in] An array containing the values to write to the property.
index	[in] The index where to write the first value to the property.

OVERLOAD 4: Writes a set of values to the property.

This function writes a set of values starting at index to the property.

Returns

A const 'self' reference.

Parameters

sequence	[in] An array containing the values to write to the property.
boAtomic	[in] Set this parameter to true to set all values at once(recommended). If set to false the function will need more time and all values in sequence will be set one after the other
index	[in] The index where to write the first value to the property.

OVERLOAD 5: Writes a set of values to the property.

This function writes a set of values starting at index to the property.

Returns

A const 'self' reference.

Parameters

sequence	[in] An array containing the values to write to the property.
boAtomic	[in] Set this parameter to true to set all values at once(recommended). If set to false the function will need more time and all values in sequence will be set one after the other
index	[in] The index where to write the first value to the property.

writeS()

writeS ( self, * args )

inherited

Assigns a new value to this property.

OVERLOAD 1:

The user caller have "write rights" for this property in order to be able to modify its value. Also if index is greater than the current internal data array size of this property the user must be allowed to change to size of the properties internal data array (the mvIMPACT.acquire.cfFixedSize flag must NOT be set).

Note

If the caller does not have the needed rights this function might throw an exception of the type mvIMPACT.acquire.ImpactAcquireException.

See also

mvIMPACT.acquire.Component.isWriteable,
mvIMPACT.acquire.Component.flags,
mvIMPACT.acquire.Property.writeS

Returns

A const reference to the calling property.

Parameters

value	[in] The new value for this property at the given index.
index	[in] The index of the value to modify

OVERLOAD 2: Assigns new values to this property.

The user must have "write rights" for this property in order to be able to modify its values. Also if index is greater than the current internal data array size of this property the user must be allowed to change to size of the properties internal data array (the mvIMPACT.acquire.cfFixedSize flag must NOT be set). This function behaves exactly like mvIMPACT.acquire.Property.writeS except that is can be used to assign more than one value at the same time. The parameter index here serves as an offset. If for example a property holds 3 values 'one', 'two' and 'three' before this call and the function is then called with an array containing the string 'orange' and 'blue' and index = 2 then after a successful call to this function the property will hold the data 'one', 'two', 'orange' and 'blue'.

Note

If the caller does not have the needed rights this function might throw an exception of the type mvIMPACT.acquire.ImpactAcquireException.

See also

mvIMPACT.acquire.Component.isWriteable,
mvIMPACT.acquire.Component.flags,
mvIMPACT.acquire.Property.writeS

Returns

A const reference to the calling property.

Parameters

sequence	[in] A constant reference to an array containing the strings to be assigned to the property
index	[in] The offset from where to start to assign the values

OVERLOAD 3: Assigns new values to this property.

The user must have "write rights" for this property in order to be able to modify its values. Also if index is greater than the current internal data array size of this property the user must be allowed to change to size of the properties internal data array (the mvIMPACT.acquire.cfFixedSize flag must NOT be set). This function behaves exactly like mvIMPACT.acquire.Property.writeS except that is can be used to assign more than one value at the same time. The parameter index here serves as an offset. If for example a property holds 3 values 'one', 'two' and 'three' before this call and the function is then called with an array containing the string 'orange' and 'blue' and index = 2 then after a successful call to this function the property will hold the data 'one', 'two', 'orange' and 'blue'.

Note

If the caller does not have the needed rights this function might throw an exception of the type mvIMPACT.acquire.ImpactAcquireException.

See also

mvIMPACT.acquire.Component.isWriteable,
mvIMPACT.acquire.Component.flags,
mvIMPACT.acquire.Property.writeS

Returns

A const reference to the calling property.

Parameters

sequence	[in] A constant reference to an array containing the strings to be assigned to the property
index	[in] The offset from where to start to assign the values

Property Documentation

allowsValueCombinations

allowsValueCombinations = property (getAllowsValueCombinations, None, None, None)

staticinherited

A bool property (read-only) which checks if this enumerated property allows the combination of enum values.

See mvIMPACT.acquire.Property.getAllowsValueCombinations()

hasDict

hasDict = property (getHasDict, None, None, None)

staticinherited

A bool property (read-only) which checks whether this property defines a translation dictionary or not.

See mvIMPACT.acquire.Property.getHasDict()

hasMaxValue

hasMaxValue = property (getHasMaxValue, None, None, None)

staticinherited

A bool property (read-only) which checks if a maximum value is defined for this property.

See mvIMPACT.acquire.Property.getHasMaxValue()

hasMinValue

hasMinValue = property (getHasMinValue, None, None, None)

staticinherited

A bool property (read-only) which checks if a minimum value is defined for this property.

See mvIMPACT.acquire.Property.getHasMinValue()

hasStepWidth

hasStepWidth = property (getHasStepWidth, None, None, None)

staticinherited

A bool property (read-only) which checks if a step width is defined for this property.

See mvIMPACT.acquire.Property.getHasStepWidth()

isDefault

isDefault = property (getIsDefault, None, None, None)

staticinherited

A bool property (read-only) which checks if this component is currently referencing the default for this component.

See mvIMPACT.acquire.Component.getIsDefault()

isList

isList = property (getIsList, None, None, None)

staticinherited

A bool property (read-only) which checks if this component is of type mvIMPACT.acquire.ComponentList.

See mvIMPACT.acquire.Component.getIsList()

isMeth

isMeth = property (getIsMeth, None, None, None)

staticinherited

A bool property (read-only) which checks if this component is of type mvIMPACT.acquire.Method.

See mvIMPACT.acquire.Component.getIsMeth()

isProp

isProp = property (getIsProp, None, None, None)

staticinherited

A bool property (read-only) which checks if this component is of type mvIMPACT.acquire.Property or a derived type.

See mvIMPACT.acquire.Component.getIsProp()

isValid

isValid = property (getIsValid, None, None, None)

staticinherited

A bool property (read-only) which checks if the internal component referenced by this object is still valid.

See mvIMPACT.acquire.Component.getIsValid()

isVisible

isVisible = property (getIsVisible, None, None, None)

staticinherited

A bool property (read-only) which checks if the component is currently shadowed due to settings made elsewhere or not.

See mvIMPACT.acquire.Component.getIsVisible()

isWriteable

isWriteable = property (getIsWriteable, None, None, None)

staticinherited

A bool property (read-only) which checks if the caller has write/modify access to the component.

See mvIMPACT.acquire.Component.getIsWriteable()

thisown

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

static