Encapsulates all user interaction for setting options, logging data and plotting results. More...
#include <user_interaction.hpp>
Public Member Functions | |
| virtual int | addPlotWindow (PlotWindow &_window) |
| virtual int | operator<< (PlotWindow &_window) |
| virtual int | operator<< (LogRecord &_record) |
| UserInteraction & | operator= (const UserInteraction &rhs) |
| UserInteraction () | |
| UserInteraction (const UserInteraction &rhs) | |
| virtual | ~UserInteraction () |
Protected Member Functions | |
| virtual returnValue | getPlotDataFromMemberLoggings (PlotWindow &_window) const |
| BlockStatus | getStatus () const |
| returnValue | setStatus (BlockStatus _status) |
Protected Attributes | |
| BlockStatus | status |
Detailed Description
Encapsulates all user interaction for setting options, logging data and plotting results.
The class UserInteraction encapsulates all user interaction for setting options, logging data and plotting results.
Definition at line 57 of file user_interaction.hpp.
Constructor & Destructor Documentation
Default constructor.
Definition at line 44 of file user_interaction.cpp.
| UserInteraction::UserInteraction | ( | const UserInteraction & | rhs | ) |
Copy constructor (deep copy).
- Parameters:
-
[in] rhs Right-hand side object.
Definition at line 50 of file user_interaction.cpp.
| UserInteraction::~UserInteraction | ( | ) | [virtual] |
Destructor.
Definition at line 56 of file user_interaction.cpp.
Member Function Documentation
| int UserInteraction::addPlotWindow | ( | PlotWindow & | _window | ) | [virtual] |
Adds a window to the plot collection. This function is overloaded here in order to add the plotDataRecord required to plot the window to the log collection.
- Parameters:
-
[in] _window Window to be added.
- Returns:
- >= 0: index of added record,
-RET_PLOT_COLLECTION_CORRUPTED
Reimplemented from Plotting.
Definition at line 84 of file user_interaction.cpp.
| returnValue UserInteraction::getPlotDataFromMemberLoggings | ( | PlotWindow & | _window | ) | const [protected, virtual] |
Copies all collected logging information required to plot a given window. This function is overloaded within the UserInterface class to syncronize the logging information collected elsewhere within the algorithm with the one stored within the given window for plotting.
- Parameters:
-
[in] _window Window to be plotted.
- Returns:
- SUCCESSFUL_RETURN
Reimplemented from Plotting.
Definition at line 111 of file user_interaction.cpp.
| BlockStatus UserInteraction::getStatus | ( | ) | const [protected] |
Gets current status of user interface.
- Returns:
- Current status of user interface
Definition at line 125 of file user_interaction.cpp.
| int UserInteraction::operator<< | ( | PlotWindow & | _window | ) | [virtual] |
Adds a window to the plot collection. This function is overloaded here in order to add the plotDataRecord required to plot the window to the log collection.
- Parameters:
-
[in] _window Window to be added.
- Note:
- This function is doing the same as the corresponding addPlotWindow member function and is introduced for syntax reasons only.
- Returns:
- >= 0: index of added record,
-RET_PLOT_COLLECTION_CORRUPTED
Reimplemented from Plotting.
Definition at line 77 of file user_interaction.cpp.
| int UserInteraction::operator<< | ( | LogRecord & | _record | ) | [virtual] |
Adds a record to the log collection.
- Parameters:
-
[in] record Record to be added.
- Note:
- This function tunnels the corresponding function of the Logging class. It is introduced to avoid syntax ambiguity only.
- Returns:
- >= 0: index of added record,
-RET_LOG_COLLECTION_CORRUPTED
Reimplemented from Logging.
Definition at line 97 of file user_interaction.cpp.
| UserInteraction & UserInteraction::operator= | ( | const UserInteraction & | rhs | ) |
Assignment operator (deep copy).
- Parameters:
-
[in] rhs Right-hand side object.
Definition at line 61 of file user_interaction.cpp.
| returnValue UserInteraction::setStatus | ( | BlockStatus | _status | ) | [protected] |
Sets status of user interface.
- Parameters:
-
[in] _status New status of user interface
- Returns:
- SUCCESSFUL_RETURN
Definition at line 131 of file user_interaction.cpp.
Member Data Documentation
BlockStatus UserInteraction::status [protected] |
Current status of the user interface, see documentation of BlockStatus for details.
Definition at line 165 of file user_interaction.hpp.
The documentation for this class was generated from the following files: