Apac.Configuration.PluginDescriptor Class Reference

A descriptive construct that describes a plugin so that description can be used by the configuration subsystem to pass around information about the plugin without having to instantiate the plugin itself. This is especially helpful when serialization is required (like with the remote client doing configuration). More...

Inheritance diagram for Apac.Configuration.PluginDescriptor:

Public Member Functions
	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
	PluginDescriptor (SerializationInfo info, StreamingContext context)
	Initializes a new instance of the PluginDescriptor class during binary deserialization. More...

Properties
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 describes a plugin so that description can be used by the configuration subsystem to pass around information about the plugin without having to instantiate the plugin itself. This is especially helpful when serialization is required (like with the remote client doing configuration).

Constructor & Destructor Documentation

PluginDescriptor() [1/2]

Apac.Configuration.PluginDescriptor.PluginDescriptor ( SerializationInfo  info, StreamingContext  context  )

inlineprotected

Initializes a new instance of the PluginDescriptor class during binary deserialization.

Parameters

info	The info.
context	The context.

PluginDescriptor() [2/2]

Apac.Configuration.PluginDescriptor.PluginDescriptor ( Guid  id, string  name, string  description, string  instructions, Type  type  )

inline

Initializes a new instance of the PluginDescriptor class.

Parameters

id	The id.
name	The name.
description	The description.
instructions	The instructions.
type	The type.

Member Function Documentation

GetObjectData()

void Apac.Configuration.PluginDescriptor.GetObjectData ( SerializationInfo  info, StreamingContext  context  )

inline

Populates a T:System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

Parameters

info	The T:System.Runtime.Serialization.SerializationInfo to populate with data.
context	The destination (see T:System.Runtime.Serialization.StreamingContext) for this serialization.

Exceptions

T:System.Security.SecurityException

The caller does not have the required permission.

Property Documentation

Description

string Apac.Configuration.PluginDescriptor.Description

get

Gets or sets a verbose description of the formula.

The description.

Id

Guid Apac.Configuration.PluginDescriptor.Id

get

Gets the id.

The id.

Instructions

string Apac.Configuration.PluginDescriptor.Instructions

get

Gets or sets instructions for use of the formula. This allows access to formula details needed to properly configure it.

The instructions.

Name

string Apac.Configuration.PluginDescriptor.Name

get

Gets or sets the name of the formula. This is presented to the user when selecting formulae during configuration.

The name.

Type

Type Apac.Configuration.PluginDescriptor.Type

getset

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.

---

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

• /var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/PluginDescriptor.cs