C# Class DataDictionary.Interpreter.ExplanationPart

Part of the explanation of an evaluation
Mostra file Open project: ERTMSSolutions/ERTMSFormalSpecs Class Usage Examples

Public Methods

Method Description
AddSubExplanation ( ExplanationPart explain, ExplanationPart subExplain ) : void

Adds a sub explanation for the explain provided as parameter

CreateNamedSubExplanation ( ExplanationPart explain, string message, object leftPart ) : ExplanationPart

Creates a sub explanation for the explain provided as parameter

CreateSubExplanation ( ExplanationPart explain, ModelElement root, DataDictionary.Rules.Change change ) : ExplanationPart

Creates a sub explanation for the explain provided as parameter

CreateSubExplanation ( ExplanationPart explain, object leftPart, INamable rightPart = null ) : ExplanationPart

Creates a sub explanation for the explain provided as parameter

CreateSubExplanation ( ExplanationPart explain, string name ) : ExplanationPart

Creates a sub explanation for the explain provided as parameter

ExplanationPart ( ModelElement element, DataDictionary.Rules.Change change ) : System.Collections.Generic

Constructor for an explanation, based on a change

ExplanationPart ( ModelElement element, object leftPart, INamable rightPart = null ) : System.Collections.Generic

Constructor

ExplanationPart ( ModelElement element, string message, INamable rightPart = null ) : System.Collections.Generic

Constructor

SetNamable ( ExplanationPart explain, INamable namable ) : void

Sets the value associated to the explanation

Private Methods

Method Description
ExplainLeftPart ( object leftPart ) : string

Explains a left part

explainNamable ( INamable namable ) : string

Provides the textual representation of the namable provided

Method Details

AddSubExplanation() public static method

Adds a sub explanation for the explain provided as parameter
public static AddSubExplanation ( ExplanationPart explain, ExplanationPart subExplain ) : void
explain ExplanationPart
subExplain ExplanationPart
return void

CreateNamedSubExplanation() public static method

Creates a sub explanation for the explain provided as parameter
public static CreateNamedSubExplanation ( ExplanationPart explain, string message, object leftPart ) : ExplanationPart
explain ExplanationPart
message string
leftPart object
return ExplanationPart

CreateSubExplanation() public static method

Creates a sub explanation for the explain provided as parameter
public static CreateSubExplanation ( ExplanationPart explain, ModelElement root, DataDictionary.Rules.Change change ) : ExplanationPart
explain ExplanationPart
root ModelElement
change DataDictionary.Rules.Change
return ExplanationPart

CreateSubExplanation() public static method

Creates a sub explanation for the explain provided as parameter
public static CreateSubExplanation ( ExplanationPart explain, object leftPart, INamable rightPart = null ) : ExplanationPart
explain ExplanationPart
leftPart object What is evaluated
rightPart INamable The evaluated value
return ExplanationPart

CreateSubExplanation() public static method

Creates a sub explanation for the explain provided as parameter
public static CreateSubExplanation ( ExplanationPart explain, string name ) : ExplanationPart
explain ExplanationPart
name string
return ExplanationPart

ExplanationPart() public method

Constructor for an explanation, based on a change
public ExplanationPart ( ModelElement element, DataDictionary.Rules.Change change ) : System.Collections.Generic
element ModelElement The element for which this explanation part is created
change DataDictionary.Rules.Change The change performed
return System.Collections.Generic

ExplanationPart() public method

Constructor
public ExplanationPart ( ModelElement element, object leftPart, INamable rightPart = null ) : System.Collections.Generic
element ModelElement The element for which this explanation part is created
leftPart object The left path to associate to this explanation
rightPart INamable The value associate to this left part
return System.Collections.Generic

ExplanationPart() public method

Constructor
public ExplanationPart ( ModelElement element, string message, INamable rightPart = null ) : System.Collections.Generic
element ModelElement The element for which this explanation part is created
message string The message to display. MAKE SURE you do not use string concatenation to create this message
rightPart INamable The value associated to the message, if any
return System.Collections.Generic

SetNamable() public static method

Sets the value associated to the explanation
public static SetNamable ( ExplanationPart explain, INamable namable ) : void
explain ExplanationPart
namable INamable
return void