C# Class DataDictionary.EfsSystem

A complete system, along with all dictionaries

Inheritance: IModelElement, ISubDeclarator, IHoldsParagraphs

Show file Open project: ERTMSSolutions/ERTMSFormalSpecs Class Usage Examples

Public Methods

Method	Description
AddDictionary ( Dictionary dictionary ) : void	Adds a new dictionary in the system
AddModelElement ( IModelElement element ) : void	Adds a model element in this model element
ClearCache ( ) : void	No caches
ClearFunctionCache ( ) : void	Clears the cache for all functions
ClearMessages ( bool precise ) : void	Clears the messages associated to this model element
CompareTo ( IModelElement other ) : int
CreateStatusMessage ( ) : string	Creates the status message
Delete ( ) : void	Deletes the element from its enclosing node
Find ( string name, List retVal ) : void	Appends the INamable which match the name provided in retVal
FindByFullName ( string fullname ) : INamable	Finds all namable which match the full name provided
FindReferences ( BaseFilter filter ) : List	Provides the list of references for a given filter
FindReferences ( IModelElement model ) : List	Provides the list of references of a given model element
FindRequirementSet ( string name ) : DataDictionary.Specification.RequirementSet	Provides the requirement set whose name corresponds to the name provided
FindRule ( string fullName ) : DataDictionary.Rules.Rule	Finds a rule according to its full name
FindTranslation ( DataDictionary.Tests.Step step ) : Tests.Translations.Translation	Provides the translation for the given step
FindTranslation ( string description, string comment ) : Tests.Translations.Translation	Provides the translation for the given step
FindType ( NameSpace nameSpace, string name ) : Type	Provides the type associated to the name
FindType_silent ( NameSpace nameSpace, string name ) : Type	Provides the type associated to the name, if it exists. If it does not exist, does not raise any errors.
GetBoolean ( bool val ) : IValue	Gets the boolean value which corresponds to the bool provided
GetExplain ( ) : string	Provides an RTF explanation of the system
GetParagraphs ( List paragraphs ) : void	Gets all paragraphs from EFS System
GetPredefinedItem ( string name ) : INamable	Provides the predefined item, based on its name
InitDeclaredElements ( ) : void	Initialises the declared elements
IsParent ( IModelElement element ) : bool	Indicates whether this is a parent of the element. It also returns true then parent==element
MarkNotImplementedRequirements ( DataDictionary.Specification.RequirementSet requirementSet ) : void	Marks the requirements which relate to the corresponding requirement set
MarkRequirementsForRequirementSet ( DataDictionary.Specification.RequirementSet requirementSet ) : void	Marks the requirements which relate to the corresponding requirement set
MarkRequirementsWhichDoNotBelongToRequirementSet ( DataDictionary.Specification.RequirementSet requirementSet ) : void	Marks the requirements which relate to the corresponding requirement set
OnDictionaryChangesOnFileSystem ( Dictionary dictionary ) : void	To be called when a dictionary changes on the file system
ParseStatement ( ModelElement root, string expression ) : Statement	Parses the statement provided
SingleAccessToModel ( ActionOnModel action ) : void	Performs an action on the model, and make sure no one else do actions on it at the same time
Stop ( ) : void	Stops the system

Private Methods

Method	Description
Context_ValueChange ( IModelElement modelElement, Context changeKind ) : void	The delegate used to handle the change of the value of a model element
EfsSystem ( ) : System.Collections	Constructor

Method Details

AddDictionary() public method

Adds a new dictionary in the system

public AddDictionary ( Dictionary dictionary ) : void
dictionary	Dictionary
return	void

AddModelElement() public method

Adds a model element in this model element

public AddModelElement ( IModelElement element ) : void
element	IModelElement
return	void

ClearCache() public method

No caches

public ClearCache ( ) : void
return	void

ClearFunctionCache() public method

Clears the cache for all functions

public ClearFunctionCache ( ) : void
return	void

ClearMessages() public method

Clears the messages associated to this model element

public ClearMessages ( bool precise ) : void
precise	bool	/// Indicates that the MessagePathInfo should be recomputed precisely /// according to the sub elements and should update the enclosing elements ///
return	void

CompareTo() public method

public CompareTo ( IModelElement other ) : int
other	IModelElement
return	int

CreateStatusMessage() public method

Creates the status message

public CreateStatusMessage ( ) : string
return	string

Delete() public method

Deletes the element from its enclosing node

public Delete ( ) : void
return	void

Find() public method

Appends the INamable which match the name provided in retVal

public Find ( string name, List retVal ) : void
name	string
retVal	List
return	void

FindByFullName() public method

Finds all namable which match the full name provided

public FindByFullName ( string fullname ) : INamable
fullname	string	The full name used to search the namable
return	INamable

FindReferences() public method

Provides the list of references for a given filter

public FindReferences ( BaseFilter filter ) : List
filter	BaseFilter
return	List

FindReferences() public method

Provides the list of references of a given model element

public FindReferences ( IModelElement model ) : List
model	IModelElement
return	List

FindRequirementSet() public method

Provides the requirement set whose name corresponds to the name provided

public FindRequirementSet ( string name ) : DataDictionary.Specification.RequirementSet
name	string
return	DataDictionary.Specification.RequirementSet

FindRule() public method

Finds a rule according to its full name

public FindRule ( string fullName ) : DataDictionary.Rules.Rule
fullName	string
return	DataDictionary.Rules.Rule

FindTranslation() public method

Provides the translation for the given step

public FindTranslation ( DataDictionary.Tests.Step step ) : Tests.Translations.Translation
step	DataDictionary.Tests.Step
return	Tests.Translations.Translation

FindTranslation() public method

Provides the translation for the given step

public FindTranslation ( string description, string comment ) : Tests.Translations.Translation
description	string
comment	string
return	Tests.Translations.Translation

FindType() public method

Provides the type associated to the name

public FindType ( NameSpace nameSpace, string name ) : Type
nameSpace	DataDictionary.Types.NameSpace
name	string
return	DataDictionary.Types.Type

FindType_silent() public method

Provides the type associated to the name, if it exists. If it does not exist, does not raise any errors.

public FindType_silent ( NameSpace nameSpace, string name ) : Type
nameSpace	DataDictionary.Types.NameSpace
name	string
return	DataDictionary.Types.Type

GetBoolean() public method

Gets the boolean value which corresponds to the bool provided

public GetBoolean ( bool val ) : IValue
val	bool
return	IValue

GetExplain() public method

Provides an RTF explanation of the system

public GetExplain ( ) : string
return	string

GetParagraphs() public method

Gets all paragraphs from EFS System

public GetParagraphs ( List paragraphs ) : void
paragraphs	List
return	void

GetPredefinedItem() public method

Provides the predefined item, based on its name

public GetPredefinedItem ( string name ) : INamable
name	string
return	INamable

InitDeclaredElements() public method

Initialises the declared elements

public InitDeclaredElements ( ) : void
return	void

IsParent() public method

Indicates whether this is a parent of the element. It also returns true then parent==element

public IsParent ( IModelElement element ) : bool
element	IModelElement
return	bool

MarkNotImplementedRequirements() public method

Marks the requirements which relate to the corresponding requirement set

public MarkNotImplementedRequirements ( DataDictionary.Specification.RequirementSet requirementSet ) : void
requirementSet	DataDictionary.Specification.RequirementSet
return	void

MarkRequirementsForRequirementSet() public method

Marks the requirements which relate to the corresponding requirement set

public MarkRequirementsForRequirementSet ( DataDictionary.Specification.RequirementSet requirementSet ) : void
requirementSet	DataDictionary.Specification.RequirementSet
return	void

MarkRequirementsWhichDoNotBelongToRequirementSet() public method

Marks the requirements which relate to the corresponding requirement set

public MarkRequirementsWhichDoNotBelongToRequirementSet ( DataDictionary.Specification.RequirementSet requirementSet ) : void
requirementSet	DataDictionary.Specification.RequirementSet
return	void

OnDictionaryChangesOnFileSystem() public method

To be called when a dictionary changes on the file system

public OnDictionaryChangesOnFileSystem ( Dictionary dictionary ) : void
dictionary	Dictionary
return	void

ParseStatement() public method

Parses the statement provided

public ParseStatement ( ModelElement root, string expression ) : Statement
root	ModelElement	the root element for which this statement is created
expression	string
return	Statement

SingleAccessToModel() public method

Performs an action on the model, and make sure no one else do actions on it at the same time

public SingleAccessToModel ( ActionOnModel action ) : void
action	ActionOnModel
return	void

Stop() public method

Stops the system

public Stop ( ) : void
return	void