A class to represent string properties. More...

Inheritance diagram for PropertyS:

Public Member Functions
uint	binaryDataBufferSize ()
	Returns the size(in bytes) needed for the binary representation of the string buffer.

uint	binaryDataBufferSize (int index)
	Returns the size(in bytes) needed for the binary representation of the string buffer.

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.

	PropertyS ()
	Constructs a new unbound mv.impact.acquire.PropertyS object.

	PropertyS (int hProp)
	Constructs a new mv.impact.acquire.PropertyS object.

String	read ()
	Reads a value from a property.

String	read (int index)
	Reads a value from a property.

void	read (List< String > sequence)
	Reads a set of values from a property.

void	read (List< String > sequence, int start)
	Reads a set of values from a property.

void	read (List< String > sequence, int start, int end)
	Reads a set of values from a property.

byte[]	readBinary ()
	Reads a value stored in the property as binary data.

byte[]	readBinary (int index)
	Reads a value stored in the property as binary data.

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	readS (TPropertyLimits limit)
	Reads a defined limit 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.

String	representationAsString ()
	Returns the recommended representation of the referenced component as a string.

Property	resizeValArray (uint newSize)
	Resizes the property's data array.

Component	restoreDefault ()
	Restores the default for the referenced component.

Component	selectedFeature (int index)
	Retrieves a component that is selected by the current one.

Component	selectingFeature (int index)
	Retrieves a component that is selecting the current one.

override String	ToString ()
	Reads data from this property as a string.

String	visibilityAsString ()
	Returns the recommended visibility of the referenced component as a string.

PropertyS	write (List< String > sequence)
	Writes a set of values to the property.

PropertyS	write (List< String > sequence, int start)
	Writes a set of values to the property.

PropertyS	write (String value)
	Writes one value to the property.

PropertyS	write (String value, int index)
	Writes one value to the property.

PropertyS	writeBinary (byte[] pBuf)
	Writes a block of binary data to one entry of the property.

PropertyS	writeBinary (byte[] pBuf, int index)
	Writes a block of binary data to one entry of the property.

Property	writeS (List< String > sequence)
	Assigns new values to this property.

Property	writeS (List< String > sequence, int index)
	Assigns new values to this property.

Property	writeS (String value)
	Assigns a new value to this property.

Property	writeS (String value, int index)
	Assigns a new value to this property.

Static Public Member Functions
static Component	factory (int hObj)
	Creates a new Component from a valid handle.

static Component	operator++ (Component ci)
	Moves to the next sibling of the current mv.impact.acquire.Component instance.

static String	representationAsString (TComponentRepresentation representation)
	Returns the recommended representation converted to a string.

static String	visibilityAsString (TComponentVisibility visibility)
	Returns the recommended visibility converted to a string.

Properties
bool	allowsValueCombinations `[get]`
	Checks if this enumerated property allows the combination of enum values.

uint	binaryDataBufferMaxSize `[get]`
	Reads the max size(in bytes) of binary data this property can store.

uint	changedCounter `[get]`
	Returns the current changed counter for the component referenced by this object.

uint	changedCounterAttr `[get]`
	Returns the current attribute changed counter for the component referenced by this object.

int	dictSize `[get]`
	Returns the size of the properties translation dictionary.

String	displayName `[get]`
	Returns the display name of the component referenced by this object.

String	docString `[get]`
	Returns a string containing general information about the component referenced by this object.

Component	firstChild `[get]`
	Moves to the first child of this component(moves down one level).

Component	firstSibling `[get]`
	Moves to the first sibling(the first feature in the current list of features).

TComponentFlag	flags `[get]`
	Returns the flags associated with this component.

bool	hasDict `[get]`
	Returns whether this property defines a translation dictionary or not.

bool	hasMaxValue `[get]`
	Checks if a maximum value is defined for this property.

bool	hasMinValue `[get]`
	Checks if a minimum value is defined for this property.

bool	hasStepWidth `[get]`
	Checks if a step width is defined for this property.

int	hObj `[get]`
	Returns a unique identifier for the component referenced by this object.

bool	isDefault `[get]`
	Checks if this component is currently referencing the default for this component.

bool	isList `[get]`
	Checks if this component is of type mv.impact.acquire.ComponentList.

