Inheritance diagram for Greet.DataStructureV3.Entities.ResourceData:

Public Member Functions
	ResourceData (GData data, XmlNode node)

	ResourceData (GData data)

bool	CanBeAMass ()
	Returns TRUE if an amount of that material can be a mass More...

bool	CanConvertTo (string to_unit_name, Parameter val)

bool	CanConvertTo (uint to, Greet.UnitLib2.LightValue val)

bool	CanConvertTo (string to_unit_name, UnitLib.LightValue val)

UnitLib.LightValue	CarbonContent (Parameter amount)
	This method return the amount of carbon contained in the "amount" units of the material. The result must kave [kilograms] dimenstion More...

UnitLib.LightValue	CarbonContent (UnitLib.LightValue amount)
	This method return the amount of carbon contained in the "amount" units of the material. The result must kave [kilograms] dimenstion More...

int	CompareTo (object otherMaterial)

Enem	ConvertBottomToEnergy (Enem balance)
	This method is used to convert a Enem balance where the bottom unit is not energy into a balance where the bottom unit is energy More...

UnitLib.LightValue	ConvertRatioToEnergy (UnitLib.LightValue val, Parameter amount)
	This function is used to calculate loss energy, when loss has dementions [loss_unit/product_unit]. This function need to be used if output of the process has units different from product_unit More...

void	ConvertTo (string unit_name, ref Parameter val)
	Return a new DoubleValue converted to the desired unit More...

void	ConvertTo (uint unit_name, ref Parameter val)
	Return a new DoubleValue converted to the desired unit More...

UnitLib.LightValue	ConvertTo (string unit_name, UnitLib.LightValue val)

UnitLib2.LightValue	ConvertTo (uint unit_name, UnitLib2.LightValue val)

Enem	ConvertTo (string unit_name, Enem enem)
	Converts the bottom part of a Enem of this materials More...

Results	ConvertTo (GData data, string unit_name, Results enem)

Dict	ConvertTo (string unit_name, Dict dico)

DVDict	ConvertTo (string unit_name, DVDict dico)

IValue	ConvertTo (string unit_name, IValue value)
	Converts a result value in a certain unit into another result value in the desired unit More...

IValue	ConvertTo (string unit_name, IParameter value)
	Converts a parameter value in a certain unit into another result value in the desired unit The GREET value or USER value will be used depending on the UseOriginal attribute of the IParameter More...

void	ConvertToEnergy (ref Parameter val)
	Take the DoubleValue, reads the value and the unit, try to convert it into a Energy depending of the availabe inputs parameters ( HV, density ) More...

UnitLib.LightValue	ConvertToEnergy (UnitLib.LightValue val)
	Take the DoubleValue, reads the value and the unit, try to convert it into a Energy depending of the availabe inputs parameters ( HV, density ) More...

UnitLib2.LightValue	ConvertToEnergy (UnitLib2.LightValue val)
	Take the DoubleValue, reads the value and the unit, try to convert it into a Energy depending of the availabe inputs parameters ( HV, density ) More...

EmissionAmounts	ConvertToEnergy (EmissionAmounts balance)
	This method is used to convert a EmissionResults balance where the bottom unit is not energy into a balance where the bottom unit is energy More...

UnitLib.LightValue	ConvertToMarketValue (UnitLib.LightValue val)
	Converts the val to Market Value More...

UnitLib2.LightValue	ConvertToMarketValue (UnitLib2.LightValue val)
	Converts the val to Market Value More...

void	ConvertToMarketValue (ref Parameter val)
	Converts the val to Market Value More...

void	ConvertToMass (ref Parameter val)
	Take the DoubleValue, reads the value and the unit, try to convert it into a Mass depending of the availabe inputs parameters ( HV, density ) More...

UnitLib.LightValue	ConvertToMass (UnitLib.LightValue val)
	Take the DoubleValue, reads the value and the unit, try to convert it into a Mass depending of the availabe inputs parameters ( HV, density ) More...

UnitLib2.LightValue	ConvertToMass (UnitLib2.LightValue val)
	Take the DoubleValue, reads the value and the unit, try to convert it into a Mass depending of the availabe inputs parameters ( HV, density ) More...

void	ConvertToVolume (ref Parameter val)
	Take the DoubleValue, reads the value and the unit, try to convert it into a Volume depending of the availabe inputs parameters ( HV, density ) More...

UnitLib.LightValue	ConvertToVolume (UnitLib.LightValue val)
	Take the DoubleValue, reads the value and the unit, try to convert it into a Volume depending of the availabe inputs parameters ( HV, density ) More...

