ConfigurationParameters Class
A class for specifying dynamic parameters when loading a configuration file.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class ConfigurationParameters : EngineObjectRemarks
This class is used to pass parameters from the application "into" a configuration as it is loaded. For instance, an application may at startup determine the location of some data files, and pass this to the configuration in the constructor. In the configuration file, the value can be retrieved using a ConfigurationParameter utility object, and used as the data directory for a dataset.
The supported value types are integers, doubles, bools, strings and atoms. In the configuration, any value of these types may be replaced by a ConfigurationParameter object. The application should pass a corresponding value by calling the appropriate Add method on this class.
In the configuration, default values may be specified if the application does not supply a value. However, if a value is supplied, but of the wrong type, an exception will be thrown.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ConfigurationParameters
Platforms
Windows, Linux, Android
ConfigurationParameters Members
The ConfigurationParameters type has the following members.
Constructors
| Name | Description |
|---|---|
| ConfigurationParameters | Initializes a new instance of the ConfigurationParameters class. |
Properties
| Name | Description |
|---|---|
| IsDisposed | Gets a value that tells whether the current ConfigurationParameters has been disposed. Inherited from EngineObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current ConfigurationParameters represents. Inherited from EngineObject |
Methods
| Name | Description |
|---|---|
| Add | Overloaded. Adds a new configuration parameter. |
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |