mvIMPACT Acquire SDK C++
Method Class Reference

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

Inheritance diagram for Method:
Component ComponentAccess

Public Member Functions

int call (const std::string &params, const std::string &delimiters=" ") const
 Calls an underlying driver function. More...
 
int call (const std::vector< std::string > &params) const
 Calls an underlying driver function. More...
 
int call (void) const
 Calls an underlying driver function expecting no parameters. More...
 
unsigned int changedCounter (void) const
 Returns the current changed counter for the component referenced by this object. More...
 
unsigned int changedCounterAttr (void) const
 Returns the current attribute changed counter for the component referenced by this object. More...
 
std::string displayName (void) const
 Returns the display name of the component referenced by this object. More...
 
std::string docString (void) const
 Returns a string containing general information about the component referenced by this object. More...
 
Component firstChild (void) const
 Moves to the first child of this component(moves down one level). More...
 
Component firstSibling (void) const
 Moves to the first sibling(the first feature in the current list of features). More...
 
TComponentFlag flags (void) const
 Returns the flags associated with this component. More...
 
std::string flagsAsString (const std::string &separator=" | ") const
 Returns the flags associated with this component as a string. More...
 
HOBJ hObj (void) const
 Returns a unique identifier for the component referenced by this object. More...
 
bool isDefault (void) const
 Checks if this component is currently referencing the default for this component. More...
 
bool isList (void) const
 Checks if this component is of type mvIMPACT::acquire::ComponentList. More...
 
bool isMeth (void) const
 Checks if this component is of type mvIMPACT::acquire::Method. More...
 
bool isProp (void) const
 Checks if this component is of type mvIMPACT::acquire::Property or a derived type. More...
 
bool isValid (void) const
 Checks if the internal component referenced by this object is still valid. More...
 
bool isVisible (void) const
 Checks if the component is currently shadowed due to a settings made elsewhere or not. More...
 
bool isWriteable (void) const
 Checks if the caller has write/modify access to the component. More...
 
Component lastSibling (void) const
 Moves to the last sibling(the last feature in the current list of features). More...
 
 Method ()
 Constructs a new unbound mvIMPACT::acquire::Method object. More...
 
 Method (const Method &src)
 Constructs a new mvIMPACT::acquire::Method from an existing one. More...
 
 Method (HOBJ hMeth)
 Constructs a new mvIMPACT::acquire::Method object. More...
 
std::string name (void) const
 Returns the name of the component referenced by this object. More...
 
Component nextSibling (void)
 Moves to the next sibling(the next feature in the current list of features). More...
 
 operator HOBJ () const
 Allows implicit conversion to a HOBJ. More...
 
Component operator++ (int)
 Moves to the next sibling(the next feature in the current list of features). More...
 
Componentoperator++ (void)
 Moves to the next sibling(the next feature in the current list of features). More...
 
std::string paramList (void) const
 Returns the parameter list of the methods as a string. More...
 
Component parent (void) const
 Moves to the parent of this component(moves up one level). More...
 
TComponentRepresentation representation (void) const
 Returns the recommended representation for this component. More...
 
std::string representationAsString (void) const
 Returns the recommended representation of the referenced component as a string. More...
 
const ComponentrestoreDefault (void) const
 Restores the default for the referenced component. More...
 
Component selectedFeature (unsigned int index) const
 Retrieves a component that is selected by the current one. More...
 
unsigned int selectedFeatureCount (void) const
 Returns the number of features selected by the current one. More...
 
unsigned int selectedFeatures (std::vector< Component > &v) const
 Retrieves the list of components that are selected by the current one. More...
 
Component selectingFeature (unsigned int index) const
 Retrieves a component that is selecting the current one. More...
 
unsigned int selectingFeatureCount (void) const
 Returns the number of features selecting the current one. More...
 
unsigned int selectingFeatures (std::vector< Component > &v) const
 Retrieves the list of components that are selecting the current one. More...
 
TComponentType type (void) const
 Returns the type of the referenced component. More...
 
std::string typeAsString (void) const
 Returns the type of the referenced component as a string. More...
 
TComponentVisibility visibility (void) const
 Returns the recommended visibility for this component. More...
 
std::string visibilityAsString (void) const
 Returns the recommended visibility of the referenced component as a string. More...
 

Static Public Member Functions

static std::string representationAsString (TComponentRepresentation representation)
 Returns the recommended representation converted to a string. More...
 
static TComponentType type (HOBJ hObj)
 Returns the type of the component referenced by hObj. More...
 