UnitLib2.LightValue	ConvertToVolume (UnitLib2.LightValue val)
	Take the DoubleValue, reads the value and the unit, try to convert it into a Volume depending of the availabe inputs parameters ( HV, density ) More...

string	DefaultAmountUnitGroupName ()
	Returns the default group name to use for when this material is used as an input or an output More...

void	FromXmlNode (IData data, XmlNode node)

void	GetMostFrequentSource (out Enumerators.SourceType source, out int object_id)
	Get the source and associated object id which is most frequently used for an input. Make sure you call UpdateSourceFrequencies some time before you call this function More...

UnitLib.LightValue	SulfurContent (UnitLib.LightValue amount)
	This method return the amount of carbon contained in the "amount" units of the material. The result must kave [kilograms] dimenstion More...

override string	ToString ()

XmlNode	ToXmlNode (XmlDocument xmlDoc)
	Converts the material object to an xmlNode to store in the data file More...

Public Attributes
bool	canBePrimaryResource = false

List< EvaporatedGas >	evaporatedGases = new List<EvaporatedGas>()

bool	hiddenAsMain

Dictionary< string, string >	PreferedUnitFor = new Dictionary<string, string>()

int	use_as_input_count = 0

bool	UseLHV = true

Properties
IParameter	CarbonRatio `[get, set]`

List< int >	CompatibilityIds `[get, set]`

Parameter	CRatio `[get, set]`

Parameter	CurrentSRatio `[get]`
	Return the sulfur ratio for the selected year in the system. More...

IParameter	Density `[get, set]`

Parameter	DensityAsParameter `[get, set]`

List< IEvaporatedGas >	EvaporatedGasess `[get, set]`

string	Family `[get, set]`
	The top level group for the material to be sorted under More...

Parameter	HeatingValue `[get]`
	Returns the HHV or the LHV depending on the option selected in the general parameters More...

Parameter	HeatingValueHhv `[get, set]`

Parameter	HeatingValueLhv `[get, set]`

string	Help `[get, set]`

IParameter	HigherHeatingValue `[get, set]`

int	Id `[get, set]`

IParameter	LowerHeatingValue `[get, set]`

Parameter	MarketValue `[get, set]`

List< int >	Memberships `[get, set]`

string	ModifiedBy `[get, set]`

string	ModifiedOn `[get, set]`

string	Name `[get, set]`

List< string >	NickNames `[get, set]`

string	NickNamesSingleString `[get]`
	Returns a single string with all the nicknames seperated by comma. More...

string	Notes `[get, set]`

string	PictureName `[get, set]`

Parameter	Pressure `[get, set]`

int	RecoveredMaterialId `[get, set]`

ParameterTS	SRatio `[get, set]`

Resources.PhysicalState	State `[get, set]`

IParameter	SulfurRatio `[get]`

Parameter	Temperature `[get, set]`

Properties inherited from Greet.DataStructureV3.Entities.IGraphRepresented
string	Name `[get, set]`

string	Notes `[get, set]`

string	PictureName `[get, set]`

Properties inherited from Greet.DataStructureV3.Entities.IGroupAvailable
int	Id `[get]`
	The ID of the currently edited object More...

List< int >	Memberships `[get, set]`
	Get or Set the list of memberships for that object More...

Properties inherited from Greet.DataStructureV3.Entities.IHaveAPicture
string	PictureName `[get, set]`
	Get or Set the image name of the object More...

Properties inherited from Greet.DataStructureV3.Interfaces.IResource
IParameter	CarbonRatio `[get, set]`
	The Carbon ratio of the resource More...

List< int >	CompatibilityIds `[get, set]`
	List of compatible resource Ids More...

IParameter	Density `[get, set]`
	The Density of the resource More...

List< IEvaporatedGas >	EvaporatedGasess `[get, set]`
	List of all the gases that the resource evaporates into More...

IParameter	HigherHeatingValue `[get, set]`
	The Low Heating Value of the resource More...

int	Id `[get, set]`
	Unique ID for this resource among the resources More...

IParameter	LowerHeatingValue `[get, set]`
	The Hight Heating Value of the resource More...

List< int >	Memberships `[get, set]`
	Lists the memberships of that gas More...

string	Name `[get, set]`
	Name for this resource as it is going to show on the graphical interface More...

string	PictureName `[get, set]`
	Image Name that represents the resource More...

IParameter	SulfurRatio `[get]`
	The Sulfur ratio of the resource More...