bool	isMeth `[get]`
	Checks if this component is of type mv.impact.acquire.Method.

bool	isProp `[get]`
	Checks if this component is of type mv.impact.acquire.Property or a derived type.

bool	isValid `[get]`
	Checks if the internal component referenced by this object is still valid.

bool	isVisible `[get]`
	Checks if the component is currently shadowed due to a settings made elsewhere or not.

bool	isWriteable `[get]`
	Checks if the caller has write/modify access to the component.

Component	lastSibling `[get]`
	Moves to the last sibling(the last feature in the current list of features).

uint	maxValCount `[get]`
	Returns maximum number of values that can be managed by this property.

String	name `[get]`
	Returns the name of the component referenced by this object.

Component	nextSibling `[get]`
	Moves to the next sibling(the next feature in the current list of features).

Component	parent `[get]`
	Moves to the parent of this component(moves up one level).

TComponentRepresentation	representation `[get]`
	Returns the recommended representation for this component.

uint	selectedFeatureCount `[get]`
	Returns the number of features selected by the current one.

ReadOnlyCollection< Component >	selectedFeatures `[get]`
	Retrieves the list of components that are selected by the current one.

uint	selectingFeatureCount `[get]`
	Returns the number of features selecting the current one.

ReadOnlyCollection< Component >	selectingFeatures `[get]`
	Retrieves the list of components that are selecting the current one.

String	stringFormatString `[get]`
	Returns the internal format string this property uses to convert data to strings.

char	this[int index] `[get]`
	Reads a value from a property.

TComponentType	type `[get]`
	Returns the type of the component referenced by hObj.

String	typeAsString `[get]`
	Returns the type of the referenced component as a string.

uint	valCount `[get]`
	Returns the current number of values managed by this property.

TComponentVisibility	visibility `[get]`
	Returns the recommended visibility for this component.

Detailed Description

A class to represent string properties.

Constructor & Destructor Documentation

◆ PropertyS() [1/2]

PropertyS ( int hProp )

inline

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

Parameters

[in] hProp A valid handle to the string property

◆ PropertyS() [2/2]

PropertyS ( )

inline

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

Member Function Documentation

◆ binaryDataBufferSize() [1/2]

uint binaryDataBufferSize ( )

inline

Returns the size(in bytes) needed for the binary representation of the string buffer.

When binary data has been stored in a string property it has been stored in Base64 format internally. If the user wants to know the length of the binary data in decoded format, this function can be called.

See also: mv.impact.acquire.PropertyS.readBinary,
mv.impact.acquire.PropertyS.writeBinary,
mv.impact.acquire.PropertyS.binaryDataBufferMaxSize

Returns: The size(in bytes) needed for the binary representation of the string buffer.

◆ binaryDataBufferSize() [2/2]

uint binaryDataBufferSize ( int index )

inline

Returns the size(in bytes) needed for the binary representation of the string buffer.

When binary data has been stored in a string property it has been stored in Base64 format internally. If the user wants to know the length of the binary data in decoded format, this function can be called.

See also: mv.impact.acquire.PropertyS.readBinary,
mv.impact.acquire.PropertyS.writeBinary,
mv.impact.acquire.PropertyS.binaryDataBufferMaxSize

Returns: The size(in bytes) needed for the binary representation of the string buffer.

Parameters

[in] index The index of the value for which to query the buffer size(if this property holds more than one value).

◆ factory()

static Component factory ( int hObj )

inlinestaticinherited

Creates a new Component from a valid handle.

Returns: a new mv.impact.acquire.Component instance that can be casted to a matching type. Call mv.impact.acquire.Component.type to find out the correct type to use.

Parameters

[in] hObj A valid handle to a component.

◆ flagsAsString() [1/2]

String flagsAsString ( )

inlineinherited

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 )

inlineinherited

Returns the flags associated with this component as a string.

Returns: The flags associated with this component as a string.

Parameters

[in] separator 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'

◆ operator++()

static Component operator++ ( Component ci )

inlinestaticinherited

Moves to the next sibling of the current mv.impact.acquire.Component instance.

This does the same as calling mv.impact.acquire.Component.nextSibling.

Returns: A new mv.impact.acquire.Component instance pointing to the next sibling of the current one.

Parameters

[in] ci A valid component.

◆ read() [1/5]

String read ( )

inline

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, GenICamCallbackOnEvent.cs, GenICamCommonSettingsUsage.cs, GenICamInterfaceLayout.cs, Properties.cs, SingleCapture.cs, and SingleCaptureStorage.cs.

◆ read() [2/5]

String read ( int index )

inline

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] index The index of the value to read from the property.

◆ read() [3/5]

void read ( List< String > sequence )

inline

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

◆ read() [4/5]

void read	(	List< String >	sequence,
		int	start )

inline

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

◆ read() [5/5]

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

inline

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]	sequence	A reference to a container to store the data read from the property into.
[in]	start	The index from where to start reading values from the property.
[in]	end	The index where to stop reading values from the property.

◆ readBinary() [1/2]

byte[] readBinary ( )

inline

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 mv.impact.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: mv.impact.acquire.PropertyS.writeBinary,
mv.impact.acquire.PropertyS.binaryDataBufferSize,
mv.impact.acquire.PropertyS.binaryDataBufferMaxSize

Returns: The binary data representation of the specified property value.

◆ readBinary() [2/2]

byte[] readBinary ( int index )

inline

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 mv.impact.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: mv.impact.acquire.PropertyS.writeBinary,
mv.impact.acquire.PropertyS.binaryDataBufferSize,
mv.impact.acquire.PropertyS.binaryDataBufferMaxSize

Returns: The binary data representation of the specified property value.

Parameters

[in] index The index of the value to get(if this property holds more than one value).

◆ readS() [1/4]

String readS ( )

inlineinherited

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 mv.impact.acquire.ImpactAcquireException.

Returns: A string containing the data questioned.

Examples: ContinuousSaveImage.cs, DigitalIOs.cs, and GenICamCallbackOnEvent.cs.

◆ readS() [2/4]

String readS ( int index )

inlineinherited

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 mv.impact.acquire.ImpactAcquireException.

Returns: A string containing the data questioned.

Parameters

[in] index The index of the desired value(only necessary for properties containing more than one value)

◆ readS() [3/4]

String readS	(	int	index,
		String	format )

inlineinherited

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 mv.impact.acquire.ImpactAcquireException.

Returns: A string containing the data questioned.

Parameters

[in]	index	The index of the desired value(only necessary for properties containing more than one value)
[in]	format	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

◆ readS() [4/4]

String readS ( TPropertyLimits limit )

inlineinherited

Reads a defined limit 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 mv.impact.acquire.ImpactAcquireException.

Since: 2.4.0

Returns: A string containing the data questioned.

Parameters

[in] limit The limit that shall be queried

◆ readSArray() [1/6]

String readSArray ( )

inlineinherited

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.

Example

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 mv.impact.acquire.ImpactAcquireException.

Returns: A string containing the data questioned.

◆ readSArray() [2/6]

String readSArray ( String format )

inlineinherited

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.

Example

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 mv.impact.acquire.ImpactAcquireException.

Returns: A string containing the data questioned.

Parameters

[in] format 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() [3/6]

String readSArray	(	String	format,
		String	delimiter )

inlineinherited

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.

Example

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 mv.impact.acquire.ImpactAcquireException.

Returns: A string containing the data questioned.

Parameters

[in]	format	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
[in]	delimiter	This string is used to separate the individual values from one another. If left empty, a single blank will separate the data.

◆ readSArray() [4/6]

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

inlineinherited

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.

Example

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 mv.impact.acquire.ImpactAcquireException.

Returns: A string containing the data questioned.

Parameters

[in]	format	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
[in]	delimiter	This string is used to separate the individual values from one another. If left empty, a single blank will separate the data.
[in]	startIndex	The index of the first of the desired values

◆ readSArray() [5/6]

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

inlineinherited

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.

Example

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 mv.impact.acquire.ImpactAcquireException.

Returns: A string containing the data questioned.

Parameters

[in]	format	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
[in]	delimiter	This string is used to separate the individual values from one another. If left empty, a single blank will separate the data.
[in]	startIndex	The index of the first of the desired values
[in]	endIndex	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.

◆ readSArray() [6/6]

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

inlineinherited

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.

