cdeP Members
The cdeP type exposes the following members.
Constructors
Name | Description | |
---|---|---|
cdeP()()()() |
Constructor of a new Property
|
|
cdeP(cdeP) |
Creates a new property from an exiting property
|
|
cdeP(String, Object) |
Creates a temporary new Property that is not bound to a TheThing and will not be made persistant
|
|
cdeP(ICDEThing) |
Constructor of a new property
|
|
cdeP(ICDEThing, Action<(Of <<'(cdeP>)>>)) |
Constructor of a new Property setting the Owner-Thing and an OnProperty Change event
|
Methods
Name | Description | |
---|---|---|
AreValuesDifferent |
A static function that allows to compare two property-values of a given Property Type
|
|
ClearAllEvents |
Removes all Events from cdeP
|
|
CloneBase |
Clonse an incoming object into this object
(Inherited from TheDataBase.) |
|
CloneTo |
Clones the metadata of the current class to a new class provided to the method
(Inherited from TheMetaDataBase.) |
|
DeclareSecureProperty |
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!
|
|
Equals(System.Object) | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
FireEvent(String, Boolean, Int32) |
Fire an Event on a property
|
|
FireEvent(String, TheProcessMessage, Boolean, Int32) |
Fire an Event on a property
(Inherited from TheDataBase.) |
|
GetAllProperties()()()() |
returns a list of all sub-properties of the cdeP
Only properties directly attached to a this property will be returned.
|
|
GetAllProperties(Int32) |
returns a list of all sub-properties of the cdeP as well as their sub-properties up to the specified nesting level
|
|
GetConfigMeta |
Helper function to retrieve the configuration meta-data for this property from the corresponding sub-properties
|
|
GetHashCode | (Inherited from Object.) | |
GetParentProperty |
Returns the parent property of a given property if it has a parent
|
|
GetPropertiesMetaStartingWith |
Returns all properties where the cdeM Meta Field starts with pName
Only properties directly attached to a this Property will be returned.
|
|
GetPropertiesStartingWith |
Returns a list of Properties starting with pName in the Name
Only properties directly attached to a this Property will be returned.
|
|
GetProperty(String) |
Returns a property of a given Name. If the property does not exist the method returns NULL
|
|
GetProperty(String, Boolean) |
Returns a property of a given Name. If the property does not exist the method returns NULL
|
|
GetPropertyPath |
Returns the Hirarchically property path of a given property
|
|
GetPropertyType |
Return the property type of a given property name. Returns ZERO if the property does not exist or the name is null/""
|
|
GetSensorMeta | ||
GetSensorProviderInfo | ||
GetThing |
Return the OwnerThing of this property
|
|
GetType | (Inherited from Object.) | |
GetUpdater |
Returns the Updater Guid
|
|
GetValue |
Use this method to ensure the correct value of a Property.
If cdeE|1 is set, the property value is stored encrypted and only this method returns the correct Value
|
|
HasRegisteredEvents(String) |
Returns true if the requested eThingEvents has registered callbacks
|
|
HasRegisteredEvents()()()() |
Returns true if this property has registered events
|
|
HasThing |
Returns true if the property has an Owner-Thing
|
|
IsEventRegistered |
Returns true if the requested eThingEvents has registered callbacks
(Inherited from TheDataBase.) |
|
MemberwiseClone | (Inherited from Object.) | |
NotifyMirror |
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)
(Inherited from TheDataBase.) |
|
OnPropertyChanged | (Inherited from TheBindableBase.) | |
RegisterEvent(String, Action<(Of <<'(cdeP>)>>)) |
Register a callback that will be fired on a Property Event
|
|
RegisterEvent(String, Action<(Of <<'(Object, TheProcessMessage>)>>)) |
Register a callback that will be fired on a Property Event
(Inherited from TheDataBase.) |
|
RegisterEvent2 |
Register a callback that will be fired on a Property Event
(Inherited from TheDataBase.) |
|
RegisterGlobally |
If this function is called, the Property will be known globally on all nodes
|
|
RegisterOnChange |
Registers a new OnPropertyChange Event Callback
|
|
RegisterProperty |
Registers a new property with TheThing at runtime
|
|
RegisterStatusChanged |
registers a function that is called when the StatusLevel of this Thing has changed
|
|
RemovePropertiesStartingWith |
Removes all properties with a given prefix from TheThing at Runtime
Only properties directly attached to a this Property will be deleted.
|
|
RemoveProperty |
Removes a property from TheThing at Runtime
|
|
ResetUpdater |
Resets the Updater
|
|
SetConfigMeta |
Helper function to set the sub-properties containing configuration meta-data for this property.
|
|
SetProperties |
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
|
|
SetProperty(String, Object) |
Sets a property
If the property does not exist, it will be created
|
|
SetProperty(String, Object, ePropertyTypes) |
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
|
|
SetProperty(String, Object, Int32, Action<(Of <<'(cdeP>)>>)) |
Sets a property
If the property does not exist, it will be created
|
|
SetProperty(String, Object, ePropertyTypes, Int32, Action<(Of <<'(cdeP>)>>)) |
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
|
|
SetProperty(String, Object, DateTimeOffset) |
Sets a property
If the property does not exist, it will be created
The Property Type will be set as well
|
|
SetProperty(String, Object, ePropertyTypes, DateTimeOffset, Int32, Action<(Of <<'(cdeP>)>>)) |
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
|
|
SetProperty``1(UMP%, UMP, Int32, Int32, String) | (Inherited from TheBindableBase.) | |
SetPropertyEvents | Obsolete.
Turns event on/off on a Property.
|
|
SetPropertyForceEvents |
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
|
|
SetPropertyNoEvents |
Sets a property
If the property does not exist, it will be created
The Property Change Events and Set Property events are NOT Fired
|
|
SetPropertyTypeOnly |
Sets the type of a property
If the property does not exist, it will be created
|
|
SetPublication |
Set the PublisCentral bit on the cdeFOC. The requestor is the node requesting the PC
|
|
SetSafeProperty(cdeP, String, Object, ePropertyTypes, Boolean) |
A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TString"
|
|
SetSafeProperty(cdeP, String, Object, ePropertyTypes, Boolean, Boolean) |
A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TString"
|
|
SetSafePropertyBool |
A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TBoolean"
|
|
SetSafePropertyDate |
A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TDate"
|
|
SetSafePropertyGuid |
A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TGuid"
|
|
SetSafePropertyNumber |
A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TNumber"
|
|
SetSafePropertyString |
A type/null save helper to Store a Numeric value in a given property. The target property type will be set to "TString"
|
|
SetSensorMeta | ||
SetSensorProviderInfo | ||
SetThing |
Sets the Owner-Thing of a Property
|
|
SetUpdater |
Sets an Updater Guid for the Property. The updater can check if an OnPropertyChange was fired by itself
|
|
ToString |
Returns a string representation of the Property Value
|
|
UnregisterEvent(String, Action<(Of <<'(cdeP>)>>)) |
Unregister a previously registered callback
|
|
UnregisterEvent(String, Action<(Of <<'(Object, TheProcessMessage>)>>)) |
Unregister a previously registered callback
(Inherited from TheDataBase.) |
|
UnregisterEvent2 |
Unregister a previously registered callback
(Inherited from TheDataBase.) |
|
UnregisterStatusChanged |
unregisters a function that is called when the StatusLevel of this Thing has changed
|
Properties
Name | Description | |
---|---|---|
cdeA |
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;
(Inherited from TheMetaDataBase.) |
|
cdeAVA |
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
(Inherited from TheDataBase.) |
|
cdeCTIM |
Timestamp of this class. Will be set to DateTimeOffset.Now on creation of the Class
(Inherited from TheDataBase.) |
|
cdeE |
Extended Property Flags
Bit 1(1) If set to TRUE, all storage and communication for this property has to be encrypted
Bit 2(2) If Set to TRUE, the Property Update will be sent with Queue Prio 1 (Fastest Sending using FILO)
Bit 3(4) If set to TRUE, the CTIM of the Property will be automatically set to DateTimeOffset.Now if the property was changed.
Bit 4(8) If set to TRUE, the property will ALWAYS update - no mater if the old value= new value ("forceWrite")
Bit 5(16) if Set to TRUE, the property will NOT be sent via initial NMI_SET_DATA to browsers, only updates are sent
Bit 7(64)=Property is NMI related
|
|
cdeEXP |
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
(Inherited from TheDataBase.) |
|
cdeF |
Feature ID
(Inherited from TheMetaDataBase.) |
|
cdeM |
The Cookie or Meta information for this class
(Inherited from TheMetaDataBase.) |
|
cdeMID |
Unique Key for the class derived from TheDataBase. this will be used in the StorageService as the Unique Index in the SQL Tables
(Inherited from TheDataBase.) |
|
cdeN |
Guid of Hosting Node - new in 4.108: Moved from MetaDataBase to here
(Inherited from TheDataBase.) |
|
cdeO |
Owner Guid
(Inherited from TheMetaDataBase.) |
|
cdePB |
The Proptery Bag of a Property.
ATTENTION: Direct Manipulation of cdePB 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
|
|
cdePRI |
Priority of this record.
A lower number means a higher priority.
Data with higher priority will be retrieved faster than those with lower prio
(Inherited from TheDataBase.) |
|
cdeSEQ |
Sequence number
(Inherited from TheMetaDataBase.) |
|
cdeT |
Type of Property
0=String
1=Number
2=boolean
3=Date
4=Binary
5=Function
6=Guid
|
|
cdeU |
User ID owning this resource
(Inherited from TheMetaDataBase.) |
|
HasChanged |
Returns true if theproperty has changed during the last SetProperty. If false, the last SetProperty tried to write the same value
|
|
IsConfig | ||
IsSensor | ||
Name |
Name of the property
|
|
PropertyCount |
Returns a count of all current Properties
Only properties directly attached to a this Property will be counted.
|
|
Value |
The current value of the property.
ATTENTION: If the value is stored encrypted, this property return the encrypted value NOT the unencrypted value!
Is is required for proper serialization/deserialization.
Use .GetValue() instead for proper decrypted value
|
Events
Name | Description | |
---|---|---|
PropertyChanged |
Multicast event for property change notifications.
(Inherited from TheBindableBase.) |