Properties inherited from Greet.DataStructureV3.IHaveMetadata
string	ModifiedBy `[get, set]`
	User that modified this entity the latest time More...

string	ModifiedOn `[get, set]`
	Time at which this was modified for the last time More...

string	Notes `[get, set]`
	Notes associated with that entity More...

Member Function Documentation

bool Greet.DataStructureV3.Entities.ResourceData.CanBeAMass ( )

Returns TRUE if an amount of that material can be a mass

Returns

UnitLib.LightValue Greet.DataStructureV3.Entities.ResourceData.CarbonContent ( Parameter amount )

This method return the amount of carbon contained in the "amount" units of the material. The result must kave [kilograms] dimenstion

Parameters

amount

Returns

UnitLib.LightValue Greet.DataStructureV3.Entities.ResourceData.CarbonContent ( UnitLib.LightValue amount )

This method return the amount of carbon contained in the "amount" units of the material. The result must kave [kilograms] dimenstion

Parameters

amount

Returns

Enem Greet.DataStructureV3.Entities.ResourceData.ConvertBottomToEnergy ( Enem balance )

This method is used to convert a Enem balance where the bottom unit is not energy into a balance where the bottom unit is energy

Parameters

balance Balance to convert for 1 joule which is actually not

Returns: The balance equivalent for 1 joule

UnitLib.LightValue Greet.DataStructureV3.Entities.ResourceData.ConvertRatioToEnergy	(	UnitLib.LightValue	val,
		Parameter	amount
	)

This function is used to calculate loss energy, when loss has dementions [loss_unit/product_unit]. This function need to be used if output of the process has units different from product_unit

Parameters

val	Is the amount of loss
amount	Amount of output energy

Returns

void Greet.DataStructureV3.Entities.ResourceData.ConvertTo	(	string	unit_name,
		ref Parameter	val
	)

Return a new DoubleValue converted to the desired unit

Parameters

unit_name	joules, kilograms or cu_meters
val	The doubleValue to convert

Returns

void Greet.DataStructureV3.Entities.ResourceData.ConvertTo	(	uint	unit_name,
		ref Parameter	val
	)

Return a new DoubleValue converted to the desired unit

Parameters

unit_name	joules, kilograms or cu_meters
val	The doubleValue to convert

Returns

Enem Greet.DataStructureV3.Entities.ResourceData.ConvertTo	(	string	unit_name,
		Enem	enem
	)

Converts the bottom part of a Enem of this materials

Parameters

unit_name
enem

Returns

IValue Greet.DataStructureV3.Entities.ResourceData.ConvertTo	(	string	unit_name,
		IValue	value
	)

Converts a result value in a certain unit into another result value in the desired unit

Parameters

unit_name	The desired unit
value	Value to be converted

Returns: Converted value in desired unit

Implements Greet.DataStructureV3.Interfaces.IResource.

IValue Greet.DataStructureV3.Entities.ResourceData.ConvertTo	(	string	unit_name,
		IParameter	value
	)

Converts a parameter value in a certain unit into another result value in the desired unit The GREET value or USER value will be used depending on the UseOriginal attribute of the IParameter

Parameters

unit_name	The desired unit
value	Value to be converted

Returns: Converted value in desired unit

Implements Greet.DataStructureV3.Interfaces.IResource.

void Greet.DataStructureV3.Entities.ResourceData.ConvertToEnergy ( ref Parameter val )

Take the DoubleValue, reads the value and the unit, try to convert it into a Energy depending of the availabe inputs parameters ( HV, density )

Parameters

val	The double value to convert

Returns

UnitLib.LightValue Greet.DataStructureV3.Entities.ResourceData.ConvertToEnergy ( UnitLib.LightValue val )

Take the DoubleValue, reads the value and the unit, try to convert it into a Energy depending of the availabe inputs parameters ( HV, density )

Parameters

val	The double value to convert

Returns

UnitLib2.LightValue Greet.DataStructureV3.Entities.ResourceData.ConvertToEnergy ( UnitLib2.LightValue val )

Take the DoubleValue, reads the value and the unit, try to convert it into a Energy depending of the availabe inputs parameters ( HV, density )

Parameters

val	The double value to convert

Returns

EmissionAmounts Greet.DataStructureV3.Entities.ResourceData.ConvertToEnergy ( EmissionAmounts balance )

This method is used to convert a EmissionResults balance where the bottom unit is not energy into a balance where the bottom unit is energy

Parameters

balance Balance to convert for 1 joule which is actually not

Returns: The balance equivalent for 1 joule

