Collapse All Expand All

C#

Clarion Library 6.1.1
ParameterSettingModule..::..ParameterSettingModuleParameters Class
ParameterSettingModule Class Members Example See Also Send Feedback

[This is preliminary documentation and is subject to change.]

This is parameters class for the ParameterSettingModule class

Namespace: Clarion.Framework.Extensions
Assembly: ClarionLibrary (in ClarionLibrary.dll) Version: 6.1.1.0 (6.1.1.0)

# Syntax

C#
    public class ParameterSettingModuleParameters : MetaCognitiveModule..::..MetaCognitiveModuleParameters

# Remarks

This class contains all of the parameters that may be used by the ParameterSettingModule class. All classes that extend ParameterSettingModule should also contain their own parameters class that extends this class and adds any parameters that are used by those classes. This is how all of the "built-in" modules within the Clarion Library have been implemented. It is HIGHLY recommended that users defining their own (custom) module follow this convention as well. Details on how to implement a parameters class for a custom module can be found in the Developer Tutorial upon request.

Note
The parameters classes can be found throughout the Clarion Library whenever a class contains parameters that may be set by a user. This concept was implemented to allow for some "special capabilities" and also to clean-up/streamline parameter usage throughout the system. The parameters classes enable parameters to be adjusted both locally and globally. In general, global parameter changes are performed statically through the GlobalParameters property and local parameter changes are performed on single instances through the Parameters property. Examples demonstrating how parameter adjustments may be performed using both methods can be found in the examples section.

Note
Global parameter settings are ONLY applicable prior to the initialization of an instance of a module. During the initialization process, the global parameter settings are used to set the "default" values of the local parameters for a module. Once initialized, the module will only use the local parameters. Therefore, global parameter changes SHOULD ALWAYS be performed BEFORE instances of a module are initialized.

Copyright 2011. Nicholas Wilson

# Examples

See the examples section of MetaCognitiveModule..::..MetaCognitiveModuleParameters

# Inheritance Hierarchy

System..::..Object
Clarion.Framework.Templates..::..MetaCognitiveModule..::..MetaCognitiveModuleParameters
Clarion.Framework.Extensions..::..ParameterSettingModule..::..ParameterSettingModuleParameters

# See Also

ParameterSettingModule..::..ParameterSettingModuleParameters Members
Clarion.Framework.Extensions Namespace