Helper Class Reference  1.1
HomeGenie - Automation Programs' Engine SDK
Public Member Functions | Properties | List of all members
ModuleParameter Class Reference

Module parameter. More...

Public Member Functions

bool Is (string name)
 Determines whether this instance has the given name. More...
 
bool WaitUpdate (double timeoutSeconds)
 Waits until this parameter is updated. More...
 

Properties

ValueStatistics Statistics [get]
 Gets the statistics. More...
 
string Name [get, set]
 Gets the name. More...
 
string Value [get, set]
 Gets or sets the value. More...
 
string Description [get, set]
 Gets or sets the description. More...
 
string FieldType [get, set]
 Gets or sets the type of the field. More...
 
DateTime UpdateTime [get, set]
 Gets the update time. More...
 
double DecimalValue [get]
 Gets the decimal value. More...
 
double IdleTime [get]
 Gets the idle time (time elapsed since last update). More...
 

Detailed Description

Module parameter.

Member Function Documentation

bool Is ( string  name)

Determines whether this instance has the given name.

Returns
true if this instance is name; otherwise, false.
Parameters
nameName.
bool WaitUpdate ( double  timeoutSeconds)

Waits until this parameter is updated.

Returns
true, if it was updated, false otherwise.
Parameters
timeoutSecondsTimeout seconds.

Property Documentation

ValueStatistics Statistics
get

Gets the statistics.

The statistics.

string Name
getset

Gets the name.

The name.

string Value
getset

Gets or sets the value.

The value.

string Description
getset

Gets or sets the description.

The description.

string FieldType
getset

Gets or sets the type of the field.

The type of the field.

DateTime UpdateTime
getset

Gets the update time.

The update time.

double DecimalValue
get

Gets the decimal value.

The decimal value.

double IdleTime
get

Gets the idle time (time elapsed since last update).

The idle time.


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