PropertyPtr Class Reference

A class to represent pointer properties. More...

Inheritance diagram for PropertyPtr:

Public Member Functions
	__init__ (self, *args)
	Constructs a new unbound mvIMPACT.acquire.PropertyPtr object.
	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 class to represent pointer properties.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args )

Constructs a new unbound mvIMPACT.acquire.PropertyPtr object.

OVERLOAD 1:

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

Parameters

hProp

[in] A valid handle to a pointer property

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

Parameters

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

Reimplemented from Property.

Member Function Documentation

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.

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.

Property Documentation

thisown

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

static