Impact Acquire SDK Java
Property Class Reference

A base class for properties. More...

Inheritance diagram for Property:
[legend]

Public Member Functions

boolean allowsValueCombinations ()
 Checks if this enumerated property allows the combination of enum values.
 
long changedCounter ()
 Returns the current changed counter for the component referenced by this object.
 
long changedCounterAttr ()
 Returns the current attribute changed counter for the component referenced by this object.
 
synchronized void delete ()
 
long dictSize ()
 Returns the size of the properties translation dictionary.
 
String displayName ()
 Returns the display name of the component referenced by this object.
 
String docString ()
 Returns a string containing general information about the component referenced by this object.
 
Component firstChild ()
 Moves to the first child of this component(moves down one level).
 
Component firstSibling ()
 Moves to the first sibling(the first feature in the current list of features).
 
int flags ()
 Returns the flags associated with this component.
 
String flagsAsString ()
 Returns the flags associated with this component as a string.
 
String flagsAsString (String separator)
 Returns the flags associated with this component as a string.
 
boolean hasDict ()
 Returns whether this property defines a translation dictionary or not.
 
boolean hasMaxValue ()
 Checks if a maximum value is defined for this property.
 
boolean hasMinValue ()
 Checks if a minimum value is defined for this property.
 
boolean hasStepWidth ()
 Checks if a step width is defined for this property.
 
int hObj ()
 Returns a unique identifier for the component referenced by this object.
 
boolean isDefault ()
 Checks if this component is currently referencing the default for this component.
 
boolean isList ()
 Checks if this component is of type mvIMPACT.acquire.ComponentList.
 
boolean isMeth ()
 Checks if this component is of type mvIMPACT.acquire.Method.
 
boolean isProp ()
 Checks if this component is of type mvIMPACT.acquire.Property or a derived type.
 
boolean isValid ()
 Checks if the internal component referenced by this object is still valid.
 
boolean isVisible ()
 Checks if the component is currently shadowed due to a settings made elsewhere or not.
 
boolean isWriteable ()
 Checks if the caller has write/modify access to the component.
 
Component lastSibling ()
 Moves to the last sibling(the last feature in the current list of features).
 
long maxValCount ()
 Returns maximum number of values that can be managed by this property.
 
String name ()
 Returns the name of the component referenced by this object.
 
Component nextSibling ()
 Moves to the next sibling(the next feature in the current list of features).
 
Component parent ()
 Moves to the parent of this component(moves up one level).
 
 Property ()
 Constructs a new unbound mvIMPACT.acquire.Property object.
 
 Property (int hProp)
 Constructs a new mvIMPACT.acquire.Property object.
 
 Property (Property src)
 Constructs a new mvIMPACT.acquire.Property from an existing one.
 
String readS ()
 Reads data from this property as a string.
 
String readS (int index)
 Reads data from this property as a string.
 
String readS (int index, String format)
 Reads data from this property as a string.
 
String readSArray ()
 Reads data from this property as a string.
 
String readSArray (String format)
 Reads data from this property as a string.
 
String readSArray (String format, String delimiter)
 Reads data from this property as a string.
 
String readSArray (String format, String delimiter, int startIndex)
 Reads data from this property as a string.
 
String readSArray (String format, String delimiter, int startIndex, int endIndex)
 Reads data from this property as a string.
 
String readSArray (String format, String delimiter, int startIndex, int endIndex, int mode)
 Reads data from this property as a string.
 
Property removeValue ()
 Removes a certain value from the property's data.
 
Property removeValue (int index)
 Removes a certain value from the property's data.
 
int representation ()
 Returns the recommended representation for this component.
 
String representationAsString ()
 Returns the recommended representation of the referenced component as a string.
 
Property resizeValArray (long newSize)
 Resizes the property's data array.
 
Component restoreDefault ()
 Restores the default for the referenced component.
 
Component selectedFeature (long index)
 Retrieves a component that is selected by the current one.
 
long selectedFeatureCount ()
 Returns the number of features selected by the current one.
 
long selectedFeatures (ComponentVector v)
 Retrieves the list of components that are selected by the current one.
 
Component selectingFeature (long index)
 Retrieves a component that is selecting the current one.
 
long selectingFeatureCount ()
 Returns the number of features selecting the current one.
 
long selectingFeatures (ComponentVector v)
 Retrieves the list of components that are selecting the current one.
 
String stringFormatString ()
 Returns the internal format string this property uses to convert data to strings.
 
int type ()
 Returns the type of the referenced component.
 
String typeAsString ()
 Returns the type of the referenced component as a string.
 