static std::string visibilityAsString (TComponentVisibility visibility)
 Returns the recommended visibility converted to a string. More...
 

Protected Types

enum  { BUFFER_INCREMENT_FACTOR = 6 }
 An internal constant that defines by which factor dynamic buffers will grow when the current size is not sufficient. More...
 

Protected Member Functions

std::string compGetStringParam (TOBJ_StringQuery query, int param1=0, int param2=0) const
 A helper function to query certain component related string parameters. More...
 

Static Protected Member Functions

static char * stringAllocator (const char *pBuf, size_t reqBufSize)
 An internal helper function for fast string allocation. More...
 

Protected Attributes

HOBJ m_hObj
 A unique identifier for the internal driver object referenced by this instance of mvIMPACT::acquire::ComponentAccess. More...
 

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.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited

An internal constant that defines by which factor dynamic buffers will grow when the current size is not sufficient.

Enumerator
BUFFER_INCREMENT_FACTOR 

Constructor & Destructor Documentation

◆ Method() [1/3]

Method ( HOBJ  hMeth)
inlineexplicit

Constructs a new mvIMPACT::acquire::Method object.

Parameters
[in]hMethA valid handle to method object

◆ Method() [2/3]

Method ( )
inlineexplicit

Constructs a new unbound mvIMPACT::acquire::Method object.

◆ Method() [3/3]

Method ( const Method src)
inline

Constructs a new mvIMPACT::acquire::Method from an existing one.

Parameters
[in]srcA constant reference to the mvIMPACT::acquire::Method object, this object shall be created from

Member Function Documentation

◆ call() [1/3]

int call ( const std::string &  params,
const std::string &  delimiters = " " 
) const
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 mvIMPACT::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('_').

Attention
The characters '.', ',' and '_' can't be used as delimiters.
// 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]paramsThe parameters to be passed to the function as a single string
[in]delimitersA string containing valid delimiter characters for the parameter string

◆ call() [2/3]

int call ( const std::vector< std::string > &  params) const
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 mvIMPACT::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.

// call a function expecting a string and a float
vector<string> params;
params.push_back( "stringParam" );
params.push_back( "3.14" );
meth.call( params );
Returns
An integer value. For a typical function that is part of the driver SDK this integer value will be
Parameters
[in]paramsThe parameters to be passed to the function as a list of strings

◆ call() [3/3]

int call ( void  ) const
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 mvIMPACT::acquire::Method::paramList().

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

◆ changedCounter()

unsigned int changedCounter ( void  ) const
inlineinherited

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.

//-----------------------------------------------------------------------------
struct ComponentRef
//-----------------------------------------------------------------------------
{
unsigned int lastChangedCount_;
ComponentRef( mvIMPACT::acquire::Component c ) : c_( c ), lastChangedCount_( 0 ) {}
};
//-----------------------------------------------------------------------------
void fn( ComponentRef& cr )
//-----------------------------------------------------------------------------
{
if( cr.c_.isValid() )
{
const unsigned int currentChangedCount = cr.c_.changedCounter();
if( currentChangedCount != cr.lastChangedCount_ )
{
// something has happened since the last check!
doWhatNeedsToBeDone();
// and remember the current changed counter
cr.lastChangedCount_ = currentChangedCount;
}
}
}
A base class to implement access to internal driver components.
Definition: mvIMPACT_acquire.h:1321
Returns
The current changed counter of this object.

◆ changedCounterAttr()

unsigned int changedCounterAttr ( void  ) const
inlineinherited

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.

◆ compGetStringParam()

std::string compGetStringParam ( TOBJ_StringQuery  query,
int  param1 = 0,
int  param2 = 0 
) const
inlineprotectedinherited

A helper function to query certain component related string parameters.

This function might throw an exception, if an invalid parameter has been queried.

Returns
A string containing the data to be queried.
Parameters
queryThe type of the parameter to read
[in]param1An additional parameter
[in]param2An additional parameter

◆ displayName()

std::string displayName ( void  ) const
inlineinherited

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.
Examples
exampleHelper.h.

◆ docString()

std::string docString ( void  ) const
inlineinherited

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.
Examples
exampleHelper.h.

◆ firstChild()

Component firstChild ( void  ) const
inlineinherited

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 ( void  ) const
inlineinherited

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

Returns
A new mvIMPACT::acquire::Component object

◆ flags()

TComponentFlag flags ( void  ) const
inlineinherited

