|
| | __init__ (self, *args) |
| | Constructs a new unbound mvIMPACT.acquire.PropertyS object.
|
| | binaryDataBufferMaxSize (self) |
| | Reads the max size(in bytes) of binary data this property can store.
|
| | binaryDataBufferSize (self, index=0) |
| | Returns the size(in bytes) needed for the binary representation of the string buffer.
|
| | 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.
|
| | 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.
|
| | readBinary (self, *args) |
| | Reads a value stored in the property as binary data.
|
| | 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.
|
| | writeBinary (self, *args) |
| | Writes a block of binary data to one entry of the property.
|
| | writeS (self, *args) |
| | Assigns a new value to this property.
|
|
| | 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") |
A class to represent string properties.
| readBinary |
( |
| self, |
|
|
* | args ) |
Reads a value stored in the property as binary data.
OVERLOAD 1:
Binary data can only be stored in string properties. When writing binary data to a string property it's stored in Base64 format internally. The Base64 algorithm converts arbitrary data into a read and printable string representation. As a result of this 3 bytes of arbitrary binary data will occupy 4 bytes of memory.
Reading binary data with this function obviously only makes sense if the property has been assigned the value by a previous call to mvIMPACT.acquire.PropertyS.writeBinary (here you find a small code example as well). However using this method any kind of data can be stored by a string property. This can e.g. be interesting when certain data shall be stored in the user accessible part of the devices non-volatile memory.
- See also
- mvIMPACT.acquire.PropertyS.writeBinary,
mvIMPACT.acquire.PropertyS.binaryDataBufferSize,
mvIMPACT.acquire.PropertyS.binaryDataBufferMaxSize
- Returns
- The binary data representation of the specified property value as a new std.string object.
- Parameters
-
| index | [in] The index of the value to get(if this property holds more than one value). |
| boLegacyMode | [in] If set to true this allows applications compiled with Impact Acquire 2.32.0 or greater using this function to run on systems with Impact Acquire smaller than 2.32.0. The legacy version of this function runs slower! |
OVERLOAD 2: Reads a value stored in the property as binary data.
Binary data can only be stored in string properties. When writing binary data to a string property it's stored in Base64 format internally. The Base64 algorithm converts arbitrary data into a read and printable string representation. As a result of this 3 bytes of arbitrary binary data will occupy 4 bytes of memory.
Reading binary data with this function obviously only makes sense if the property has been assigned the value by a previous call to mvIMPACT.acquire.PropertyS.writeBinary (here you find a small code example as well). However using this method any kind of data can be stored by a string property. This can e.g. be interesting when certain data shall be stored in the user accessible part of the devices non-volatile memory.
- See also
- mvIMPACT.acquire.PropertyS.writeBinary,
mvIMPACT.acquire.PropertyS.binaryDataBufferSize,
mvIMPACT.acquire.PropertyS.binaryDataBufferMaxSize
- Parameters
-
| pBuf | [in] A pointer to a piece of memory that shall receive the binary data stored by the this property. |
| bufSize | [in] The size of the buffer pointed to by pBuf in bytes. |
| index | [in] The index of the value to get(if this property holds more than one value). |
| boLegacyMode | [in] If set to true this allows applications compiled with Impact Acquire 2.32.0 or greater using this function to run on systems with Impact Acquire smaller than 2.32.0. The legacy version of this function runs slower! |
OVERLOAD 3: Reads a value stored in the property as binary data.
Binary data can only be stored in string properties. When writing binary data to a string property it's stored in Base64 format internally. The Base64 algorithm converts arbitrary data into a read and printable string representation. As a result of this 3 bytes of arbitrary binary data will occupy 4 bytes of memory.
Reading binary data with this function obviously only makes sense if the property has been assigned the value by a previous call to mvIMPACT.acquire.PropertyS.writeBinary (here you find a small code example as well). However using this method any kind of data can be stored by a string property. This can e.g. be interesting when certain data shall be stored in the user accessible part of the devices non-volatile memory.
- See also
- mvIMPACT.acquire.PropertyS.writeBinary,
mvIMPACT.acquire.PropertyS.binaryDataBufferSize,
mvIMPACT.acquire.PropertyS.binaryDataBufferMaxSize
- Parameters
-
| pBuf | [in] A pointer to a piece of memory that shall receive the binary data stored by the this property. |
| bufSize | [in] The size of the buffer pointed to by pBuf in bytes. |
| index | [in] The index of the value to get(if this property holds more than one value). |
| boLegacyMode | [in] If set to true this allows applications compiled with Impact Acquire 2.32.0 or greater using this function to run on systems with Impact Acquire smaller than 2.32.0. The legacy version of this function runs slower! |
OVERLOAD 4: Reads a value stored in the property as binary data.
Binary data can only be stored in string properties. When writing binary data to a string property it's stored in Base64 format internally. The Base64 algorithm converts arbitrary data into a read and printable string representation. As a result of this 3 bytes of arbitrary binary data will occupy 4 bytes of memory.
Reading binary data with this function obviously only makes sense if the property has been assigned the value by a previous call to mvIMPACT.acquire.PropertyS.writeBinary (here you find a small code example as well). However using this method any kind of data can be stored by a string property. This can e.g. be interesting when certain data shall be stored in the user accessible part of the devices non-volatile memory.
- See also
- mvIMPACT.acquire.PropertyS.writeBinary,
mvIMPACT.acquire.PropertyS.binaryDataBufferSize,
mvIMPACT.acquire.PropertyS.binaryDataBufferMaxSize
- Parameters
-
| pBuf | [in] A pointer to a piece of memory that shall receive the binary data stored by the this property. |
| bufSize | [in] The size of the buffer pointed to by pBuf in bytes. |
| index | [in] The index of the value to get(if this property holds more than one value). |
| boLegacyMode | [in] If set to true this allows applications compiled with Impact Acquire 2.32.0 or greater using this function to run on systems with Impact Acquire smaller than 2.32.0. The legacy version of this function runs slower! |
| writeBinary |
( |
| self, |
|
|
* | args ) |
Writes a block of binary data to one entry of the property.
OVERLOAD 1:
Binary data can only be stored in string properties. When writing binary data to a string property it's stored in Base64 format internally. The Base64 algorithm converts arbitrary data into a read and printable string representation. As a result of this 3 bytes of arbitrary binary data will occupy 4 bytes of memory.
By writing binary data with this function arbitrary data can be stored by a string property. This can e.g. be interesting when certain data shall be stored in the user accessible part of the devices non-volatile memory.
See Reading/Writing Binary Data To A Property also
binData = b'\x00\xFF\x80\x33'
binaryProp = acquire.PropertyS(getHandleFromSomewhere())
binaryProp.writeBinary(binData)
To find out if a property contains binary data check if mvIMPACT.acquire.cfContainsBinaryData is set e.g. by calling
binaryProp = acquire.PropertyS(getHandleFromSomewhere())
if pseudoBinaryProp.flags() & acquire.cfContainsBinaryData:
Performance considerations:
Impact Acquire 2.15.0 and newer:
- Base64 encoding/decoding only is performed when read string data previously written as binary data and vice versa.
- encoding/decoding only is performed if the 2 internal caches are out of sync. so only on the first read access using the other format.
- this version is more efficient compared to previous implementations.
Impact Acquire versions smaller than 2.15.0
- Base64 encoding/decoding always is performed when reading/writing data in binary format.
- Note
- When a property stores binary data that came from a GenICam chunk buffer additional copy operations from the GenApi runtime will take place. This can be considered as an additional copy operation into the application binary buffer. So binary chunk data should be avoided if possible!
- See also
- mvIMPACT.acquire.PropertyS.readBinary,
mvIMPACT.acquire.PropertyS.binaryDataBufferSize,
mvIMPACT.acquire.PropertyS.binaryDataBufferMaxSize
- Parameters
-
| value | [in] A const reference to the string holding the binary data that shall be stored by the this property. |
| index | [in] The index defining at which position to write the value. |
OVERLOAD 2: Writes a block of binary data to one entry of the property.
Binary data can only be stored in string properties. When writing binary data to a string property it's stored in Base64 format internally. The Base64 algorithm converts arbitrary data into a read and printable string representation. As a result of this 3 bytes of arbitrary binary data will occupy 4 bytes of memory.
By writing binary data with this function arbitrary data can be stored by a string property. This can e.g. be interesting when certain data shall be stored in the user accessible part of the devices non-volatile memory.
To find out if a property contains binary data check if mvIMPACT.acquire.cfContainsBinaryData is set e.g. by calling
Performance considerations:
Impact Acquire 2.15.0 and newer:
- Base64 encoding/decoding only is performed when read string data previously written as binary data and vice versa.
- encoding/decoding only is performed if the 2 internal caches are out of sync. so only on the first read access using the other format.
- this version is more efficient compared to previous implementations.
Impact Acquire versions smaller than 2.15.0
- Base64 encoding/decoding always is performed when reading/writing data in binary format.
- Note
- When a property stores binary data that came from a GenICam chunk buffer additional copy operations from the GenApi runtime will take place. This can be considered as an additional copy operation into the application binary buffer. So binary chunk data should be avoided if possible!
- See also
- mvIMPACT.acquire.PropertyS.readBinary,
mvIMPACT.acquire.PropertyS.binaryDataBufferSize,
mvIMPACT.acquire.PropertyS.binaryDataBufferMaxSize
- Parameters
-
| pBuf | [in] A const pointer to a piece of memory holding the binary data that shall be stored by the this property. |
| bufSize | [in] The size of the buffer pointed to by pBuf in bytes. |
| index | [in] The index defining at which position to write the value. |
OVERLOAD 3: Writes a block of binary data to one entry of the property.
Binary data can only be stored in string properties. When writing binary data to a string property it's stored in Base64 format internally. The Base64 algorithm converts arbitrary data into a read and printable string representation. As a result of this 3 bytes of arbitrary binary data will occupy 4 bytes of memory.
By writing binary data with this function arbitrary data can be stored by a string property. This can e.g. be interesting when certain data shall be stored in the user accessible part of the devices non-volatile memory.
To find out if a property contains binary data check if mvIMPACT.acquire.cfContainsBinaryData is set e.g. by calling
Performance considerations:
Impact Acquire 2.15.0 and newer:
- Base64 encoding/decoding only is performed when read string data previously written as binary data and vice versa.
- encoding/decoding only is performed if the 2 internal caches are out of sync. so only on the first read access using the other format.
- this version is more efficient compared to previous implementations.
Impact Acquire versions smaller than 2.15.0
- Base64 encoding/decoding always is performed when reading/writing data in binary format.
- Note
- When a property stores binary data that came from a GenICam chunk buffer additional copy operations from the GenApi runtime will take place. This can be considered as an additional copy operation into the application binary buffer. So binary chunk data should be avoided if possible!
- See also
- mvIMPACT.acquire.PropertyS.readBinary,
mvIMPACT.acquire.PropertyS.binaryDataBufferSize,
mvIMPACT.acquire.PropertyS.binaryDataBufferMaxSize
- Parameters
-
| pBuf | [in] A const pointer to a piece of memory holding the binary data that shall be stored by the this property. |
| bufSize | [in] The size of the buffer pointed to by pBuf in bytes. |
| index | [in] The index defining at which position to write the value. |
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 |
3.7.0