long valCount ()
 Returns the current number of values managed by this property.
 
int visibility ()
 Returns the recommended visibility for this component.
 
String visibilityAsString ()
 Returns the recommended visibility of the referenced component as a string.
 
Property writeS (String value)
 Assigns a new value to this property.
 
Property writeS (String value, int index)
 Assigns a new value to this property.
 
Property writeS (StringVector sequence)
 Assigns new values to this property.
 
Property writeS (StringVector sequence, int index)
 Assigns new values to this property.
 

Static Public Member Functions

static String representationAsString (int representation)
 Returns the recommended representation converted to a string.
 
static int type (int hObj)
 Returns the type of the component referenced by hObj.
 
static String visibilityAsString (int visibility)
 Returns the recommended visibility converted to a string.
 

Protected Member Functions

void finalize ()
 
 Property (long cPtr, boolean cMemoryOwn)
 

Static Protected Member Functions

static long swigRelease (Component obj)
 
static long swigRelease (ComponentAccess obj)
 
static long swigRelease (Property obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

A base class for properties.

A property can be used to represent certain values like e.g. the input channel of a device. Depending on the way the property has been created it is either possible to read and write data to it or ( when the mvIMPACT.acquire.TComponentFlag.cfWriteAccess flag is NOT set ) just to read the data. In rare cases it might also be possible that the user is is not allowed to read the data of a property. To find out what you are allowed to do with a property or any other component the function mvIMPACT.acquire.Component.flags() can be called.

A property can contain either a single value or an array of values of the same type (e.g. 4 integer values could be used to represent a property call 'Rectangle'. It can even (if the mvIMPACT.acquire.TComponentFlag.cfFixedSize flag is not set) contain a different number of values all the time its data is queried. E.g. for a property 'searchresults' each time some function is called which writes its results to this property the property could contain a different number of integer values afterwards.

Every properties value can be read and written either as string or by it actual value type. So you can either assign the value of an integer property by using the standard 'write' function that accepts the value to be the type of the property or the function mvIMPACT.acquire.Property.writeS can be used to set the property via a string containing the new value.

PropertyI prop = new PropertyI(hObj);
prop.writeS("5"); // string assignment
prop.write(5); // integer assignment
A template class to represent 32 bit integer properties and 32 bit enumerated integer properties.
Definition PropertyI.java:17
PropertyI write(int value, int index)
Writes one value to the property.
Definition PropertyI.java:349
Property writeS(String value, int index)
Assigns a new value to this property.
Definition Property.java:753

In addition to that float and int Properties might define a translation dictionary. This cannot be done by the user, but the user can work with the dictionary afterwards. A translation dictionary is a table which maps strings to certain values (e.g. integers).

The translation dictionary serves two purposes: Once it has been defined this property can only be assigned values ( which can either be passed as a string or as the actual value ) which are contained in the translation table. Thus this makes it very easy to restrict a certain property to a fixed number of values, which can be assigned to it. Properties that have a translation dictionary will typically be defined by declaring a template instance with the type of the enumeration.

The second benefit of a translation dictionary is that certain values can be assigned a meaningful description via its translation. When a translation table has been defined either the string translation can be used to assign its value or its actual data type. A float property e.g. might define a translation table like this: 'Auto -> 0', 'auto -> 1', 'OnLowLevel -> 2'. Now to set this property to use the 'on low level' trigger mode this can be done by calling one of the 'write' functions.

PropertyI prop = getPropertyFromSomewhere();
prop.writeS("OnLowLevel"); // set value via the translation string
prop.write(TCameraTriggerMode.ctmOnLowLevel); // set value via enum type
Defines valid camera sensor trigger modes.
Definition TCameraTriggerMode.java:17
static final int ctmOnLowLevel
Start the exposure of a frame when the trigger input is below the trigger threshold.
Definition TCameraTriggerMode.java:57

This can also be extremely useful to populate combo boxes for GUI applications.

Float and int properties can also define certain constants like a max. value or a min. value. If a property does define such values it can't be assigned values which do not lie within the defined range. To find out if constants are defined The user can call the functions mvIMPACT.acquire.Property.hasMaxValue, mvIMPACT.acquire.Property.hasMinValue and mvIMPACT.acquire.Property.hasStepWidth. To query to actual value of the max, min or step width the functions getMaxValue, getMinValue and getStepWidth of the classes mvIMPACT.acquire.PropertyF, mvIMPACT.acquire.PropertyI and mvIMPACT.acquire.PropertyI64 can be called.

When reading the value of a property as a string the user can define a format string telling the property module how to format the returned string. This works pretty much like when working e.g. with the printf function.

Constructor & Destructor Documentation

◆ Property() [1/4]

Property ( long  cPtr,
boolean  cMemoryOwn 
)
protected

◆ Property() [2/4]

Property ( )

Constructs a new unbound mvIMPACT.acquire.Property object.

Properties constructed this way can't be used for anything unless they are bound to a internal driver property with a mvIMPACT.acquire.ComponentLocator object.

◆ Property() [3/4]

Property ( int  hProp)

Constructs a new mvIMPACT.acquire.Property object.

Properties successfully constructed this way can be worked with directly. If hObj does not reference an internal driver property a mvIMPACT.acquire.ENotAProperty exception will be thrown.

Parameters
hProp[in] A valid handle to a property

◆ Property() [4/4]

Property ( Property  src)

Constructs a new mvIMPACT.acquire.Property from an existing one.

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

Member Function Documentation

◆ allowsValueCombinations()

boolean allowsValueCombinations ( )

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:

ip.getMirrorMode().write( TMirrorMode.mmTopDown | TMirrorMode.mmLeftRight );
Base class for image processing related properties.
Definition ImageProcessing.java:17
Defines valid mirror modes.
Definition TMirrorMode.java:17
static final int mmTopDown
The resulting image will be flipped around a horizontal axis.
Definition TMirrorMode.java:21
static final int mmLeftRight
The resulting image will be flipped around a vertical axis.
Definition TMirrorMode.java:23
Returns
  • true if this property allows the combination of enum values.
  • false otherwise.

◆ changedCounter()

long changedCounter ( )
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.

import mvIMPACT.acquire.*;
//-----------------------------------------------------------------------------
public class ComponentRef
//-----------------------------------------------------------------------------
{
private Component c_;
private long lastChangedCount_;
public ComponentRef( Component c ) : c_( c ), lastChangedCount_( 0 ) {}
public Component getComponent()
{
return c_;
}
public long getLastChangedCounter()
{
return lastChangedCount_;
}
public void setLastChangedCounter( long changedCounter )
{
lastChangedCount_ = lastChangedCount;
}
}
// ...more code, class definition etc.
//-----------------------------------------------------------------------------
public static void fn( ComponentRef cr )
//-----------------------------------------------------------------------------
{
if( cr.c_.isValid() )
{
final long currentChangedCount = cr.getComponent().changedCounter();
if( currentChangedCount != cr.getLastChangedCounter() )
{
// something has happened since the last check!
doWhatNeedsToBeDone();
// and remember the current changed counter
cr.setLastChangedCounter( currentChangedCount );
}
}
}
A base class to implement access to internal driver components.
Definition Component.java:223
Returns
The current changed counter of this object.

◆ changedCounterAttr()

long changedCounterAttr ( )
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.

◆ delete()

synchronized void delete ( )

Reimplemented from Component.

Reimplemented in PropertyF, PropertyI, PropertyI64, PropertyPtr, and PropertyS.

◆ dictSize()

long dictSize ( )

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

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

String docString ( )
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.

◆ finalize()

void finalize ( )
protected

Reimplemented from Component.

Reimplemented in PropertyF, PropertyI, PropertyI64, PropertyPtr, and PropertyS.

◆ firstChild()

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

Component firstSibling ( )
inherited

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

Returns
A new mvIMPACT.acquire.Component object

◆ flags()

int flags ( )
inherited

Returns the flags associated with this component.

Returns
The flags associated with this component.

◆ flagsAsString() [1/2]

String flagsAsString ( )
inherited

Returns the flags associated with this component as a string.

Returns
The flags associated with this component as a string.

◆ flagsAsString() [2/2]

String flagsAsString ( String  separator)
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'

◆ hasDict()

boolean hasDict ( )

Returns whether this property defines a translation dictionary or not.

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

◆ hasMaxValue()

boolean hasMaxValue ( )

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

◆ hasMinValue()

boolean hasMinValue ( )

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

◆ hasStepWidth()

boolean hasStepWidth ( )

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

◆ hObj()

int hObj ( )
inherited

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

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

◆ isDefault()

boolean isDefault ( )
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.

◆ isList()

boolean isList ( )
inherited

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

Returns
  • true if the component references a list
  • false otherwise

◆ isMeth()

boolean isMeth ( )
inherited

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

Returns
  • true if the component references a method
  • false otherwise

◆ isProp()

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

◆ isValid()

boolean isValid ( )
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.

◆ isVisible()

boolean isVisible ( )
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.TComponentFlag.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.

◆ isWriteable()

boolean isWriteable ( )
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.

◆ lastSibling()

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

long maxValCount ( )

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

String name ( )
inherited

Returns the name of the component referenced by this object.

Returns
The name of the component referenced by this object.

◆ nextSibling()

Component nextSibling ( )
inherited

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

Returns
A new mvIMPACT.acquire.Component object

◆ parent()

Component parent ( )
inherited

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

Returns
A new mvIMPACT.acquire.Component object

◆ readS() [1/3]

String readS ( )

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.

◆ readS() [2/3]

String readS ( int  index)

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)

◆ readS() [3/3]

String readS ( int  index,
String  format 
)

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() [1/6]

String readSArray ( )

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 );
String s = p.readSArray( "%d", "&&:", 1 );
// now s should contain '2&&:666'
s = p.readSArray( "%4d", " ", 0, 1 );
// now s should contain ' 1, 2'
String readSArray(String format, String delimiter, int startIndex, int endIndex, int mode)
Reads data from this property as a string.
Definition Property.java:375
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.

