Greet 2014
Documentation for the GREET 2014 API
 All Classes Namespaces Functions Variables Enumerations Properties Events
Greet.DataStructureV3.Interfaces.IProject Interface Reference

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

Inheritance diagram for Greet.DataStructureV3.Interfaces.IProject:
Greet.DataStructureV3.GProject

Public Member Functions

XmlNode GetPluginXML (string pluginName)
 
XmlDocument GetProjectDocument ()
 Returns a copy of the project document. Modifications to this document will not be saved to the file More...
 
int PushPluginXML (string plugin, XmlNode node)
 

Properties

IData Data [get, set]
 Entities of the loaded database More...
 
List< IMonitorMonitorValues [get]
 Monitored values More...
 
int Version [get, set]
 Get or sets the version number of the project More...
 

Detailed Description

Object representing the collection of entities of a loaded project

Member Function Documentation

XmlNode Greet.DataStructureV3.Interfaces.IProject.GetPluginXML ( string  pluginName)

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 IProject.PushPluginXML(APlugin plugin, XmlNode node);

Parameters
pluginThe current plugin

Implemented in Greet.DataStructureV3.GProject.

XmlDocument Greet.DataStructureV3.Interfaces.IProject.GetProjectDocument ( )

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

Implemented in Greet.DataStructureV3.GProject.

int Greet.DataStructureV3.Interfaces.IProject.PushPluginXML ( string  plugin,
XmlNode  node 
)

Pushing an XML node to the project will automatically set a "project modified" flag, that way the user will be prompted to save his file before quitting

In order to save the project and all the data it contains to a file, please use the method string IGREETController.SaveProject(IProject project, string fileName)

Parameters
pluginThe current plugin
nodeThe node to be pushed to the database
Returns
-1 if the name of the node, 0 if the node has been inserted, +1 if the node replaces an existing one

May throw an exceltion if the XmlNode is not created using the same Owner document or contains XMLDeclarations that should no be inserted, see Inner Exception

Implemented in Greet.DataStructureV3.GProject.

Property Documentation

IData Greet.DataStructureV3.Interfaces.IProject.Data
getset

Entities of the loaded database

List<IMonitor> Greet.DataStructureV3.Interfaces.IProject.MonitorValues
get

Monitored values

int Greet.DataStructureV3.Interfaces.IProject.Version
getset

Get or sets the version number of the project


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