Class Engine

This class is the entry point of the package. It mainly computes all the possible realizations based on the registered relations and a set of objects.

Inheritance

object

Engine

Implements

IEngine

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Xareus.Relations.CSharp

Assembly: Xareus.Relations.dll

Syntax

[Serializable]
[DataContract(Name = "Engine", Namespace = "http://www.insa-rennes.fr/Xareus.Relations:C#")]
public class Engine : IEngine, IDisposable

Constructors

Engine()

Engine class constructor

Declaration

public Engine()

Properties

Objects

Declaration

[DataMember]
public HashSet<IObject> Objects { get; set; }

Property Value

Type	Description
HashSet<IObject>

ObjectsNameObjectsMap

Map of the objects registered in the engine, indexed by their name

Declaration

public Dictionary<string, IObject> ObjectsNameObjectsMap { get; }

Property Value

Type	Description
Dictionary<string, IObject>

RegisteredObjects

Declaration

public IEnumerable<IObject> RegisteredObjects { get; }

Property Value

Type	Description
IEnumerable<IObject>

RegisteredRelations

Declaration

public IEnumerable<IRelation> RegisteredRelations { get; }

Property Value

Type	Description
IEnumerable<IRelation>

Relations

Declaration

[DataMember]
public HashSet<IRelation> Relations { get; set; }

Property Value

Type	Description
HashSet<IRelation>

RelationsNameRelationsMap

Map of the relations registered in the engine, indexed by their name

Declaration

public Dictionary<string, IRelation> RelationsNameRelationsMap { get; }

Property Value

Type	Description
Dictionary<string, IRelation>

Methods

AddObject(IObject)

Declaration

public void AddObject(IObject @object)

Parameters

Type	Name	Description
IObject	object

AddRelation(IRelation)

Declaration

public void AddRelation(IRelation relation)

Parameters

Type	Name	Description
IRelation	relation

CheckType(IObject, TypeSearch)

Declaration

protected static bool CheckType(IObject obj, TypeSearch type)

Parameters

Type	Name	Description
IObject	obj
TypeSearch	type

Returns

Type	Description
bool

Deserialize(string)

Declaration

public static Engine Deserialize(string xml)

Parameters

Type	Name	Description
string	xml

Returns

Type	Description
Engine

Deserialize(string, out Engine)

Declaration

public static bool Deserialize(string xml, out Engine obj)

Parameters

Type	Name	Description
string	xml
Engine	obj

Returns

Type	Description
bool

Deserialize(string, out Engine, out Exception)

Deserializes workflow markup into an Engine object

Declaration

public static bool Deserialize(string xml, out Engine obj, out Exception exception)

Parameters

Type	Name	Description
string	xml	string workflow markup to deserialize
Engine	obj	Output Engine object
Exception	exception	output Exception value if deserialize failed

Returns

Type	Description
bool	true if this XmlSerializer can deserialize the object; otherwise, false

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

GetObject(string)

Declaration

public IObject GetObject(string objectName)

Parameters

Type	Name	Description
string	objectName

Returns

Type	Description
IObject

GetObjects(ObjectQueryParameters, bool)

Declaration

public IEnumerable<IObject> GetObjects(ObjectQueryParameters queryParameters, bool checkRegistered = true)

Parameters

Type	Name	Description
ObjectQueryParameters	queryParameters
bool	checkRegistered

Returns

Type	Description
IEnumerable<IObject>

GetRealizations()

Declaration

public IEnumerable<Realization> GetRealizations()

Returns

Type	Description
IEnumerable<Realization>

GetRealizations(RealizationQueryParameters, bool)

Declaration

public IEnumerable<Realization> GetRealizations(RealizationQueryParameters queryParameters, bool checkRegistered = true)

Parameters

Type	Name	Description
RealizationQueryParameters	queryParameters
bool	checkRegistered

Returns

Type	Description
IEnumerable<Realization>

GetRelation(string)

Declaration

public IRelation GetRelation(string relationName)

Parameters

Type	Name	Description
string	relationName

Returns

Type	Description
IRelation

HasObject(string)

Declaration

public bool HasObject(string objectName)

Parameters

Type	Name	Description
string	objectName

Returns

Type	Description
bool

HasRelation(string)

Declaration

public bool HasRelation(string relationName)

Parameters

Type	Name	Description
string	relationName

Returns

Type	Description
bool

LoadFromFile(string)

Declaration

public static Engine LoadFromFile(string fileName)

Parameters

Type	Name	Description
string	fileName

Returns

Type	Description
Engine

LoadFromFile(string, out Engine)

Declaration

public static bool LoadFromFile(string fileName, out Engine obj)

Parameters

Type	Name	Description
string	fileName
Engine	obj

Returns

Type	Description
bool

LoadFromFile(string, out Engine, out Exception)

Deserializes XML markup from file into an Engine object

Declaration

public static bool LoadFromFile(string fileName, out Engine obj, out Exception exception)

Parameters

Type	Name	Description
string	fileName	string xml file to load and deserialize
Engine	obj	Output Engine object
Exception	exception	output Exception value if deserialize failed

Returns

Type	Description
bool	true if this XmlSerializer can deserialize the object; otherwise, false

RemoveObject(IObject)

Declaration

public void RemoveObject(IObject @object)

Parameters

Type	Name	Description
IObject	object

RemoveRelation(IRelation)

Declaration

public void RemoveRelation(IRelation relation)

Parameters

Type	Name	Description
IRelation	relation

SaveToFile(string)

Declaration

public virtual void SaveToFile(string fileName)

Parameters

Type	Name	Description
string	fileName

SaveToFile(string, out Exception)

Serializes current Engine object into file

Declaration

public virtual bool SaveToFile(string fileName, out Exception exception)

Parameters

Type	Name	Description
string	fileName	full path of output XML file
Exception	exception	output Exception value if failed

Returns

Type	Description
bool	true if can serialize and save into file; otherwise, false

Serialize()

Serializes current Engine object into an XML document

Declaration

public virtual string Serialize()

Returns

Type	Description
string	string XML value

Implements

IEngine

IDisposable