DIAcceptSettingMap Struct Reference
[Generic Interfaces]
#include <Interfaces.h>
Inherits DIObjectBase.
Detailed Description
Interface to allow generic configuration of components using the DISettingMap interface.
This is a less generic version of DIAcceptConfiguration1. Its intention is for use at run time, when an implementation has multiple properties that the software would like to configure at once.
- Todo:
- Add functions to allow interrogation of what settings are supported, and inspection of the current values. Possible also default value interrogation.
- Todo:
- Consider making this more generic, copy functionality from the DIPhysicsBase design, where using a SettingMap is a shortcut for multiple Set calls.
|
Public Member Functions |
| bool | ParseSettingMap (DISettingMap *settings) |
| | Provide configuration data to the implementation.
|
Member Function Documentation
| bool DIAcceptSettingMap::ParseSettingMap |
( |
DISettingMap * |
settings |
) |
|
Provide configuration data to the implementation.
- Parameters:
-
| settings | The name-to-value mapping of configuration data. Any useful data should be copied out of this, as the provided object is not expected to be available after the function call. |
- Returns:
- Should return false if the information was not applied. This does not indicate an error condition, just that the information was not useful.
The documentation for this struct was generated from the following file:
