TheNMIEngine Methods
The TheNMIEngine type exposes the following members.
Methods
Name | Description | |
---|---|---|
AddAboutButton(TheThing, Boolean, String, Int32, String) |
Adds the standard about button to a plugin
|
|
AddAboutButton(TheThing, TheDashboardInfo, String, Boolean, String, Int32, String) |
Adds the standard about button to a plugin
|
|
AddAboutButton4 | ||
AddChartControl(TheThing, TheChartDefinition, TheFormInfo, Int32, String, String, Boolean, ThePropertyBag) | ||
AddChartControl<(Of <<'(T>)>>)(TheThing, TheStorageMirror<(Of <<'(T>)>>), TheFormInfo, Int32, String, String, String, String, ThePropertyBag) |
Adds a new Chart control to a Form
|
|
AddChartDefinition |
Adds a new Chart Definition to the NMI Model
|
|
AddChartScreen(TheThing, TheChartDefinition, Int32, Int32, Int32, String, Boolean, ThePropertyBag) |
Adds a new Chart Screen to the NMI. To render this screen the CMyCharts plugin is required on a node in the mesh
|
|
AddChartScreen(TheThing, TheChartDefinition, Int32, String, Int32, Int32, String, Boolean, ThePropertyBag) |
Create a new Chart Screen returning a dictionary of TheMetaDataBase that can be mapped:
"Form" TheFormInfo; "DashIcon" TheDashPanelInfo of the icon in the Dashboard; "Group" TheFieldInfo of the Collapsible Header group; "Chart" TheFieldInfo of the Chart Control
|
|
AddCommonTableColumns |
Adds the common table columns to a table: "Details (if not disabled), FriendlyName, StatusLevel,DeviceType (if set), Address (if not disabled), Delete Button"
Only tables based on TheThings are supported
|
|
AddConnectivityBlock(TheThing, TheFormInfo, Int32, Action<(Of <<'(TheProcessMessage, Boolean>)>>), Boolean, Int32, String, String) |
This adds the default Connectivity Block to the NMI Form. A connectivity block consists of AutoConnect, Is Connected, Address Field, Connect/Disconnect Buttons
|
|
AddConnectivityBlock(TheThing, TheFormInfo, Int32, Int32, Action<(Of <<'(TheProcessMessage, Boolean>)>>), Boolean, ThePropertyBag) |
This adds the default Connectivity Block to the NMI Form. A connectivity block consists of AutoConnect, Is Connected, Address Field, Connect/Disconnect Buttons
|
|
AddDashboard |
Adds a new Dashbard to the NMI Model
|
|
AddDashPanel |
Add a new Dashpanel to a Dashboard
|
|
AddDashPanels |
Adds new DashPanels to a Dashboard
|
|
AddDynamicPropertySection | ||
AddField |
Adds a single field to a form and sets the FormID of the field to the Form.cdeMID
|
|
AddFields |
Adds a list of TheFieldInfo to a TheFormInfo (adds fields to a form)
|
|
AddForm |
Add a new Form to the NMI Model
|
|
AddForms |
Adds multiple forms to the NMI Model
|
|
AddFormToDashboard(TheThing, TheFormInfo, Int32, String, String, Int32, Int32, String, String, ThePropertyBag) |
This method creates an NMI Form and adds it to the Dashboard specified in the first parameter
|
|
AddFormToDashboard(TheDashboardInfo, TheThing, TheFormInfo, Int32, String, String, Int32, Int32, String, String, ThePropertyBag) |
This method creates an NMI Form and adds it to the Dashboard specified in the first parameter
|
|
AddFormToThingUX(TheThing, TheFormInfo, String, String, Int32, Int32) |
This method creates an NMI Form and adds it to the Dashboard specified in the first parameter
|
|
AddFormToThingUX(TheThing, TheFormInfo, String, String, Int32, Int32, Int32, String, String, ThePropertyBag) |
This method creates an NMI Form and adds it to the Dashboard specified in the first parameter
|
|
AddFormToThingUX(TheDashboardInfo, TheThing, TheFormInfo, String, String, Int32, Int32, Int32, String, String, ThePropertyBag) |
This method creates an NMI Form and adds it to the Dashboard specified in the first parameter
|
|
AddLiveTagTable(TheThing, String, String) | ||
AddLiveTagTable(TheThing, String, String, String) |
Creates a new CMyForm of Live Tags for a given Device Type
|
|
AddLiveTagTable(TheThing, String, String, String, Int32) |
Creates a new default LiveTag Table and returns a dictionary of string, TheMetaDataBase that can be casted:
"Form" TheFormInfo; "DashIcon" TheDashPanelInfo of the icon in the Dashboard. All columns are mapped via "COL:FldOrder" as TheFieldInfo
|
|
AddNewTemplate(TheThing, Guid, String, String, Boolean, ThePropertyBag) | ||
AddNewTemplate(TheThing, Guid, String, Boolean, ThePropertyBag) | ||
AddNewTemplate(Guid, TheThing, Guid, String, Boolean, Int32) | ||
AddNewTemplate(Guid, Guid, TheThing, Guid, String, Boolean, Int32) | ||
AddNewTemplate<(Of <<'(T>)>>)(Guid, Guid, Guid, String, ThePropertyBag, Action<(Of <<'(T, TheClientInfo>)>>), Action<(Of <<'(T, TheClientInfo>)>>), Action<(Of <<'(T, TheClientInfo>)>>)) |
Adds a new custom wizard to the NMI Model
|
|
AddNewWizard(TheThing, Guid, String, ThePropertyBag, Action<(Of <<'(TheThing, TheClientInfo>)>>), Action<(Of <<'(TheThing, TheClientInfo>)>>)) |
Adds a new Wizard to the NMI Model
|
|
AddNewWizard<(Of <<'(T>)>>)(Guid, Guid, Guid, String, ThePropertyBag, Action<(Of <<'(T, TheClientInfo>)>>), Action<(Of <<'(T, TheClientInfo>)>>)) |
Adds a new custom wizard to the NMI Model
|
|
AddNewWizardPage |
Adds a new wizard page to the Form
|
|
AddPageBlocks |
Adds a list of ThePageBlocks to the NMI Model - blocks are referenced by ThePageContent in the WBID Field
|
|
AddPageContent |
Adds a list of ThePageContent to the NMI Model - Page Content can be listed in ThePageDefinition
|
|
AddPageDefinition |
Adds a new smart page to the system. In ThePageDefinition the parameter pPageName can be directly addressed in the browser
ATTENTION: Changing ThePageDefinition after the first start of the Relay will NOT use the latest parameter. You have to delete the Cache File 604n...
If you delete the file, all hit counter will be reset.
|
|
AddPageDefinitions |
Adds a new PageDefinition to the NMI Model
|
|
AddSmartControl(TheThing, TheFormInfo, eFieldType, Int32, Int32, Int32, String, String) |
Adds a control to a Form
|
|
AddSmartControl(TheThing, TheFormInfo, eFieldType, Int32, Int32, Int32, String, String, ThePropertyBag) |
Adds a control to a Form
|
|
AddSmartControl(TheThing, TheFormInfo, eFieldType, Int32, Int32, Int32, String, Boolean, String, Action<(Of <<'(TheFieldInfo, cdeP>)>>), ThePropertyBag) |
Adds a control to a Form
|
|
AddSmartIcon |
Adds a smart Icon to a Form
|
|
AddSmartPage(TheThing, IBaseEngine, String, String, Boolean, Boolean, Boolean, String, Boolean) |
Creats a direct access Page for a given Thing
|
|
AddSmartPage(TheFormInfo, IBaseEngine, String, String, Boolean, Boolean, Boolean) |
Creats a direct access Page for a given Form
|
|
AddSpacer |
Adds a spacer to a Form to create padding/margin in forms
|
|
AddStandardForm(TheThing, String, Int32, String, String, Int32, String) |
Creates the default NMI Style Form for a Thing. Returns a Dictionary of TheMetaDataBase items that can be casted to:
"Form" (TheFormInfo), "DashIcon" (TheDashPanelInfo), "Header" (TheFieldInfo)
|
|
AddStandardForm(TheThing, String, String, Int32, ThePropertyBag) |
Creates the default NMI Style Form for a Thing. Returns a Dictionary of TheMetaDataBase items that can be casted to:
"Form" (TheFormInfo), "DashIcon" (TheDashPanelInfo), "Header" (TheFieldInfo)
|
|
AddStartingBlock(TheThing, TheFormInfo, Int32, Action<(Of <<'(TheProcessMessage, Boolean>)>>), Int32, String, String) |
This adds the default Starting Block to the NMI Form.
|
|
AddStartingBlock(TheThing, TheFormInfo, Int32, Int32, Action<(Of <<'(TheProcessMessage, Boolean>)>>), ThePropertyBag) |
This adds the default Starting Block to the NMI Form.
|
|
AddStatusBlock(TheThing, TheFormInfo, Int32, Int32, Boolean) |
Adds a Status Block to a Form. It returns a Dictionary of created fields for Group,FriendlyName,StatusLevel,LastMessage,Value and NodeName
|
|
AddStatusBlock(TheThing, TheFormInfo, Int32, Int32, Boolean, ThePropertyBag) |
Adds a Status Block to a Form. It returns a Dictionary of created fields for Group,FriendlyName,StatusLevel,LastMessage,Value and NodeName
|
|
AddTableButtons |
Adds a Delete/Safe Button to a given Form/Table
|
|
AddTemplateButtons(TheThing, TheFormInfo, Int32) | ||
AddTemplateButtons(TheThing, TheFormInfo, Int32, Int32, Int32, String) | ||
AddTileBreak |
New V4.01: Adds a Page Break in the Dashboard Tiles
|
|
AddWizardControl |
Adds a new control to a Wizard
|
|
AddWizardExplainer |
Adds an explainer Text to a Wizard
|
|
AddWizardFinishPage |
Adds a Finish page to a wizard. The finish page will be displayed when the InsertB4 Callback is finished. in order for the finish page to show, the B4InsertCallback on a wizard has to be set
|
|
AddWizardProcessPage |
Add a processing page to the Wizard. A processing page should show the progress of the work a wizard is doing. At least a "processing please wait" and possibly a waiting icon or progress bar
|
|
AddWizardSpacer |
Adds a small blank Spacer Tile
|
|
CleanForm |
Removes all Field Definitions of a Form
|
|
CreateEngineForms(ICDEThing, Guid, String, String, Int32, Int32, Int32, String, String) |
This method creates an essential dashboard for plugins that have multiple sub-devices and a table that allows to add and remove new devices.
|
|
CreateEngineForms(TheThing, Guid, String, String, Int32, Int32, Int32, String, String, Boolean, String, String) |
This method creates an essential dashboard for plugins that have multiple sub-devices and a table that allows to add and remove new devices.
|
|
CreateForm |
Creates a new Form in the NMI Model - same as AddForm!
|
|
CreateUX |
Creates the basic NMI User Interface
|
|
Delete |
Will be called if this thing is deleted fromt TheThingRegistry
(Inherited from TheThingBase.) |
|
DeleteDashComponentById |
Delets a Dashboard Component by a given ID
|
|
DeleteFieldById |
Deletes a Field by a given Fld ID
|
|
DeleteFieldsByRange |
Deletes a list of fields from a form between a range of FldOrders
|
|
DeleteFieldsOfParent |
Delets all fields of a given ParentFld starting at a specific Field Order
|
|
DeleteFormById |
Deletes a form by a given FormID
|
|
Equals(System.Object) | (Inherited from Object.) | |
FillFieldPicker(TheProcessMessage, TheFieldInfo, String, String) |
Fills a ComboBox with the FriendlyName/Guid of things with a particular Boolean Property (bModelBool) set to true
|
|
FillFieldPicker(TheProcessMessage, TheFieldInfo, String, String, String) | ||
Finalize | (Inherited from Object.) | |
FireEvent |
Fire an event on this thing
(Inherited from TheThingBase.) |
|
GetAliveNMINodes |
Returns a list of all known and Alive NMI Nodes connected to this node
|
|
GetAllDashboards |
Returns a list of all defined Dashboard
|
|
GetBaseEngine |
Returns the BaseEngine of this plugin (called by the C-DEngine during startup)
(Inherited from ThePluginBase.) |
|
GetBaseThing |
Gets the Base Thing (MyBaseThing)
(Inherited from TheThingBase.) |
|
GetBlockByID |
Returns ThePageBlock by a given ID
|
|
GetChartByID |
Returns a Chart Definition by ID
|
|
GetControlTypeByPType |
This function returns the optimal TheControlType of a given Property Type
|
|
GetControlTypeByType |
Returns the TheControlType by a given Control Type name
|
|
GetCtrlTypeFromCDET |
Return the optimal NMI Control Type for a given PropertyType
|
|
GetDashboardById |
Returns a Dashboard by a given Dashboard ID
|
|
GetDashPanelById |
Gets a Dashpanel by a given Panel ID
|
|
GetEngineDashBoardByThing |
Returns the Dashboard of a given ICDEThing
|
|
GetEngineDashBoardGuidByThing |
Return the GUID of a Dashboard of a given ICDEThing
|
|
GetEnginePropertyByThing | Obsolete.
Returns a Property of the Engine of a given Thing
|
|
GetFieldByFldOrder |
Returns a specific field of a form by its FldOrder
|
|
GetFieldById |
Returns a field by a given Field ID
|
|
GetFieldsByFunc |
Returns a list of Fields by a given function
|
|
GetFormById |
Returns a Form but a given Form ID
|
|
GetHashCode | (Inherited from Object.) | |
GetNodeForCategory |
Returns the localized version of the StationName for Categories
|
|
GetPageByID |
Return ThePageDefinition by a given Page ID
|
|
GetPageByRealPage |
Gets ThePageDefinition by a given RealPage name (i.e. /NMIPortal)
|
|
GetPageContentByID |
Returns a Page by its Content ID
|
|
GetPages |
Gets all tracked pages.
|
|
GetProperty |
Gets a property by name
(Inherited from TheThingBase.) |
|
GetStatusColor |
Returns an HTML5 Color for each StatusLevel.
The colors can be customized by changing the "MyServiceHostInfo.StatusColors" list of colors
|
|
GetType | (Inherited from Object.) | |
HandleMessage |
Basic Message Handler of the NMI
|
|
HasRegisteredEvents |
Returns true if the given event has registered callbacks
(Inherited from TheThingBase.) |
|
Init |
Initializes the NMI Engine
|
|
InitEngineAssets |
Initializes the internal NMI Engine
|
|
IsCDEProperty(cdeP) |
returns true if the given property is a CDE Intrinsyc and internal property
|
|
IsCDEProperty(String) |
Returns true if the given property name is a well known C-DEngine property that should not be translated
|
|
IsControlRegistered |
Returns true if Control is registered
|
|
IsControlTypeRegistered |
Returns true if Control is registered
|
|
IsInit |
Returns true if this thing is initialized (mIsInitialized)
(Inherited from TheThingBase.) |
|
IsInitialized |
returns true of the NMI Model and the service is initialized
|
|
IsNMINodeAlive |
Returns true if the DeviceID given is known to the NMI Engine (has requested the Meta Information and sent Heartbeat Pings recently)
|
|
IsPageStoreReady |
Returns true when the PageStore is ready
|
|
IsUXInit |
Returns true if this thing's NMI is initialized (mIsUxInitialized)
(Inherited from TheThingBase.) |
|
LocNMI(Int32, TSM) |
Updates the PLS with a localized version of the PLS according to an LCID. ATTENTION: If ### is in PLS and the message was NOT meant to be translated, the content of PLS will change!
ENG must be set to the engine holding the strings
|
|
LocNMI(TheProcessMessage, TSM) |
Updates the PLS with a localized version of the PLS. ATTENTION: If ### is in PLS and the message was NOT meant to be translated, the content of PLS will change!
The LCID is processed using the Session State in TheProcessMessage
|
|
LocNMI(TheProcessMessage, String) |
Updates the string with a localized version of the PLS.
The LCID is processed using the Session State in TheProcessMessage
|
|
MemberwiseClone | (Inherited from Object.) | |
PageHitCounter |
Increases the Hit Counter on a given ThePageDefinition
|
|
ParseFacePlate(TheThing, String) | Obsolete.
Parses a HTML5 FacePlate for Property References
|
|
ParseFacePlate(TheThing, String, Guid) | Obsolete.
Parses a HTML5 FacePlate for Property References, this hsas Moved to Late Binding in TheFormGenerator.GetPermittedFields and is no longer required as a public call
|
|
ParseFacePlateUrl(TheThing, String) |
Parses a HTML5 FacePlate for Property References
|
|
ParseFacePlateUrl(TheThing, String, Boolean) |
Parses a HTML5 FacePlate for Property References
|
|
ParseFacePlateUrl(TheThing, String, Boolean, Guid) |
Parses a HTML5 FacePlate for Property References
|
|
RefreshDashboard |
Refreshes the specified dashboard.
If pMessage is set, the dashboard is sent to the originator in the TSM.
If pMessage is null, a Request to refresh is sent to the clients. They can then request the Dashboard but only if they have the premission to see the specified dashboard
|
|
RegisterControlType(IBaseEngine, String, String, String) |
Register a new Control with the NMI Engine. Registered controls can be used in Live Screens and any Plug-In InitUX() function
|
|
RegisterControlType(IBaseEngine, String, String) |
Register a new Control with the NMI Engine. Registered controls can be used in Live Screens and any Plug-In InitUX() function
|
|
RegisterEngine |
Registers an Engine with the NMI Service in order to provide resources
|
|
RegisterEvent |
Register a callback with an event of this Thing
(Inherited from TheThingBase.) |
|
RegisterSyncedTransform |
Register a new Transform File for a given user. If pUserID is Guid.Empty
|
|
SaveScreenOptions |
Allows to save Screen Options for a ModelID.
The ModelID of a screen has to be stored in the tScene.ID parameter;
|
|
SendThingRegistry | Obsolete. | |
SetBaseThing |
Sets the Base Thing (MyBaseThing)
(Inherited from TheThingBase.) |
|
SetProperty |
Sets a property with a value
(Inherited from TheThingBase.) |
|
SetScopeID |
Sets the scope ID on a specific request
|
|
SetUXProperty(Guid, Guid, String) |
Sets a Property on a NMI Control
|
|
SetUXProperty(Guid, Guid, String, String) |
Sets a Property on a NMI Control
|
|
SetUXProperty(Guid, Guid, String, String, String) |
Sets a Property on a NMI Control belonging to a Thing. SubControl defines "DASH", "FORM" or a column's FldOrder in a Table
|
|
ToString | (Inherited from Object.) | |
UnregisterEvent |
Unregister a callback from an event of this thing
(Inherited from TheThingBase.) |
|
UpdateMainFrameTemplate |
Updates the Main Frame-Template for all pages
|
|
UpdatePageBlocks |
Update blocks in the PageBlock store
|