TheThing Members

Constructor of TheThing Creates the MyPropertyBag and Registered Event Tables

Adds a Thing Capability to TheThing

Removes all Events from TheThing

Frees up any history items that have already been returned at least once by a call to GetThingHistory. Call this when complete history is required and the history items have been successfully processed.

Clonse an incoming object into this object

Clones all existing properties and sub-properties in to the given OutThing

Clones all existing properties and sub-properties in to the given OutThing without setting any values (non-existent properties get a null value)

Clones the metadata of the current class to a new class provided to the method

This method is called by the NMI Service of the C-DEngine to initialize the NMI UX

Properties declared NMI properties will show up in the Property Table on NMI controls and Elements If the property does not exist, it will be created at runtime

This function allows to declare a secure Property Secure Properties are stored encrypted and can only be decrypted on nodes with the same ApplicationID and SecurityID. These properties are sent encrypted via the mesh. JavaScript clients CANNOT decrypt the value of the property!

Deletes this thing and all its resources

Fires the given Event. Every TheThing can register and Fire any Event on any event. New Events can be defined at Runtime, registered and fired

Fire an Event on a property

Forces to Flush all Property Changes currently in the Throttle Queue

Creates a ThePipelineConfiguration that only contains the configuration values needed to specialize a pipeline instance. This is typically used an answer file that instantiates a thing pipeline.

returns a list of all properties of TheThing Only top-level properties on TheThing will be returned. To return properties of properties, use the GetAllProperties(maxSubPropertylevel) override.

returns a list of all properties of TheThing and their sub-properties, up to the specified nesting level

Gets the BaseEngine of TheThing and caches it in TheThing - this is a performance optimization Tradeoff: TheThing will hold on to the Engine reference

Returns the BaseThing of a Thing. TheBaseThing is a serializable representation of a Thing. the ICDEThing interface requires the return of TheBaseThing as other classes can be inherited from ICDEThing. In case of TheThing, this method just returns "this"

Returns the names of properties in this thing that match the provided inclusion and exclusion lists.

retrieves all properties that have bit 7 (64) set in cdeF

Return the internal "object" associated with this TheThing

Returns all properties where the cdeM Meta Field starts with pName Only properties directly attached to TheThing will be returned

Returns all properties starting with a specific prefix

Returns a list of Properties starting with pName in the Name Only properties directly attached to TheThing will be returned

Returns a property of a given Name. If the property does not exist the method returns NULL

Returns a cdeP Property Object

Return the property type of a given property name. Returns ZERO if the property does not exist or the name is null/""

Returns a safe value of a given property as an object. Return can be null

Returns a (null) safe value of a given property as a boolean

Returns a (null) safe value of a given property as DateTimeOffset

Returns a (null) safe value of a given property as a Guid

Returns a (null) safe value of a given property as double

Returns a (null) safe value of a given property as string

Returns a (null) safe value of a given property as string

