mvIMPACT Acquire SDK C++
|
A class to represent real time control programs(Device specific interface layout only). More...
Public Member Functions | |
int | getProgramSize (void) const |
Returns the number of program instructions for this program. More... | |
HOBJ | hObj (void) const |
Returns a unique identifier for the component collection referenced by this object. More... | |
int | load (void) |
Loads an existing program specified by the property mvIMPACT::acquire::RTCtrProgram::fileName. More... | |
RTCtrProgram & | operator= (const RTCtrProgram &rhs) |
Allows assignments of mvIMPACT::acquire::RTCtrProgram objects. More... | |
RTCtrProgramStep * | programStep (unsigned int nr) const |
Returns a pointer to a program instruction of the program. More... | |
const ComponentCollection & | restoreDefault (void) const |
Restores the default for every component of this collection. More... | |
RTCtrProgram (const RTCtrProgram &src) | |
Constructs a new mvIMPACT::acquire::RTCtrProgram from an existing one. More... | |
int | save (void) |
Stores the current state of the program under the name specified by the property mvIMPACT::acquire::RTCtrProgram::filename. More... | |
void | setProgramSize (int newSize) |
A function to define the number of instructions this program should consist of. More... | |
~RTCtrProgram () | |
Class destructor. More... | |
Public Attributes | |
PropertyS | filename |
A string property storing the filename for this program. More... | |
PropertyIRTCtrlModes | mode |
An enumerated integer property defining the current state this program is into. More... | |
PropertyS | programState |
A string property (read-only) containing information about the current state of the program. More... | |
Protected Attributes | |
HOBJ | m_hRoot |
Friends | |
class | IOSubSystem |
A class to represent real time control programs(Device specific interface layout only).
Real time control programs can be used to control the way how an when images are exposed and transmitted to the user.
An mvIMPACT::acquire::RTCtrProgram e.g. can be used to achieve a constant frame rate with a desired frequency. This can be done e.g. by triggering the camera with a constant frequency.
An appropriate signal for triggering the camera can be generated as follows:
Once this program has been defined it can be executed by setting the mode property to mvIMPACT::acquire::rtctrlModeRun. As in this example we do not wait for an external signal the property triggerMode must be set to a value demanding an external signal (e.g. mvIMPACT::acquire::ctmOnHighLevel ; You will find a summary of the valid trigger modes in the sensor specific data in the "Sensor data" chapter of the specific product manual. triggerMode must be set to mvIMPACT::acquire::ctsRTCtrl to inform the driver that the signal generate by the real time program shall be used as the trigger signal.
|
inline |
Constructs a new mvIMPACT::acquire::RTCtrProgram from an existing one.
[in] | src | A constant reference to the mvIMPACT::acquire::RTCtrProgram object, this object shall be created from |
|
inline |
Class destructor.
|
inline |
Returns the number of program instructions for this program.
|
inlineinherited |
Returns a unique identifier for the component collection referenced by this object.
This handle will always reference an object of type mvIMPACT::acquire::ComponentList.
|
inline |
Loads an existing program specified by the property mvIMPACT::acquire::RTCtrProgram::fileName.
The default file extension for these programs is '*.rtp'. If the user doesn't specify this file extension, it is appended automatically. Only files of this type can be loaded by this function.
|
inline |
Allows assignments of mvIMPACT::acquire::RTCtrProgram objects.
|
inline |
Returns a pointer to a program instruction of the program.
If nr is invalid(too large) a STL out_of_range exception will be thrown.
[in] | nr | The index of the program instruction to obtain. |
|
inlineinherited |
Restores the default for every component of this collection.
Calling this function will restore the default value for every component belonging to this collection.
|
inline |
Stores the current state of the program under the name specified by the property mvIMPACT::acquire::RTCtrProgram::filename.
The default file extension for files stored using this function is '*.rtp'. If the user doesn't specify this file extension, it is appended automatically. Only files of this type can be loaded by the function mvIMPACT::acquire::RTCtrProgram::load.
|
inline |
A function to define the number of instructions this program should consist of.
[in] | newSize | The new number of program instructions |
|
friend |
PropertyS filename |
A string property storing the filename for this program.
mvIMPACT::acquire::RTCtrProgram s can be stored and loaded from/to XML files. To do this, this property must be set to the desired filename.
|
protectedinherited |
PropertyIRTCtrlModes mode |
An enumerated integer property defining the current state this program is into.
In order to affect the behaviour of the image acquisition an mvIMPACT::acquire::RTCtrProgram must be in running mode. Apart from that the property triggerSource must be set appropriately.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TRTCtrlModes.
PropertyS programState |
A string property (read-only) containing information about the current state of the program.