Example

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 mv.impact.acquire.ImpactAcquireException.

Returns: A string containing the data questioned.

Parameters

[in]	format	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
[in]	delimiter	This string is used to separate the individual values from one another. If left empty, a single blank will separate the data.
[in]	startIndex	The index of the first of the desired values
[in]	endIndex	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.
[in]	mode	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 ( )

inlineinherited

Removes a certain value from the property's data.

Returns: A const reference to the calling property.

◆ removeValue() [2/2]

Property removeValue ( int index )

inlineinherited

Removes a certain value from the property's data.

Returns: A const reference to the calling property.

Parameters

[in] index The index of the value to be removed

◆ representationAsString() [1/2]

String representationAsString ( )

inlineinherited

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

inlinestaticinherited

Returns the recommended representation converted to a string.

Since: 2.14.0

Returns: The recommended representation converted to a string.

Parameters

[in] representation The representation to query the string representation for

◆ resizeValArray()

Property resizeValArray ( uint newSize )

inlineinherited

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 mv.impact.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 mv.impact.acquire.ImpactAcquireException.; In order to be allowed to modify the number of values a property can store, the mv.impact.acquire.TComponentFlag.cfFixedSize flag must NOT be set.

See also: mv.impact.acquire.Component.isWriteable

Returns: A const reference to the calling property.

Parameters

[in] newSize The new number of values this property shall be allowed to store.

◆ restoreDefault()

Component restoreDefault ( )

inlineinherited

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 mv.impact.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 ( int index )

inlineinherited

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 mv.impact.acquire.Component objects are selected by the current one call mv.impact.acquire.Component.selectedFeatureCount. This value minus 1 will also be the max. value for index.

See also: mv.impact.acquire.Component.selectedFeatureCount,
mv.impact.acquire.Component.selectedFeatures

Since: 1.11.20

Returns: A mv.impact.acquire.Component that is selected by the current one.

Parameters

[in] index The index for the component to query.

◆ selectingFeature()

Component selectingFeature ( int index )

inlineinherited

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 mv.impact.acquire.Component objects are selecting the current one call mv.impact.acquire.Component.selectingFeatureCount. This value minus 1 will also be the max. value for index.

See also: mv.impact.acquire.Component.selectingFeatureCount,
mv.impact.acquire.Component.selectingFeatures

Since: 1.11.20

Returns: A mv.impact.acquire.Component that is selecting the current one.

Parameters

[in] index The index for the component to query.

◆ ToString()

override String ToString ( )

inlineinherited

Reads data from this property as a string.

This is the same as calling mv.impact.acquire.Property.readS for properties storing a single value or mv.impact.acquire.Property.readSArray for properties storing multiple values.

◆ visibilityAsString() [1/2]

String visibilityAsString ( )

inlineinherited

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

inlinestaticinherited

Returns the recommended visibility converted to a string.

Returns: The recommended visibility converted to a string.

Parameters

[in] visibility The visibility to query the string representation for

◆ write() [1/4]

PropertyS write ( List< String > sequence )

inline

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] sequence An array containing the values to write to the property.

◆ write() [2/4]

PropertyS write	(	List< String >	sequence,
		int	start )

inline

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]	sequence	An array containing the values to write to the property.
[in]	start	The index where to write the first value to the property.

◆ write() [3/4]

PropertyS write ( String value )

inline

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] value The value to write to the property.

◆ write() [4/4]

PropertyS write	(	String	value,
		int	index )

inline

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]	value	The value to write to the property.
[in]	index	The index defining at which position to write the value.

◆ writeBinary() [1/2]

PropertyS writeBinary ( byte[] pBuf )

inline

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.

Example

byte[] pBuf = new byte[] { 0x00, 0xff, 0x80, 0x33 };
PropertyS prop = new PropertyS(getHandleFromSomewhere());
prop.writeBinary( pBuf );

To find out if a property contains binary data check if mv.impact.acquire.TComponentFlag.cfContainsBinaryData is set e.g. by calling

Example

PropertyS prop = new PropertyS(getHandleFromSomewhere());
if( ( prop.flags() & TComponentFlag.cfContainsBinaryData ) == TComponentFlag.cfContainsBinaryData )
{
  // Yes!! Binary data
}

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: mv.impact.acquire.PropertyS.readBinary,
mv.impact.acquire.PropertyS.binaryDataBufferSize,
mv.impact.acquire.PropertyS.binaryDataBufferMaxSize

Returns: A const 'self' reference.

Parameters

[in] pBuf The binary data to store in the property

◆ writeBinary() [2/2]

PropertyS writeBinary	(	byte[]	pBuf,
		int	index )

inline

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.

Example

byte[] pBuf = new byte[] { 0x00, 0xff, 0x80, 0x33 };
PropertyS prop = new PropertyS(getHandleFromSomewhere());
prop.writeBinary( pBuf );

To find out if a property contains binary data check if mv.impact.acquire.TComponentFlag.cfContainsBinaryData is set e.g. by calling

Example

PropertyS prop = new PropertyS(getHandleFromSomewhere());
if( ( prop.flags() & TComponentFlag.cfContainsBinaryData ) == TComponentFlag.cfContainsBinaryData )
{
  // Yes!! Binary data
}

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: mv.impact.acquire.PropertyS.readBinary,
mv.impact.acquire.PropertyS.binaryDataBufferSize,
mv.impact.acquire.PropertyS.binaryDataBufferMaxSize

Returns: A const 'self' reference.

Parameters

[in]	pBuf	The binary data to store in the property
[in]	index	The index defining at which position to write the value.

◆ writeS() [1/4]

Property writeS ( List< String > sequence )

inlineinherited

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 mv.impact.acquire.TComponentFlag.cfFixedSize flag must NOT be set). This function behaves exactly like mv.impact.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 mv.impact.acquire.ImpactAcquireException.

See also: mv.impact.acquire.Component.isWriteable,
mv.impact.acquire.Component.flags,
mv.impact.acquire.Property.writeS

Returns: A const reference to the calling property.

Parameters

[in] sequence A constant reference to an array containing the strings to be assigned to the property

◆ writeS() [2/4]

Property writeS	(	List< String >	sequence,
		int	index )

inlineinherited

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 mv.impact.acquire.TComponentFlag.cfFixedSize flag must NOT be set). This function behaves exactly like mv.impact.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 mv.impact.acquire.ImpactAcquireException.

See also: mv.impact.acquire.Component.isWriteable,
mv.impact.acquire.Component.flags,
mv.impact.acquire.Property.writeS

Returns: A const reference to the calling property.

Parameters

[in]	sequence	A constant reference to an array containing the strings to be assigned to the property
[in]	index	The offset from where to start to assign the values

◆ writeS() [3/4]

Property writeS ( String value )

inlineinherited

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 mv.impact.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 mv.impact.acquire.ImpactAcquireException.

See also: mv.impact.acquire.Component.isWriteable,
mv.impact.acquire.Component.flags,
mv.impact.acquire.Property.writeS

Returns: A const reference to the calling property.

Parameters

[in] value The new value for this property at the given index.

Examples: Properties.cs.

◆ writeS() [4/4]

Property writeS	(	String	value,
		int	index )

inlineinherited

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 mv.impact.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 mv.impact.acquire.ImpactAcquireException.

See also: mv.impact.acquire.Component.isWriteable,
mv.impact.acquire.Component.flags,
mv.impact.acquire.Property.writeS

Returns: A const reference to the calling property.

Parameters

[in]	value	The new value for this property at the given index.
[in]	index	The index of the value to modify.

Property Documentation

◆ allowsValueCombinations

bool allowsValueCombinations

getinherited

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:

public enum TEnum
{
  eA,
  eB
};
 
EnumPropertyI<TEnum> p = new EnumPropertyI<TEnum>(getPropHandleFromSomewhere());
p.write( TEnum.eA | TEnum.eB );

Returns

true if this property allows the combination of enum values.
false otherwise.

◆ binaryDataBufferMaxSize

uint binaryDataBufferMaxSize

get

Reads the max size(in bytes) of binary data this property can store.

When binary data shall be stored in a string property, the user will need to allocate memory when this data shall be written to the property. To find out how much binary data can be stored by a property before calling the function mv.impact.acquire.PropertyS.writeBinary this function can be used.

See also: mv.impact.acquire.PropertyS.readBinary,
mv.impact.acquire.PropertyS.writeBinary,
mv.impact.acquire.PropertyS.binaryDataBufferMaxSize

Since: 2.1.4

Returns: The size(in bytes) needed for the binary representation of the string buffer.

◆ changedCounter

uint changedCounter

getinherited

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 mv.impact.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.

Example

//-----------------------------------------------------------------------------
public struct ComponentRef
//-----------------------------------------------------------------------------
{
  mv.impact.acquire.Component m_pc;
  uint m_lastChangedCount;
  public ComponentRef( mv.impact.acquire.Component* pc ) : m_pc(pc), m_lastChangedCount(0) {}
};
 
//-----------------------------------------------------------------------------
public void fn( ComponentRef cr )
//-----------------------------------------------------------------------------
{
  if( cr.m_pc )
  {
    uint currentChangedCount = cr.m_pc.changedCounter;
    if( currentChangedCount != cr.m_lastChangedCount ) )
    {
      // something has happened since the last check.
      doWhatNeedsToBeDone();
      // and remember the current changed counter
      cr.m_lastChangedCount = currentChangedCount;
    }
  }
}

Returns: The current changed counter of this object.

◆ changedCounterAttr

uint changedCounterAttr

getinherited

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 mv.impact.acquire.ComponentAccess.changedCounter (except in case of a wrap around) when called at the same time for the same object.

See also: mv.impact.acquire.ComponentAccess.changedCounter

Returns: The current attributes changed counter of this object.

◆ dictSize

int dictSize

getinherited

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

getinherited

Returns the display name of the component referenced by this object.

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

getinherited

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.

◆ firstChild

Component firstChild

getinherited

Moves to the first child of this component(moves down one level).

Calling this function will only succeed, if the current mv.impact.acquire.Component references a list.

Returns: A new mv.impact.acquire.Component object

Examples: Properties.cs.

◆ firstSibling

Component firstSibling

getinherited

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

Returns: A new mv.impact.acquire.Component object

◆ flags

TComponentFlag flags

getinherited

Returns the flags associated with this component.

Returns: The flags associated with this component.

◆ hasDict

bool hasDict

getinherited

Returns whether this property defines a translation dictionary or not.

Returns

true if this property defines a translation table
false otherwise

Examples: Properties.cs.

◆ hasMaxValue

bool hasMaxValue

getinherited

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

bool hasMinValue

getinherited

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

bool hasStepWidth

getinherited

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

getinherited

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

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

Examples: GenICamCallbackOnEvent.cs, and Properties.cs.

◆ isDefault

bool isDefault

getinherited

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

bool isList

getinherited

Checks if this component is of type mv.impact.acquire.ComponentList.

Returns

true if the component references a list
false otherwise

Examples: Properties.cs.

◆ isMeth

bool isMeth

getinherited

Checks if this component is of type mv.impact.acquire.Method.

Returns

true if the component references a method
false otherwise

◆ isProp

bool isProp

getinherited

Checks if this component is of type mv.impact.acquire.Property or a derived type.

Returns

true if the component references a property
false otherwise

Examples: GenICamCallbackOnEvent.cs, and Properties.cs.

◆ isValid

bool isValid

getinherited

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 mv.impact.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.

Examples: GenICamCommonSettingsUsage.cs, and Properties.cs.

◆ isVisible

bool isVisible

getinherited

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 mv.impact.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 mv.impact.acquire.Component when it's not visible however the actual data will be used only if the Component is visible (mv.impact.acquire.TComponentFlag.cfInvisible must NOT be set).

The visibility of a mv.impact.acquire.Component object will change only if other mv.impact.acquire.Component objects are modified and NEVER when a program runs but does not change any mv.impact.acquire.Component.

◆ isWriteable

bool isWriteable

getinherited

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.

Examples: Properties.cs.

◆ lastSibling

Component lastSibling

getinherited

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

Since: 1.10.64

Returns: A new mv.impact.acquire.Component object

◆ maxValCount

uint maxValCount

getinherited

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

getinherited

Returns the name of the component referenced by this object.

Returns: The name of the component referenced by this object.

Examples: Callback.cs, GenICamCallbackOnEvent.cs, and Properties.cs.

◆ nextSibling

Component nextSibling

getinherited

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