Sets the ID of a TheThing (SetProperty(pGuidName+"_ID",newGuid>);

Returns all properties that are marked as Sensors.

Returns all properties that are marked as coming from a sensor provider.

Returns the proper DataSource String for the given Thing

Retrieves any available history items since the last time GetThingHistory was called.

Retrieves any available history items since the last time GetThingHistory was called.

Return the configurations for a TheThing and all the TheThing instances that depend on the thing, or that this TheThing depends on.

Return the configurations for a TheThing and all the TheThing instances that depend on the thing, or that this TheThing depends on.

Hands a given TSM to a given Thing

All messages sent to TheThing will routed through this message handler The handle Message of TheBaseThing will be excuted SYNCHRON

Returns true if the event specified exists in the Eventing System of TheThing

This method is called by TheThingService of the C-DEngine when the Thing is loaded or registered in TheThingRegistry

Returns true if the requested eThingEvents has registered callbacks

Returns true if originating node is the node that owns the Thing

Must return true if TheThing was already initialized

Returns true if TheThing is managed on the current node

Must return true if the UX was already initialized

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

The MemberSet/Get functions are identical to the SetSafeProperty/GetSafeProperty functions, except that they get the property name from the calling member. They are used typically in the get{}/set{} methods of .Net Property declarations, for example:

C#

public bool MyProperty
{
  get { return MemberGetSafePropertyBool(MyBaseThing); }
}

In this example, the cdeP property name will be "MyProperty".

See MemberSetSafePropertyNumber(ICDEThing, Double, Boolean, String)

If called from a derived class and the class was stored in a StorageMirror, this method will call the "NotifyOfUpdate" method in the StorageMirror to inform all Notification Clients that this record has changed. This is VERY Expensive! Do not call too often! This does not work with StorageMirrors that require a PostSalt (unique table name)

Registers a new Event with TheThing New Events can be registerd and Fired at Runtime

Register a callback that will be fired on a Property Event

Register a callback that will be fired on a Property Event

Gathers history for property changes to the TheThing according to the filters specified in the parameters. Returns a token that can be used to retrieve history items for the filter. Each independent consumer needs to obtain a token of their own. Tokens can be reused across restarts if permanent=true is specified. Otherwise a new token must be obtained after a restart. Tokens must be unregistered when the history filter is no longer needed in order to free up system resources, especially if the consumer was registered as permanent.

Registers a new OnPropertyChange Event Callback

Registers a new property with TheThing at runtime

registers a function that is called when the StatusLevel of this Thing has changed

Removes all properties with a given prefix from TheThing at Runtime Only properties directly attached to a thing will be deleted.

Removes a property from TheThing at Runtime

Restarts history retrieval from the point when ClearUpdateHistory was last called. Call this when complete history is required, and a failure during processing requires a retry. For durable history tokens, call this after a restart.

Restarts history retrieval from the point when ClearUpdateHistory was last called. Call this when complete history is required, and a failure during processing requires a retry. For durable history tokens, call this after a restart.

Restarts history retrieval from the point when ClearUpdateHistory was last called. Call this when complete history is required, and a failure during processing requires a retry. For durable history tokens, call this after a restart.

Sets the BaseThing - only if the given pThing does not match "this"

This method sets and internal "object" in TheThing. The object is NOT serialized in TheThingRegistry but can be used to store any arbitrary class/object associated with TheThing

Sets multiple properties at once. Use with the Historian feature for a consistent snapshot that has all these property changes. If any of the properties do not exist, they will be created All Events (Change and Set) will be fired - even if the property has not changed The Property Type will be set as well

Sets a property If the property does not exist, it will be created

Sets a property If the property does not exist, it will be created All Events (Change and Set) will be fired - even if the property has not changed The Property Type will be set as well

Sets a property If the property does not exist, it will be created

Sets a property If the property does not exist, it will be created All Events (Change and Set) will be fired - even if the property has not changed The Property Type will be set as well

Sets a property If the property does not exist, it will be created The Property Type will be set as well

Sets a property If the property does not exist, it will be created The Property Type will be set as well

Sets a property If the property does not exist, it will be created All Events (Change and Set) will be fired - even if the property has not changed The Property Type will be set as well

Turns event on/off on a Property. If the property does not exist, it will be created

OBSOLETE: please dont use

Sets a property If the property does not exist, it will be created All Events (Change and Set) will be fired - even if the property has not changed

Sets a property from a "BagItem" - a "Name=Value" representation of a property

Sets a property If the property does not exist, it will be created The Property Change Events and Set Property events are NOT Fired

Sets the type of a property If the property does not exist, it will be created

sets a throttle time in milliseconds for all properties of TheThing. Changes to properties will only be sent at a maximum sample rate given in pThrottleInMs TheThing will consolidate all changes in one SETP call. If a property changes multiple times only the last value will be used.2

A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TString"

A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TString"

A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TBoolean"

A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TDate"

A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TGuid"

A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TNumber"

A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TString"

Sets a property If the property does not exist, it will be created

Convience method to set StatusLevel and LastMessage in one call. LastMessage will be prefixed with the current date/time. The message will also be logged in the C-DEngine EventLog.

Convience method to set StatusLevel and LastMessage in one call. LastMessage will be prefixed with the current date/time, using the session (user's) locale settings. The message will also be logged in the C-DEngine EventLog.

Returns a string representation of TheThing cdeMID - The unique ID of TheThing

Unregisters a callback for a given Event Name

Unregister a previously registered callback

Unregister a previously registered callback

Unregisters a function that is called when the StatusLevel of this Thing has changed

Removes the history filter for the historyToken. Call this to free up system resources. Subsequent calls to any APIs with this token will fail.

Shortcut for "SetProperty("Address",value);

Returns a list of capabilities of TheThing. Can be used to Build "Thing Models"

Access Level Mask 0=Everyone; 1=Untrusted Guest; 2=Trusted Guest; 4=Trusted Member1; 8=Trusted Member2; 16=Truested Member3; 32=Senior Member 1; 64=Senior Member 2; 128=Admin;

Availability of this record The higher this number the higher the availability of this record The Storage Service might store the data in multiple location to ensure maximum availability

Timestamp of this class. Will be set to DateTimeOffset.Now on creation of the Class

Expiration in Seconds of the class If a derived class is stored in a StorageMirror and cdeEXP is set to>0, the StorageMirror will automatically delete this record after the time has passed

Feature ID

The Cookie or Meta information for this class

Unique Key for the class derived from TheDataBase. this will be used in the StorageService as the Unique Index in the SQL Tables

Guid of Hosting Node - new in 4.108: Moved from MetaDataBase to here

Owner Guid

Priority of this record. A lower number means a higher priority. Data with higher priority will be retrieved faster than those with lower prio

Sequence number

User ID owning this resource

Shortcut for "SetProperty("DeviceType",value);

Shortcut for "SetProperty("EngineName",value);

Shortcut for "SetProperty("FriendlyName",value);

A property representation of IsAlive() in order for easy serialization and UX display

Shortcut for "SetProperty("ID",value);

Indicates since when an Init() called has been started but not completed. Returns DateTimeOffset.MinValue if Init() has not been called or has completed.

Can be used to Quickly Disable a Thing. Shortcut for "SetProperty("IsDisable", value).

The Thing will be running but does not show on the NMI ever. Shortcut for "SetProperty("IsHidden", value).

A property representation of IsInit() in order for easy serialization and UX display

Indicates if Init() has been called, but not completed.

A property representation of IsUXInit() in order for easy serialization and UX display

Sets the last message of the Thing. This can be used for status, error or other messages. Shortcut for "SetProperty("LastMessage", value).

Shortcut for "SetProperty("LastUpdate",value);

The Main PropertyBag. ATTENTION: Direct Manipulation of MyPropertyBag will not fire any events and circumvents encryption and other API based management. Only access this Bag if you know exactly what you are doing. NOTE: It is possible that we remove access to the Bag in a later version of the C-DEngine - do not rely on its access availability

Shortcut for "SetProperty("Parent",value);

Returns a count of all current Properties Only properties on TheThing will be counted.

Shortcut for "SetProperty("Status",value); 0=Not Running 1=OK 2=warning 3=Failure 4=Ramp Up 5=Engineering 6=Shutdown 7=Unknown/not visible

Shortcut for "SetProperty("UID",value);

Shortcut for "SetProperty("Value",value);

Shortcut for "SetProperty("Version",value);

Multicast event for property change notifications.