PropertyILUTMapping Class Reference

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

Inheritance diagram for PropertyILUTMapping:

Public Member Functions
	__init__ (self, *args)
	Constructs a new unbound mvIMPACT.acquire.PropertyI object.
	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.
	read (self, *args)
	Reads a value from a property.
	write (self, *args)
	Writes one value to the property.

Properties
	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

Reimplemented from Property.

Member Function Documentation

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

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.

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.

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.

Property Documentation

thisown

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

static