GREET API
Exposed interfaces to create modules that can be loaded in GREET
 All Classes Namespaces Files Functions Enumerations Enumerator Properties Events
PlugInsInterfaces.DataTypes.IProject Interface Reference

Object representing the collection of entities of a loaded project More...

Public Member Functions

XmlNode GetPluginXML (IPlugin plugin)
 Returns a copy of the node reserved for this plugin. Modifications to this node will not be saved to the file In order to save to the database, please use the method PushPluginXML(IPlugin plugin, XmlNode node); More...
 
XmlDocument GetProjectDocument ()
 Returns a copy of the project document. Modifications to this document will not be saved to the file More...
 
int PushPluginXML (IPlugin plugin, XmlNode node)
 Returns a node based on the class name of the plugin. This is a copy of the original one. In order to save to the database, please use the method string SaveProject(IProject project, string fileName);; More...
 

Properties

IData Dataa [get, set]
 Entities of the loaded database More...
 
List< IMonitorMonitorValues [get]
 Monitored values More...
 

Detailed Description

Object representing the collection of entities of a loaded project

Definition at line 15 of file IProject.cs.

Member Function Documentation

XmlNode PlugInsInterfaces.DataTypes.IProject.GetPluginXML ( IPlugin  plugin)

Returns a copy of the node reserved for this plugin. Modifications to this node will not be saved to the file In order to save to the database, please use the method PushPluginXML(IPlugin plugin, XmlNode node);

Parameters
pluginThe current plugin
XmlDocument PlugInsInterfaces.DataTypes.IProject.GetProjectDocument ( )

Returns a copy of the project document. Modifications to this document will not be saved to the file

int PlugInsInterfaces.DataTypes.IProject.PushPluginXML ( IPlugin  plugin,
XmlNode  node 
)

Returns a node based on the class name of the plugin. This is a copy of the original one. In order to save to the database, please use the method string SaveProject(IProject project, string fileName);;

Parameters
pluginThe current plugin
nodeThe node to be pushed to the database
Returns
0 The node is valid can be saved, -1 the root node must match the plugin class name

Property Documentation

IData PlugInsInterfaces.DataTypes.IProject.Dataa
getset

Entities of the loaded database

Definition at line 21 of file IProject.cs.

List<IMonitor> PlugInsInterfaces.DataTypes.IProject.MonitorValues
get

Monitored values

Definition at line 27 of file IProject.cs.


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