Returns the flags associated with this component.

Returns
The flags associated with this component.

◆ flagsAsString()

std::string flagsAsString ( const std::string &  separator = " | ") const
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'
Examples
exampleHelper.h.

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

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

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

◆ isDefault()

bool isDefault ( void  ) const
inlineinherited

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 ( void  ) const
inlineinherited

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

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

◆ isMeth()

bool isMeth ( void  ) const
inlineinherited

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

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

◆ isProp()

bool isProp ( void  ) const
inlineinherited

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

bool isValid ( void  ) const
inlineinherited

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.
Examples
exampleHelper.h.

◆ isVisible()

bool isVisible ( void  ) const
inlineinherited

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

bool isWriteable ( void  ) const
inlineinherited

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
exampleHelper.h.

◆ lastSibling()

Component lastSibling ( void  ) const
inlineinherited

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

◆ name()

std::string name ( void  ) const
inlineinherited

Returns the name of the component referenced by this object.

Returns
The name of the component referenced by this object.
Examples
exampleHelper.h.

◆ nextSibling()

Component nextSibling ( void  )
inlineinherited

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

Returns
A new mvIMPACT::acquire::Component object

◆ operator HOBJ()

operator HOBJ ( ) const
inlineinherited

Allows implicit conversion to a HOBJ.

◆ operator++() [1/2]

Component operator++ ( int  )
inlineinherited

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

Returns
A new mvIMPACT::acquire::Component object

◆ operator++() [2/2]

Component& operator++ ( void  )
inlineinherited

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

Returns
A self reference

◆ paramList()

std::string paramList ( void  ) const
inline

Returns the parameter list of the methods as a string.

This function returns a string containing one character for each parameter this mvIMPACT::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 ( void  ) const
inlineinherited

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

Returns
A new mvIMPACT::acquire::Component object

◆ representation()

TComponentRepresentation representation ( void  ) const
inlineinherited

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]

static std::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

◆ representationAsString() [2/2]

std::string representationAsString ( void  ) const
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.

◆ restoreDefault()

const Component& restoreDefault ( void  ) const
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 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 ( unsigned int  index) const
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.

C++ offers the more efficient function mvIMPACT::acquire::Component::selectedFeatures to obtain this information.

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

◆ selectedFeatureCount()

unsigned int selectedFeatureCount ( void  ) const
inlineinherited

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.
Examples
exampleHelper.h.

◆ selectedFeatures()

unsigned int selectedFeatures ( std::vector< Component > &  v) const
inlineinherited

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
[out]vAn array that will retrieve the list of components that are selected by the current one.
Examples
exampleHelper.h.

◆ selectingFeature()

Component selectingFeature ( unsigned int  index) const
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.

C++ offers the more efficient function mvIMPACT::acquire::Component::selectingFeatures to obtain this information.

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

◆ selectingFeatureCount()

unsigned int selectingFeatureCount ( void  ) const
inlineinherited

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.
Examples
exampleHelper.h.

◆ selectingFeatures()

unsigned int selectingFeatures ( std::vector< Component > &  v) const
inlineinherited

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
[out]vAn array that will retrieve the list of components that are selecting the current one.
Examples
exampleHelper.h.

◆ stringAllocator()

static char* stringAllocator ( const char *  pBuf,
size_t  reqBufSize 
)
inlinestaticprotectedinherited

An internal helper function for fast string allocation.

◆ type() [1/2]

static TComponentType type ( HOBJ  hObj)
inlinestaticinherited

Returns the type of the component referenced by hObj.

Returns
The type of the component referenced by hObj.
Parameters
[in]hObjThe component the type shall be retrieved for

◆ type() [2/2]

TComponentType type ( void  ) const
inlineinherited

Returns the type of the referenced component.

Returns
The type of the referenced component.
Examples
exampleHelper.h.

◆ typeAsString()

std::string typeAsString ( void  ) const
inlineinherited

Returns the type of the referenced component as a string.

Returns
The type of the referenced component as a string.
Examples
exampleHelper.h.

◆ visibility()

TComponentVisibility visibility ( void  ) const
inlineinherited

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]

static std::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

◆ visibilityAsString() [2/2]

std::string visibilityAsString ( void  ) const
inlineinherited

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

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

Member Data Documentation

◆ m_hObj

HOBJ m_hObj
protectedinherited

A unique identifier for the internal driver object referenced by this instance of mvIMPACT::acquire::ComponentAccess.


The documentation for this class was generated from the following file: