|
| unsigned int | changedCounter (void) const |
| | Returns the current changed counter for the component referenced by this object.
|
| |
| unsigned int | changedCounterAttr (void) const |
| | Returns the current attribute changed counter for the component referenced by this object.
|
| |
| | Component (const Component &src) |
| | Constructs a new mvIMPACT::acquire::Component from an existing one.
|
| |
| | Component (HOBJ hObj) |
| | Constructs a new access object to a driver object.
|
| |
| | Component (void) |
| | Constructs a new unbound access object.
|
| |
| std::string | displayName (void) const |
| | Returns the display name of the component referenced by this object.
|
| |
| std::string | docString (void) const |
| | Returns a string containing general information about the component referenced by this object.
|
| |
| Component | firstChild (void) const |
| | Moves to the first child of this component(moves down one level).
|
| |
| Component | firstSibling (void) const |
| | Moves to the first sibling(the first feature in the current list of features).
|
| |
| TComponentFlag | flags (void) const |
| | Returns the flags associated with this component.
|
| |
| std::string | flagsAsString (const std::string &separator=" | ") const |
| | Returns the flags associated with this component as a string.
|
| |
| HOBJ | hObj (void) const |
| | Returns a unique identifier for the component referenced by this object.
|
| |
| bool | isDefault (void) const |
| | Checks if this component is currently referencing the default for this component.
|
| |
| bool | isList (void) const |
| | Checks if this component is of type mvIMPACT::acquire::ComponentList.
|
| |
| bool | isMeth (void) const |
| | Checks if this component is of type mvIMPACT::acquire::Method.
|
| |
| bool | isProp (void) const |
| | Checks if this component is of type mvIMPACT::acquire::Property or a derived type.
|
| |
| bool | isValid (void) const |
| | Checks if the internal component referenced by this object is still valid.
|
| |
| bool | isVisible (void) const |
| | Checks if the component is currently shadowed due to a settings made elsewhere or not.
|
| |
| bool | isWriteable (void) const |
| | Checks if the caller has write/modify access to the component.
|
| |
| Component | lastSibling (void) const |
| | Moves to the last sibling(the last feature in the current list of features).
|
| |
| std::string | name (void) const |
| | Returns the name of the component referenced by this object.
|
| |
| Component | nextSibling (void) |
| | Moves to the next sibling(the next feature in the current list of features).
|
| |
| | operator HOBJ () const |
| | Allows implicit conversion to a HOBJ.
|
| |
| Component | operator++ (int) |
| | Moves to the next sibling(the next feature in the current list of features).
|
| |
| Component & | operator++ (void) |
| | Moves to the next sibling(the next feature in the current list of features).
|
| |
| Component & | operator= (const Component &rhs) |
| | Allows assignments of mvIMPACT::acquire::Component objects.
|
| |
| Component | parent (void) const |
| | Moves to the parent of this component(moves up one level).
|
| |
| TComponentRepresentation | representation (void) const |
| | Returns the recommended representation for this component.
|
| |
| std::string | representationAsString (void) const |
| | Returns the recommended representation of the referenced component as a string.
|
| |
| const Component & | restoreDefault (void) const |
| | Restores the default for the referenced component.
|
| |
| Component | selectedFeature (unsigned int index) const |
| | Retrieves a component that is selected by the current one.
|
| |
| unsigned int | selectedFeatureCount (void) const |
| | Returns the number of features selected by the current one.
|
| |
| unsigned int | selectedFeatures (std::vector< Component > &v) const |
| | Retrieves the list of components that are selected by the current one.
|
| |
| Component | selectingFeature (unsigned int index) const |
| | Retrieves a component that is selecting the current one.
|
| |
| unsigned int | selectingFeatureCount (void) const |
| | Returns the number of features selecting the current one.
|
| |
| unsigned int | selectingFeatures (std::vector< Component > &v) const |
| | Retrieves the list of components that are selecting the current one.
|
| |
| TComponentType | type (void) const |
| | Returns the type of the referenced component.
|
| |
| std::string | typeAsString (void) const |
| | Returns the type of the referenced component as a string.
|
| |
| TComponentVisibility | visibility (void) const |
| | Returns the recommended visibility for this component.
|
| |
| std::string | visibilityAsString (void) const |
| | Returns the recommended visibility of the referenced component as a string.
|
| |
A base class to implement access to internal driver components.
Objects of this class can be constructed directly even if nothing is known about the type of driver object we are referring to. This class acts as a base class to provide access to internal properties, methods and component lists offered by the driver.
This object can be used to navigate through component lists of unknown content.
Consider the following structure:
LA
|-LB
|-LC
| |-PE
| |-PF
| |-PG
|-PD
Where the prefix 'L' means this is a list, 'P' that this is a property. Assuming that we have and iterator referencing list 'C', calling mvIMPACT::acquire::Component::firstChild e.g. would return a new iterator referencing object 'PE', while calling mvIMPACT::acquire::Component::nextSibling would have returned a reference to 'PD' and mvIMPACT::acquire::Component::parent would have returned a reference to object 'LA'.
"EXAMPLE 1":
A new mvIMPACT::acquire::Component is created with the ID of list 'C':
it = it.firstChild();
it = it.lastSibling();
it = it.firstSibling();
it = it.nextSibling();
it = it.firstSibling();
it = it.parent();
A base class to implement access to internal driver components.
Definition mvIMPACT_acquire.h:1439
"EXAMPLE 2":
Iterate over a complete list including sub lists. This will result in a list of all lists and properties that reside in the list the iterator currently is moving through to be written to the standard output. The name of the component and every parent component will be printed into the standard output:
void ParseList(
Component iter,
const string& path =
"" )
{
{
{
{
cout <<
"List " << path << iter.
name() <<
"/" << endl;
}
{
cout << "Property " << path << prop.name() << "(value(s): ";
unsigned int valCount = prop.valCount();
for( unsigned int i=0; i<valCount; i++ )
{
cout << prop.readS();
if( i < valCount - 1 )
{
cout << ", ";
}
}
cout << ")" << endl;
}
}
++iter;
}
}
int main( int argc, char* argv[] )
{
ComponentList baselist;
ParseList( it );
return 0;
}
std::string name(void) const
Returns the name of the component referenced by this object.
Definition mvIMPACT_acquire.h:1206
bool isValid(void) const
Checks if the internal component referenced by this object is still valid.
Definition mvIMPACT_acquire.h:1721
Component(void)
Constructs a new unbound access object.
Definition mvIMPACT_acquire.h:1513
bool isProp(void) const
Checks if this component is of type mvIMPACT::acquire::Property or a derived type.
Definition mvIMPACT_acquire.h:1706
bool isList(void) const
Checks if this component is of type mvIMPACT::acquire::ComponentList.
Definition mvIMPACT_acquire.h:1686
Component firstChild(void) const
Moves to the first child of this component(moves down one level).
Definition mvIMPACT_acquire.h:1595
bool isVisible(void) const
Checks if the component is currently shadowed due to a settings made elsewhere or not.
Definition mvIMPACT_acquire.h:1745
A base class for properties.
Definition mvIMPACT_acquire.h:3134
- Examples
- Callback.cpp, GenICamCallbackOnEvent.cpp, GenericInterfaceLayout.cpp, GenericInterfaceLayout.legacy.cpp, Properties.cpp, and Properties.legacy.cpp.
| bool isVisible |
( |
void | | ) |
const |
|
inline |
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.
| Component selectedFeature |
( |
unsigned int | index | ) |
const |
|
inline |
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] | index | The index for the component to query. |
| Component selectingFeature |
( |
unsigned int | index | ) |
const |
|
inline |
