Inspectable Class Reference
Interface for inspectable objects.
More...
#include <inspectable.h>
Inherited by AbstractController, AbstractModel, AbstractWiring, GenContext, Generation, InspectableProxy, IValue, StatisticTools, and WiredController.
List of all members.
Detailed Description
Interface for inspectable objects.
That means that one can read out some internal parameters indentified by string keys
Member Typedef Documentation
Constructor & Destructor Documentation
Member Function Documentation
void addInfoLine |
( |
std::string |
infoLine |
) |
[virtual] |
Adds an info line to this inspectable instance.
All infolines are plotted by the PlotOptionEngine and therefore appear e.g. in the logfile. They are leaded by a I. If you have your own identifiers, just begin with your one (e.g. N for number of NOTE: You must not add e.g. carriage return, all this is handled by the PlotOptionsEngine itself. If you like to add multiple lines, call this function a lot more or use instead addInfoLines.
- Parameters:
-
| infoLine | the line (as string) to be added |
void addInfoLines |
( |
std::list< std::string > |
infoLineList |
) |
[virtual] |
Adds a bunch of infolines with addInfoLine to this inspectable instance.
Every infoline is separated by an carriage return automatically, done by the PlotOptionsEngine.
- Parameters:
-
| infoLineList | the infoLines to be added as a string list. |
void addInspectableDescription |
( |
const iparamkey & |
key, |
|
|
const std::string & |
descr | |
|
) |
| | [virtual] |
adds a description for the given parameter using info-lines The line will start (appart from the I) with a D for description followed by the key end then followed by the string.
- Parameters:
-
| key | parameter name (no spaces allowed) |
| descr | descriptive string (no newlines allowed) |
void addInspectableMatrix |
( |
const iparamkey & |
key, |
|
|
matrix::Matrix * |
m, |
|
|
bool |
only4x4AndDiag = true , |
|
|
const std::string & |
descr = std::string() | |
|
) |
| | [virtual] |
This is the new style for adding inspectable values.
Just call this function for each parameter and you are done. Inspects elements of the given matrix or vector (automatic detection) For Matrixes Either all or only the values given by store4x4AndDiagonalFieldNames(Matrix& m,string& matrixName); are used.
- Parameters:
-
| key | the name of the matrix, shown e.g. in guilogger (no spaces allowed) |
| m | the address of the matrix to inspect |
| only4x4AndDiag | of true only 4x4 matrix plus the diagonal is used |
| descr | description string to be exported (for the entire matrix with key_) (using infolines) |
- Note:
- that you can change the structure of the matrix while being inspected, but no after the getInternalParameterNames is called!
void addInspectableValue |
( |
const iparamkey & |
key, |
|
|
iparamval * |
val, |
|
|
const std::string & |
descr = std::string() | |
|
) |
| | [virtual] |
This is the new style for adding inspectable values.
Just call this function for each parameter and you are done. registers a single value
- Parameters:
-
| key | the name of the inspectable, shown e.g. in guilogger (no spaces allowed) |
| val | the address of the value to inspect |
| descr | description string to be exported (using infolines) |
const std::list< std::string > & getInfoLines |
( |
|
) |
const [virtual] |
Returns all infolines added to this inspectable instance.
This function is called by the PlotOptionEngine.
- Returns:
- all added infolines.
The list of the names of all internal parameters given by getInternalParams().
The naming convention is "v[i]" for vectors and "A[i][j]" for matrices, where i, j start at 0.
- Returns:
- : list of keys
Reimplemented in AbstractControllerAdapter, AbstractMultiController, BasicController, ClassicReinforce, DiscreteControllerAdapter, Elman, FFNNController, InvertMotorBigModel, MeasureAdapter, MultiLayerFFNN, MutualInformationController, OneActiveMultiPassiveController, ReplayController, use_java_controller, FeedbackWiring, and WiringSequence.
- Returns:
- : list of values
Reimplemented in AbstractControllerAdapter, AbstractMultiController, BasicController, ClassicReinforce, DiscreteControllerAdapter, Elman, FFNNController, InvertMotorBigModel, MeasureAdapter, MultiLayerFFNN, MutualInformationController, OneActiveMultiPassiveController, ReplayController, use_java_controller, FeedbackWiring, and WiringSequence.
- Examples:
- directconnect/directconnect.cpp.
be careful: matrices will be ignored
- Returns:
- list of values (pointer)
void removeInfoLines |
( |
|
) |
[virtual] |
Removes all infolines from this inspectable instance.
This is useful if you have new infoLines and would like to restart the PlotOptionEngine.
Member Data Documentation
The documentation for this class was generated from the following files: