AP&C API Reference
Public Member Functions | Properties | List of all members
Apac.Configuration.PluginAttribute Class Reference

A class attribute that indicates the implementation can be used as a plugin and describes the specifics of the plugin for the implemenation.
The type of interface the implemenation provides indicates the type of plugin and hence where it is used in the system. Subclasses may add properties for more detailed plugin configurations. More...

Inheritance diagram for Apac.Configuration.PluginAttribute:
Apac.Configuration.MeasurementFormulaAttribute

Public Member Functions

 PluginAttribute (string id, Type resourceType, string nameKey, string descriptionKey, string instructionsKey, Type type)
 Initializes a new instance of the PluginAttribute class with an unlimited expected number of readings. More...
 

Properties

virtual PluginDescriptor Descriptor [get]
 Gets the descriptor that details the plugin decorated by this attribute. More...
 

Detailed Description

A class attribute that indicates the implementation can be used as a plugin and describes the specifics of the plugin for the implemenation.
The type of interface the implemenation provides indicates the type of plugin and hence where it is used in the system. Subclasses may add properties for more detailed plugin configurations.

Constructor & Destructor Documentation

◆ PluginAttribute()

Apac.Configuration.PluginAttribute.PluginAttribute ( string  id,
Type  resourceType,
string  nameKey,
string  descriptionKey,
string  instructionsKey,
Type  type 
)
inline

Initializes a new instance of the PluginAttribute class with an unlimited expected number of readings.

Parameters
idThe id - a GUID in string form.
resourceTypeThe type used to access the resource keys.
nameKeyThe key used to load the name from resourceType .
descriptionKeyThe key used to load the description from resourceType .
instructionsKeyThe key used to load the instructions from resourceType .
typeThe type.

Property Documentation

◆ Descriptor

virtual PluginDescriptor Apac.Configuration.PluginAttribute.Descriptor
get

Gets the descriptor that details the plugin decorated by this attribute.

The descriptor.


The documentation for this class was generated from the following file: