Impact Acquire SDK .NET
Public Member Functions | Static Public Member Functions | Properties | List of all members
PropertyI Class Reference
Common

Provided for convenience only. This type represents a standard 32-bit integer property type. More...

Inheritance diagram for PropertyI:
[legend]

Public Member Functions

EnumPropertyI< T > getTranslationDict (List< KeyValuePair< String, T > > sequence)
 This function queries the property's translation table.
 
String getTranslationDictString ()
 This function reads a single translation table string entry from a property.
 
String getTranslationDictString (int index)
 This function reads a single translation table string entry from a property.
 
EnumPropertyI< T > getTranslationDictStrings (List< String > sequence)
 This function queries a list of valid strings for this property.
 
T getTranslationDictValue ()
 This function reads a single translation table value entry from a property.
 
T getTranslationDictValue (int index)
 This function reads a single translation table value entry from a property.
 
EnumPropertyI< T > getTranslationDictValues (List< T > sequence)
 This function queries a list of valid values for this property.
 
 PropertyI ()
 Constructs a new unbound mv.impact.acquire.PropertyI object.
 
 PropertyI (int hProp)
 Constructs a new mv.impact.acquire.PropertyI object.
 
T read ()
 Reads a value from a property.
 
T read (int index)
 Reads a value from a property.
 
int[] read (int start, int end)
 Reads a set of values from a property.
 
void read (List< T > sequence)
 Reads a set of values from a property.
 
void read (List< T > sequence, int start)
 Reads a set of values from a property.
 
void read (List< T > sequence, int start, int end)
 Reads a set of values from a property.
 
EnumPropertyI< T > write (int[] values)
 Writes a set of values to the property.
 
EnumPropertyI< T > write (int[] values, int start)
 Writes a set of values to the property.
 
EnumPropertyI< T > write (List< T > sequence)
 Writes a set of values to the property.
 
EnumPropertyI< T > write (List< T > sequence, int start)
 Writes a set of values to the property.
 
EnumPropertyI< T > write (T value)
 Writes one value to the property.
 
EnumPropertyI< T > write (T value, int index)
 Writes one value to the property.
 

Static Public Member Functions

static implicit operator T (EnumPropertyI< T > prop)
 Allows a direct cast of the property object to its underlying value type.
 
static int operator+ (PropertyI a, PropertyI b)
 Adds the values stored at index 0 of 2 32-bit integer properties and returns the result.
 

Properties

ReadOnlyCollection< String > listOfValidStrings [get]
 Returns a list of valid strings for this property.
 
ReadOnlyCollection< T > listOfValidValues [get]
 Returns a list of valid values for this property.
 
T maxValue [get]
 Reads the maximum value from a property.
 
T minValue [get]
 Reads the minimum value from a property.
 
T stepWidth [get]
 Reads the step width from a property.
 

Detailed Description

Provided for convenience only. This type represents a standard 32-bit integer property type.

Constructor & Destructor Documentation

◆ PropertyI() [1/2]

PropertyI ( int hProp)
inline

Constructs a new mv.impact.acquire.PropertyI object.

Parameters
[in]hPropA valid handle to a 32-bit integer property

◆ PropertyI() [2/2]

PropertyI ( )
inline

Constructs a new unbound mv.impact.acquire.PropertyI object.

Member Function Documentation

◆ getTranslationDict()

EnumPropertyI< T > getTranslationDict ( List< KeyValuePair< String, T > > sequence)
inlineinherited

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 mv.impact.acquire.EnumPropertyI<T>.getTranslationDictString and mv.impact.acquire.EnumPropertyI<T>.getTranslationDictValue multiple times and therefore this function should be called whenever all entries are required.
Returns
A const reference to the calling property.
Parameters
[out]sequenceA reference to a container which will receive the data from the properties translation dictionary.

◆ getTranslationDictString() [1/2]

String getTranslationDictString ( )
inlineinherited

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.

◆ getTranslationDictString() [2/2]

String getTranslationDictString ( int index)
inlineinherited

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
[in]indexThe index of the entry to read from the property.

◆ getTranslationDictStrings()

EnumPropertyI< T > getTranslationDictStrings ( List< String > sequence)
inlineinherited

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 mv.impact.acquire.EnumPropertyI<T>.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
[out]sequenceA reference to a container to store the data read from the property into.

◆ getTranslationDictValue() [1/2]

T getTranslationDictValue ( )
inlineinherited

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
mv.impact.acquire.EnumPropertyI<T>.getTranslationDictValues to query all valid values efficiently in a single call.

◆ getTranslationDictValue() [2/2]

T getTranslationDictValue ( int index)
inlineinherited

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
mv.impact.acquire.EnumPropertyI<T>.getTranslationDictValues to query all valid values efficiently in a single call.
Parameters
[in]indexThe index of the entry to read from the property.

◆ getTranslationDictValues()

EnumPropertyI< T > getTranslationDictValues ( List< T > sequence)
inlineinherited

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 mv.impact.acquire.EnumPropertyI<T>.getTranslationDictValue multiple times and therefore this function should be called whenever all entries are required.
Returns
A const reference to the calling property.
Parameters
[out]sequenceA reference to a container to store the data read from the property into.

◆ operator T()

static implicit operator T ( EnumPropertyI< T > prop)
inlinestaticinherited

Allows a direct cast of the property object to its underlying value type.

This is the same as calling mv.impact.acquire.EnumPropertyI<T>.read with index 0.

Returns
The properties value at index 0.

◆ operator+()

static int operator+ ( PropertyI a,
PropertyI b )
inlinestatic

Adds the values stored at index 0 of 2 32-bit integer properties and returns the result.

◆ read() [1/6]

T read ( )
inlineinherited

Reads a value from a property.

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

Returns
The value stored at index within the property.
Examples
CaptureToUserMemory.cs, ContinuousCapture.cs, ContinuousCaptureAllDevices.cs, ContinuousCaptureSimple.cs, ContinuousSaveImage.cs, GenICamCallbackOnEvent.cs, GenICamCommonSettingsUsage.cs, GenICamInterfaceLayout.cs, Properties.cs, SingleCapture.cs, and SingleCaptureStorage.cs.

◆ read() [2/6]

T read ( int index)
inlineinherited

Reads a value from a property.

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

Returns
The value stored at index within the property.
Parameters
[in]indexThe index of the value to read from the property.

◆ read() [3/6]

int[] read ( int start,
int end )
inlineinherited

Reads a set of values from a property.

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

Returns
A set of values read from the propery.
Parameters
[in]startThe index from where to start reading values from the property.
[in]endThe index where to stop reading values from the property.

◆ read() [4/6]

void read ( List< T > sequence)
inlineinherited

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
[out]sequenceA reference to a container to store the data read from the property into.

◆ read() [5/6]

void read ( List< T > sequence,
int start )
inlineinherited

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
[out]sequenceA reference to a container to store the data read from the property into.
[in]startThe index from where to start reading values from the property.

◆ read() [6/6]

void read ( List< T > sequence,
int start,
int end )
inlineinherited

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
[out]sequenceA reference to a container to store the data read from the property into.
[in]startThe index from where to start reading values from the property.
[in]endThe index where to stop reading values from the property.

◆ write() [1/6]

EnumPropertyI< T > write ( int[] values)
inlineinherited

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
[in]valuesAn array containing the values to write to the property.

◆ write() [2/6]

EnumPropertyI< T > write ( int[] values,
int start )
inlineinherited

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
[in]valuesAn array containing the values to write to the property.
[in]startThe index where to write the first value to the property.

◆ write() [3/6]

EnumPropertyI< T > write ( List< T > sequence)
inlineinherited

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
[in]sequenceAn array containing the values to write to the property.

◆ write() [4/6]

EnumPropertyI< T > write ( List< T > sequence,
int start )
inlineinherited

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
[in]sequenceAn array containing the values to write to the property.
[in]startThe index where to write the first value to the property.

◆ write() [5/6]

EnumPropertyI< T > write ( T value)
inlineinherited

Writes one value to the property.

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

Returns
A const 'self' reference
Parameters
[in]valueThe value to write to the property.
Examples
CaptureToUserMemory.cs, and ContinuousSaveImage.cs.

◆ write() [6/6]

EnumPropertyI< T > write ( T value,
int index )
inlineinherited

Writes one value to the property.

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

Returns
A const 'self' reference
Parameters
[in]valueThe value to write to the property.
[in]indexThe index defining at which position to write the value.

Property Documentation

◆ listOfValidStrings

ReadOnlyCollection<String> listOfValidStrings
getinherited

Returns a list of valid strings for this property.

If this property does not define a translation dictionary an exception will be thrown.

Since
2.5.0

◆ listOfValidValues

ReadOnlyCollection<T> listOfValidValues
getinherited

Returns a list of valid values for this property.

If this property does not define a translation dictionary an exception will be thrown.

◆ maxValue

T maxValue
getinherited

Reads the maximum value from a property.

Note
To find out if the property defines a maximum value mv.impact.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

◆ minValue

T minValue
getinherited

Reads the minimum value from a property.

Note
To find out if the property defines a minimum value mv.impact.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

◆ stepWidth

T stepWidth
getinherited

Reads the step width from a property.

Note
To find out if the property defines a step width mv.impact.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