A descriptive construct that provides metadata about a measurement formula plugin so that information can be used by the configuration subsystem without having to instantiate and hold a reference to the formula object itself. This is especially helpful when serialization is required (like with the remote client doing configuration). More...
Public Member Functions | |
| FormulaDescriptor (Guid id, string name, string description, string instructions, Type type) | |
| Initializes a new instance of the FormulaDescriptor class. More... | |
| FormulaDescriptor (PluginDescriptor descriptor) | |
| Initializes a new instance of the FormulaDescriptor class. More... | |
 Public Member Functions inherited from Apac.Configuration.PluginDescriptor | |
| PluginDescriptor (Guid id, string name, string description, string instructions, Type type) | |
| Initializes a new instance of the PluginDescriptor class. More... | |
| void | GetObjectData (SerializationInfo info, StreamingContext context) |
| Populates a T:System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object. More... | |
Protected Member Functions | |
| FormulaDescriptor (SerializationInfo info, StreamingContext context) | |
| Initializes a new instance of the FormulaDescriptor class. More... | |
| Protected Member Functions inherited from Apac.Configuration.PluginDescriptor | |
| PluginDescriptor (SerializationInfo info, StreamingContext context) | |
| Initializes a new instance of the PluginDescriptor class during binary deserialization. More... | |
Properties | |
| List< FormulaInputDescriptor > | Inputs [get] |
| Gets the input descriptors for the formula. More... | |
| Properties inherited from Apac.Configuration.PluginDescriptor | |
| Guid | Id [get] |
| Gets the id. More... | |
| string | Name [get] |
| Gets or sets the name of the formula. This is presented to the user when selecting formulae during configuration. More... | |
| string | Description [get] |
| Gets or sets a verbose description of the formula. More... | |
| string | Instructions [get] |
| Gets or sets instructions for use of the formula. This allows access to formula details needed to properly configure it. More... | |
| Type | Type [get, set] |
| Gets or sets the type of the plugin being described. Having this writable allows us to set it based on the class the attribute (containing this descriptor) is applied to. This eliminates one piece of data needed to attribute a plugin class using this method. More... | |
Detailed Description
A descriptive construct that provides metadata about a measurement formula plugin so that information can be used by the configuration subsystem without having to instantiate and hold a reference to the formula object itself. This is especially helpful when serialization is required (like with the remote client doing configuration).
Constructor & Destructor Documentation
◆ FormulaDescriptor() [1/3]
|
inlineprotected |
Initializes a new instance of the FormulaDescriptor class.
- Parameters
-
info The info. context The context.
◆ FormulaDescriptor() [2/3]
|
inline |
Initializes a new instance of the FormulaDescriptor class.
- Parameters
-
id The id. name The name. description The description. instructions The instructions. type The type.
◆ FormulaDescriptor() [3/3]
|
inline |
Initializes a new instance of the FormulaDescriptor class.
- Parameters
-
descriptor The descriptor.
Property Documentation
◆ Inputs
|
get |
Gets the input descriptors for the formula.
The documentation for this class was generated from the following file:
- /var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/FormulaDescriptor.cs
