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

Stores all the Parameter indexed by their unique ID, so they can be retreived from anywhere in the code using the created database. More...

Inheritance diagram for Greet.DataStructureV3.Entities.Parameters:

Public Member Functions

void AddValue (IParameter value)
 
Parameter CreateRegisteredParameter (string unitOrGroup, double defaultValue, double userValue=0, string uniqueID="1")
 Creates and adds a new parameter to the model assigns the the parameter the ID given or a random integer assigns the CreatedBy CreatedOn ModifiedBy ModifiedOn attributes of the parameter More...
 
Parameter CreateUnregisteredParameter (GData data, string unitOrGroup, double defaultValue, double userValue=0, bool useOriginal=true)
 Creates a new parameter but do not add it to the model. This parameter is not going to have a unique identifier More...
 
IParameter CreateValue (IData data, int type=0)
 
bool DeleteValue (IData data, string key)
 
string FindId (string uniqueID)
 
bool KeyExists (string key)
 
IParameter ValueForKey (string key)
 

Properties

IEnumerable< IParameterAllValues [get]
 

Detailed Description

Stores all the Parameter indexed by their unique ID, so they can be retreived from anywhere in the code using the created database.

Member Function Documentation

Parameter Greet.DataStructureV3.Entities.Parameters.CreateRegisteredParameter ( string  unitOrGroup,
double  defaultValue,
double  userValue = 0,
string  uniqueID = "1" 
)

Creates and adds a new parameter to the model assigns the the parameter the ID given or a random integer assigns the CreatedBy CreatedOn ModifiedBy ModifiedOn attributes of the parameter

Parameters
unitOrGroupThe Unit or Group name for the parameter creation
valueThe default (original) value for that parameter
uniqueIDUnique ID for the parameter, otherwise will be time based
Returns
Parameter created, null in case of an error
Parameter Greet.DataStructureV3.Entities.Parameters.CreateUnregisteredParameter ( GData  data,
string  unitOrGroup,
double  defaultValue,
double  userValue = 0,
bool  useOriginal = true 
)

Creates a new parameter but do not add it to the model. This parameter is not going to have a unique identifier

Parameters
dataThe data is needed for evaluating the formula of the Parameter and refreshing buffers
unitOrGroup
defaultValue
userValue
useOriginal
Returns

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