Greet 2014
Documentation for the GREET 2014 API
 All Classes Namespaces Functions Variables Enumerations Properties Events
Greet.DataStructureV3.Entities.InputTables Class Reference

This class stores the input tables and tabs organization for the tables The tables are used for storing values that can be refered from any other places, or use in ExcelLike calculations /summary> More...

Public Member Functions

 InputTables ()
 Default constructuor, initialize empty dictionaries for the tabs and tables collections More...
 
InputTableObject GetValue (string valueReference)
 Get a value from the table inputs. Returns a table input object that can store either a DoubleValue object or a DoubleValueTS object More...
 
bool ReadDB (GData data, XmlNode inputsNode)
 Reads the data from an Input xmlNode More...
 
XmlNode ToXmlNode (XmlDocument xmlDoc)
 Saves the data of this object as an XML node More...
 

Properties

bool FullyLoaded [get, set]
 Returns true if this data was successfully loaded from the XML document if not loaded or only partially loaded, this will return false More...
 
InputTablesDictionary Tables [get, set]
 Collection of input tables. More...
 
Dictionary< int, InputTableTabTabs [get, set]
 The tables are organized by tabs. So in order to access a table object directly we need to know in which tab the table is located. More...
 

Detailed Description

This class stores the input tables and tabs organization for the tables The tables are used for storing values that can be refered from any other places, or use in ExcelLike calculations /summary>

Constructor & Destructor Documentation

Greet.DataStructureV3.Entities.InputTables.InputTables ( )

Default constructuor, initialize empty dictionaries for the tabs and tables collections

Member Function Documentation

InputTableObject Greet.DataStructureV3.Entities.InputTables.GetValue ( string  valueReference)

Get a value from the table inputs. Returns a table input object that can store either a DoubleValue object or a DoubleValueTS object

Parameters
valueReferenceThe value that needs to be retrieved, format used is [tableName ! Col-Letter Row-Number]
Returns
Returns an input table object, the Value attribute of that input table object will contain either a DoubleValue or a DoubleValueTS
bool Greet.DataStructureV3.Entities.InputTables.ReadDB ( GData  data,
XmlNode  inputsNode 
)

Reads the data from an Input xmlNode

Parameters
inputsNodeThe input xml node to parse and read data from
Returns
Return True if the file is successfully loaded, false if some error happened
XmlNode Greet.DataStructureV3.Entities.InputTables.ToXmlNode ( XmlDocument  xmlDoc)

Saves the data of this object as an XML node

Parameters
xmlDocThe XMLDocument object necessary for namespace URI
Returns
The XMLNode representation for this object

Property Documentation

bool Greet.DataStructureV3.Entities.InputTables.FullyLoaded
getset

Returns true if this data was successfully loaded from the XML document if not loaded or only partially loaded, this will return false

InputTablesDictionary Greet.DataStructureV3.Entities.InputTables.Tables
getset

Collection of input tables.

Dictionary<int, InputTableTab> Greet.DataStructureV3.Entities.InputTables.Tabs
getset

The tables are organized by tabs. So in order to access a table object directly we need to know in which tab the table is located.


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