the data. from startIndex to the last value stored by the property will be returned. When the LSB is set, the translation dictionary (if defined) will be ignored for this call.

◆ readSArray() [2/6]

String readSArray ( String  format)

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 );
String 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 the data. from startIndex to the last value stored by the property will be returned. When the LSB is set, the translation dictionary (if defined) will be ignored for this call.

◆ readSArray() [3/6]

String readSArray ( String  format,
String  delimiter 
)

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 );
String 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. from startIndex to the last value stored by the property will be returned. When the LSB is set, the translation dictionary (if defined) will be ignored for this call.

◆ readSArray() [4/6]

String readSArray ( String  format,
String  delimiter,
int  startIndex 
)

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 );
String 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 from startIndex to the last value stored by the property will be returned. When the LSB is set, the translation dictionary (if defined) will be ignored for this call.

◆ readSArray() [5/6]

String readSArray ( String  format,
String  delimiter,
int  startIndex,
int  endIndex 
)

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 );
String 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. When the LSB is set, the translation dictionary (if defined) will be ignored for this call.

◆ readSArray() [6/6]

String readSArray ( String  format,
String  delimiter,
int  startIndex,
int  endIndex,
int  mode 
)

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 );
String 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() [1/2]

Property removeValue ( )

Removes a certain value from the property's data.

