Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Objects.Tasks.TaskAttribute Class Reference

Annotates a method in a class as a recurring task. Must use binding extension to active More...

Inheritance diagram for pluginbase.Objects.Tasks.TaskAttribute:
pluginbase.Helpers.Attributes.ScopeAttribute

Public Member Functions

 TaskAttribute (double freqSeconds)
 Initializes a new instance of the pluginbase.Objects.Tasks.TaskAttribute class. More...
 
 TaskAttribute (double freqSeconds, object scopeEnum)
 Initializes a new instance of the pluginbase.Objects.Tasks.TaskAttribute class. More...
 
- Public Member Functions inherited from pluginbase.Helpers.Attributes.ScopeAttribute
 ScopeAttribute ()
 
 ScopeAttribute (object scopeEnum)
 
bool HasScope (Enum scope)
 
override string ToString ()
 

Public Attributes

readonly TimeSpan Frequency
 The frequency of the running task More...
 

Additional Inherited Members

- Public Types inherited from pluginbase.Helpers.Attributes.ScopeAttribute
enum  Special { Special.Wildcard }
 
- Properties inherited from pluginbase.Helpers.Attributes.ScopeAttribute
Enum Scope [get, set]
 
bool IsFlags [get]
 
bool ScopeDefined [get]
 

Detailed Description

Annotates a method in a class as a recurring task. Must use binding extension to active

Attribute: AttributeUsage(AttributeTargets.Method, AllowMultiple = true, Inherited = true)

Constructor & Destructor Documentation

pluginbase.Objects.Tasks.TaskAttribute.TaskAttribute ( double  freqSeconds)

Initializes a new instance of the pluginbase.Objects.Tasks.TaskAttribute class.

Parameters
freqSecondsFrequqnecy of task in seconds.
23  :this(freqSeconds, null)
24  { }
pluginbase.Objects.Tasks.TaskAttribute.TaskAttribute ( double  freqSeconds,
object  scopeEnum 
)

Initializes a new instance of the pluginbase.Objects.Tasks.TaskAttribute class.

Parameters
freqSecondsFreq of tasks in seconds.
scopeEnumScopes that apply, comma separated
32  : base(scopeEnum)
33  {
34  this.Frequency = TimeSpan.FromSeconds(freqSeconds);
35  }
readonly TimeSpan Frequency
The frequency of the running task
Definition: TaskAttribute.cs:16

Member Data Documentation

readonly TimeSpan pluginbase.Objects.Tasks.TaskAttribute.Frequency

The frequency of the running task


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