Impact Acquire SDK .NET
Method Class Reference

A class to call arbitrary driver functions. More...

Inheritance diagram for Method:
[legend]

Public Member Functions

int call ()
 Calls an underlying driver function expecting no parameters.
 
int call (List< String > callParams)
 Calls an underlying driver function.
 
int call (String callParams)
 Calls an underlying driver function.
 
int call (String callParams, String delimiter)
 Calls an underlying driver function.
 
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.
 
 Method ()
 Constructs a new unbound mv.impact.acquire.Method object.
 
 Method (int hMeth)
 Constructs a new mv.impact.acquire.Method object.
 
String representationAsString ()
 Returns the recommended representation of the referenced component as a string.
 
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.
 
String visibilityAsString ()
 Returns the recommended visibility of the referenced component as a string.
 

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

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.
 
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.
 
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).
 
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).
 
String paramList [get]
 Returns the parameter list of the methods as a string.
 
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< ComponentselectedFeatures [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< ComponentselectingFeatures [get]
 Retrieves the list of components that are selecting the current one.
 
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.
 
TComponentVisibility visibility [get]
 Returns the recommended visibility for this component.
 

Detailed Description

A class to call arbitrary driver functions.

Normally all functions needed by the user and offered by the driver will be provided as a normal function somewhere within this interface. In rare cases however it might be necessary to call a function, which hasn't been implemented in this interface. In that case this class will serve as a backdoor.

Constructor & Destructor Documentation

◆ Method() [1/2]

Method ( int hMeth)
inline

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

Parameters
[in]hMethA valid handle to method object

◆ Method() [2/2]

Method ( )
inline

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

Member Function Documentation

◆ call() [1/4]

int call ( )
inline

Calls an underlying driver function expecting no parameters.

This function can be used to call any driver function which is registered for the device it is called for that does NOT expect any parameters

To find out what kind of parameters are expected by the function use the function mv.impact.acquire.Method.paramList.

Returns
An integer value. For a typical function that is part of the driver SDK this integer value will be

◆ call() [2/4]

int call ( List< String > callParams)
inline

Calls an underlying driver function.

This function can be used to call any driver function which is registered for the device it is called for. To call a function successfully the parameters passed to the function must match the parameters expected by the function.

The parameters are passed as a list of strings.

To find out what kind of parameters are expected by the function use the function mv.impact.acquire.Method.paramList().

floating point values can be passed either with a '.' or a ',' acting as the decimal point.

'empty' strings can be passed as a single underline('_').rs.

Returns
An integer value. For a typical function that is part of the driver SDK this integer value will be
Parameters
[in]callParamsThe parameters to be passed to the function as a list of strings
Examples
GenICamCommonSettingsUsage.cs.

◆ call() [3/4]

int call ( String callParams)
inline

Calls an underlying driver function.

This function can be used to call any driver function which is registered for the device it is called for. To call a function successfully the parameters passed to the function must match the parameters expected by the function.

All parameters are passed as a single string, which is parsed with respect to the given delimiter characters internally.

To find out what kind of parameters are expected by the function use the function mv.impact.acquire.Method.paramList.

floating point values can be passed either with a '.' or a ',' acting as the decimal point.

'empty' strings can be passed as a single underline('_').

Note
The characters '.', ',' and '_' can't be used as delimiters.

Examples

// call a function expecting a string and a float
// value parameters separated by spaces
meth.call( "stringParam 3,14" );
// call of a function expecting 2 integers an a string
// where an empty string shall be passed
// parameters are separated by '%'
meth.call( "1000%666%_", "%" );
A template class to represent 32 bit integer properties and 32 bit enumerated integer properties.
Definition EnumPropertyI.cs:61
Returns
An integer value. For a typical function that is part of the driver SDK this integer value will be
Parameters
[in]callParamsThe parameters to be passed to the function as a single string

◆ call() [4/4]

int call ( String callParams,
String delimiter )
inline

Calls an underlying driver function.

This function can be used to call any driver function which is registered for the device it is called for. To call a function successfully the parameters passed to the function must match the parameters expected by the function.

All parameters are passed as a single string, which is parsed with respect to the given delimiter characters internally.

To find out what kind of parameters are expected by the function use the function mv.impact.acquire.Method.paramList.

floating point values can be passed either with a '.' or a ',' acting as the decimal point.

'empty' strings can be passed as a single underline('_').

Note
The characters '.', ',' and '_' can't be used as delimiters.

Examples

// call a function expecting a string and a float
// value parameters separated by spaces
meth.call( "stringParam 3,14" );
// call of a function expecting 2 integers an a string
// where an empty string shall be passed
// parameters are separated by '%'
meth.call( "1000%666%_", "%" );
Returns
An integer value. For a typical function that is part of the driver SDK this integer value will be
Parameters
[in]callParamsThe parameters to be passed to the function as a single string
[in]delimiterA string containing valid delimiter characters for the parameter string

◆ 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]hObjA 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]separatorA 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]ciA valid component.

◆ 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]representationThe representation to query the string representation for

◆ 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]indexThe 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]indexThe index for the component to query.

◆ 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]visibilityThe visibility to query the string representation for

Property Documentation

◆ 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
//-----------------------------------------------------------------------------
{
};
//-----------------------------------------------------------------------------
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;
}
}
}
uint changedCounter
Returns the current changed counter for the component referenced by this object.
Definition ComponentAccess.cs:101
A base class to implement access to internal driver components.
Definition Component.cs:133
This namespace contains classes and functions belonging to the image acquisition module of this SDK.
Definition Enumerations.cs:2
Definition Enumerations.cs:2
Definition Enumerations.cs:2
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.

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

◆ 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

◆ 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

◆ paramList

String paramList
get

Returns the parameter list of the methods as a string.

This function returns a string containing one character for each parameter this mv.impact.acquire.Method object expects and one for the return type of the function call.

The first character is the return type of the function all others are parameters. void functions don't specify parameters.

The characters have the following meaning:

  • i specifies a 32-bit integer value
  • I specifies a 64-bit integer value
  • s specifies a pointer to a C-string
  • f specifies a double precision float value
  • p specifies a pointer value
  • v specifies a void return value

Examples

  • 'v': This is a function returning nothing (void). It expects no parameters.
  • 'viis': This is a function returning nothing (void). It expects 2 integer values and one pointer to a C-string.
  • 'if': This function returns an integer value and expects a float value.
    Returns
    The parameter list of the method as a string.

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

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

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