Returns
A const reference to the calling property.

◆ removeValue() [2/2]

Property removeValue ( int  index)

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

int representation ( )
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 are defined by the enumeration mvIMPACT.acquire.TComponentRepresentation.

Since
2.14.0
Returns
The recommended representation for this component.

◆ representationAsString() [1/2]

String representationAsString ( )
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.

◆ representationAsString() [2/2]

static String representationAsString ( int  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

◆ resizeValArray()

Property resizeValArray ( long  newSize)

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

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

Component selectedFeature ( long  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()

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

long selectedFeatures ( ComponentVector  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()

Component selectingFeature ( long  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()

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

long selectingFeatures ( ComponentVector  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()

String stringFormatString ( )

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.

◆ swigRelease() [1/3]

static long swigRelease ( Component  obj)
staticprotectedinherited

◆ swigRelease() [2/3]

static long swigRelease ( ComponentAccess  obj)
staticprotectedinherited

◆ swigRelease() [3/3]

static long swigRelease ( Property  obj)
staticprotected

◆ type() [1/2]

int type ( )
inherited

Returns the type of the referenced component.

Returns
The type of the referenced component.

◆ type() [2/2]

static int type ( int  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

◆ typeAsString()

String typeAsString ( )
inherited

Returns the type of the referenced component as a string.

Returns
The type of the referenced component as a string.

◆ valCount()

long valCount ( )

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

int visibility ( )
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 are defined by the enumeration mvIMPACT.acquire.TComponentVisibility.

Returns
The recommended visibility for this component.

◆ visibilityAsString() [1/2]

String visibilityAsString ( )
inherited

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

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

◆ visibilityAsString() [2/2]

static String visibilityAsString ( int  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

◆ writeS() [1/4]

Property writeS ( String  value)

Assigns a new value to this property.

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.TComponentFlag.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.

◆ writeS() [2/4]

Property writeS ( String  value,
int  index 
)

Assigns a new value to this property.

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.TComponentFlag.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

◆ writeS() [3/4]

Property writeS ( StringVector  sequence)

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.TComponentFlag.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

◆ writeS() [4/4]

Property writeS ( StringVector  sequence,
int  index 
)

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.TComponentFlag.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

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited