AdapterCommandAttribute Class

Represents an attribute that allows a method in an IAdapter class to be exposed as an invokable command.

Inheritance Hierarchy

SystemObject
SystemAttribute
GSF.TimeSeries.AdaptersAdapterCommandAttribute

Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.181-beta

Syntax

[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class AdapterCommandAttribute : Attribute

<AttributeUsageAttribute(AttributeTargets.Method)>
Public NotInheritable Class AdapterCommandAttribute
	Inherits Attribute

[AttributeUsageAttribute(AttributeTargets::Method)]
public ref class AdapterCommandAttribute sealed : public Attribute

[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Method)>]
type AdapterCommandAttribute = 
    class
        inherit Attribute
    end

GSF.TimeSeries.Adapters.AdapterCommandAttribute = function();

Type.createClass(
	'GSF.TimeSeries.Adapters.AdapterCommandAttribute',
	Attribute);

The AdapterCommandAttribute type exposes the following members.

Constructors

	Name	Description
	AdapterCommandAttribute(String)	Creates a new AdapterCommandAttribute with the specified description value.
	AdapterCommandAttribute(String, String)	Creates a new AdapterCommandAttribute with the specified description value.

Properties

	Name	Description
	AllowedRoles	Gets the roles which are allowed to invoke this adapter command.
	Description	Gets the description of this adapter command.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Remarks

Only public methods will be exposed as invokable.