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

mode type 5 can be a Magic Move, a mode defined by nothing, it's a kind of bypass mode. More...

Inheritance diagram for Greet.DataStructureV3.Entities.ModeConnector:
Greet.DataStructureV3.Entities.AMode Greet.DataStructureV3.Entities.IHaveAPicture Greet.DataStructureV3.Interfaces.IAMode Greet.DataStructureV3.IHaveMetadata Greet.DataStructureV3.Interfaces.IXmlObj

Public Member Functions

 ModeConnector (GData data, XmlNode modeNode, string optionalParamPrefix)
 
 ModeConnector (GData data)
 
override bool CheckIntegrity (GData data, bool showIds, out string errorMessage)
 Each type of mode has to be able to check it's structural integrity and return a string of errors if any are detected More...
 
override XmlNode ToXmlNode (XmlDocument xmlDoc)
 
- Public Member Functions inherited from Greet.DataStructureV3.Entities.AMode
void FromXmlNode (IData data, XmlNode node)
 
override string ToString ()
 

Properties

override bool CanBackHaul [get]
 
Modes.ModeType Type [get, set]
 Type defines how to convert that mode to a generic mode Type 1 : Ocean Tanker, Barge Type 2 : Heavy Duty Truck, Medium Heavy Duty Truck Type 3 : Pipeline Type 4 : Rail Type 5 : Magic Move More...
 
- Properties inherited from Greet.DataStructureV3.Entities.AMode
abstract bool CanBackHaul [get]
 
List< IModeFuelShareFuelShares [get]
 
int Id [get, set]
 
Dictionary< int, ModeFuelSharesModeFuelShares [get, set]
 
string ModifiedBy [get, set]
 
string ModifiedOn [get, set]
 
string Name [get, set]
 
string Notes [get, set]
 
string PictureName [get, set]
 
List< int > TransportedResources [get]
 
- 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.IAMode
List< IModeFuelShareFuelShares [get]
 List of fuel shares the mode uses More...
 
int Id [get, set]
 Unique ID for the mode More...
 
string Name [get, set]
 The name for this mode More...
 
string PictureName [get, set]
 Image Name that represents the Mode More...
 
List< int > TransportedResources [get]
 List of resources the mode depends; payload or energy intensities depending on the type of mode More...
 

Additional Inherited Members

- Public Attributes inherited from Greet.DataStructureV3.Entities.AMode
int ratiosBaselineFuel
 
Modes.ModeType type
 
- Protected Member Functions inherited from Greet.DataStructureV3.Entities.AMode
 AMode (GData data)
 Basic constructor More...
 

Detailed Description

mode type 5 can be a Magic Move, a mode defined by nothing, it's a kind of bypass mode.

Member Function Documentation

override bool Greet.DataStructureV3.Entities.ModeConnector.CheckIntegrity ( GData  data,
bool  showIds,
out string  errorMessage 
)
virtual

Each type of mode has to be able to check it's structural integrity and return a string of errors if any are detected

Returns

Implements Greet.DataStructureV3.Entities.AMode.

Property Documentation

Modes.ModeType Greet.DataStructureV3.Entities.ModeConnector.Type
getset

Type defines how to convert that mode to a generic mode Type 1 : Ocean Tanker, Barge Type 2 : Heavy Duty Truck, Medium Heavy Duty Truck Type 3 : Pipeline Type 4 : Rail Type 5 : Magic Move


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