UnitLib.LightValue Greet.DataStructureV3.Entities.ResourceData.ConvertToMarketValue ( UnitLib.LightValue val )

Converts the val to Market Value

Parameters

val	The double value to convert

Returns

UnitLib2.LightValue Greet.DataStructureV3.Entities.ResourceData.ConvertToMarketValue ( UnitLib2.LightValue val )

Converts the val to Market Value

Parameters

val	The double value to convert

Returns

void Greet.DataStructureV3.Entities.ResourceData.ConvertToMarketValue ( ref Parameter val )

Converts the val to Market Value

Parameters

val	The double value to convert

Returns

void Greet.DataStructureV3.Entities.ResourceData.ConvertToMass ( ref Parameter val )

Take the DoubleValue, reads the value and the unit, try to convert it into a Mass depending of the availabe inputs parameters ( HV, density )

Parameters

val	The double value to convert

Returns

UnitLib.LightValue Greet.DataStructureV3.Entities.ResourceData.ConvertToMass ( UnitLib.LightValue val )

Take the DoubleValue, reads the value and the unit, try to convert it into a Mass depending of the availabe inputs parameters ( HV, density )

Parameters

val	The double value to convert

Returns

UnitLib2.LightValue Greet.DataStructureV3.Entities.ResourceData.ConvertToMass ( UnitLib2.LightValue val )

Take the DoubleValue, reads the value and the unit, try to convert it into a Mass depending of the availabe inputs parameters ( HV, density )

Parameters

val	The double value to convert

Returns

void Greet.DataStructureV3.Entities.ResourceData.ConvertToVolume ( ref Parameter val )

Take the DoubleValue, reads the value and the unit, try to convert it into a Volume depending of the availabe inputs parameters ( HV, density )

Parameters

val	The double value to convert

Returns

UnitLib.LightValue Greet.DataStructureV3.Entities.ResourceData.ConvertToVolume ( UnitLib.LightValue val )

Take the DoubleValue, reads the value and the unit, try to convert it into a Volume depending of the availabe inputs parameters ( HV, density )

Parameters

val	The double value to convert

Returns

UnitLib2.LightValue Greet.DataStructureV3.Entities.ResourceData.ConvertToVolume ( UnitLib2.LightValue val )

Take the DoubleValue, reads the value and the unit, try to convert it into a Volume depending of the availabe inputs parameters ( HV, density )

Parameters

val	The double value to convert

Returns

string Greet.DataStructureV3.Entities.ResourceData.DefaultAmountUnitGroupName ( )

Returns the default group name to use for when this material is used as an input or an output

Returns

void Greet.DataStructureV3.Entities.ResourceData.GetMostFrequentSource	(	out Enumerators.SourceType	source,
		out int	object_id
	)

Get the source and associated object id which is most frequently used for an input. Make sure you call UpdateSourceFrequencies some time before you call this function

Parameters

source
object_id	Id of the corresponding object. If source is Mix then object_id is id of the Corresponding mixe, the same logic for pathway. However, if source is well, previous or a feed, then object_id is meaningless is is set to 0

UnitLib.LightValue Greet.DataStructureV3.Entities.ResourceData.SulfurContent ( UnitLib.LightValue amount )

This method return the amount of carbon contained in the "amount" units of the material. The result must kave [kilograms] dimenstion

Parameters

amount

Returns

XmlNode Greet.DataStructureV3.Entities.ResourceData.ToXmlNode ( XmlDocument xmlDoc )

Converts the material object to an xmlNode to store in the data file

Parameters

xmlDoc the docuement, needed for namespaceURI

Returns: An Xml node which represents the material object

Implements Greet.DataStructureV3.Interfaces.IXmlObj.

Property Documentation

Parameter Greet.DataStructureV3.Entities.ResourceData.CurrentSRatio

get

Return the sulfur ratio for the selected year in the system.

string Greet.DataStructureV3.Entities.ResourceData.Family

getset

The top level group for the material to be sorted under

Parameter Greet.DataStructureV3.Entities.ResourceData.HeatingValue

get

Returns the HHV or the LHV depending on the option selected in the general parameters

string Greet.DataStructureV3.Entities.ResourceData.NickNamesSingleString

get

Returns a single string with all the nicknames seperated by comma.

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

C:/Users/ddieffenthaler/Desktop/SVN/source/greet-dev/main/DataManagement/DataStructureV3/DataV3/Entities/Resources/ResourceData.cs

Public Member Functions

Public Attributes

Properties

Member Function Documentation

Property Documentation