Returns: A new mv.impact.acquire.Component object

◆ parent

Component parent

getinherited

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

Returns: A new mv.impact.acquire.Component object

◆ representation

TComponentRepresentation representation

getinherited

Returns the recommended representation for this component.

The representation can be used e.g. e.g. to develop a GUI that creates convenient controls for certain features.

Valid values for this property are defined by the enumeration mv.impact.acquire.TComponentRepresentation.

Since: 2.14.0

Returns: The recommended representation for this component.

◆ selectedFeatureCount

uint selectedFeatureCount

getinherited

Returns the number of features selected by the current one.

See also: mv.impact.acquire.Component.selectedFeatures,
mv.impact.acquire.Component.selectedFeature

Returns: The number of features selected by the current one.

◆ selectedFeatures

ReadOnlyCollection<Component> selectedFeatures

getinherited

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: mv.impact.acquire.Component.selectedFeatureCount,
mv.impact.acquire.Component.selectedFeature

Since: 1.11.20

Returns: A list of components that are selected by the current one.

◆ selectingFeatureCount

uint selectingFeatureCount

getinherited

Returns the number of features selecting the current one.

See also: mv.impact.acquire.Component.selectingFeatures,
mv.impact.acquire.Component.selectingFeature

Since: 1.11.20

Returns: The number of features selecting the current one.

◆ selectingFeatures

ReadOnlyCollection<Component> selectingFeatures

getinherited

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: mv.impact.acquire.Component.selectingFeatureCount,
mv.impact.acquire.Component.selectingFeature

Since: 1.11.20

Returns: A list of components that are selecting the current one.

◆ stringFormatString

String stringFormatString

getinherited

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.

◆ this[int index]

char this[int index]

get

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.

◆ type

TComponentType type

getinherited

Returns the type of the component referenced by hObj.

Returns: The type of the component referenced by hObj.

◆ typeAsString

String typeAsString

getinherited

Returns the type of the referenced component as a string.

Returns: The type of the referenced component as a string.

◆ valCount

uint valCount

getinherited

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.

Examples: Properties.cs.

◆ visibility

TComponentVisibility visibility

getinherited

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.

Returns: The recommended visibility for this component.

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PropertyS() [1/2]

◆ PropertyS() [2/2]

Member Function Documentation

◆ binaryDataBufferSize() [1/2]

◆ binaryDataBufferSize() [2/2]

◆ factory()

◆ flagsAsString() [1/2]

◆ flagsAsString() [2/2]

◆ operator++()

◆ read() [1/5]

◆ read() [2/5]

◆ read() [3/5]

◆ read() [4/5]

◆ read() [5/5]

◆ readBinary() [1/2]

◆ readBinary() [2/2]

◆ readS() [1/4]

◆ readS() [2/4]

◆ readS() [3/4]

◆ readS() [4/4]

◆ readSArray() [1/6]

◆ readSArray() [2/6]

◆ readSArray() [3/6]

◆ readSArray() [4/6]

◆ readSArray() [5/6]

◆ readSArray() [6/6]

◆ removeValue() [1/2]

◆ removeValue() [2/2]

◆ representationAsString() [1/2]

◆ representationAsString() [2/2]

◆ resizeValArray()

◆ restoreDefault()

◆ selectedFeature()

◆ selectingFeature()

◆ ToString()

◆ visibilityAsString() [1/2]

◆ visibilityAsString() [2/2]

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]

◆ writeBinary() [1/2]

◆ writeBinary() [2/2]

◆ writeS() [1/4]

◆ writeS() [2/4]

◆ writeS() [3/4]

◆ writeS() [4/4]

Property Documentation

◆ allowsValueCombinations

◆ binaryDataBufferMaxSize

◆ changedCounter

◆ changedCounterAttr

◆ dictSize

◆ displayName

◆ docString

◆ firstChild

◆ firstSibling

◆ flags

◆ hasDict

◆ hasMaxValue

◆ hasMinValue

◆ hasStepWidth

◆ hObj

◆ isDefault

◆ isList

◆ isMeth

◆ isProp

◆ isValid

◆ isVisible

◆ isWriteable

◆ lastSibling

◆ maxValCount

◆ name

◆ nextSibling

◆ parent