Class ObjectQueryParameters

Inheritance

object

ObjectQueryParameters

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Xareus.Relations

Assembly: Xareus.Relations.dll

Syntax

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

Constructors

ObjectQueryParameters()

ObjectQueryParameters class constructor

Declaration

public ObjectQueryParameters()

ObjectQueryParameters(HashSet<TypeSearch>, HashSet<IObject>)

Constructor

Declaration

public ObjectQueryParameters(HashSet<TypeSearch> typesToHave, HashSet<IObject> objectsToLookInto = null)

Parameters

Type	Name	Description
HashSet<TypeSearch>	typesToHave
HashSet<IObject>	objectsToLookInto

ObjectQueryParameters(IEnumerable<TypeSearch>, IEnumerable<IObject>)

Constructor

Declaration

public ObjectQueryParameters(IEnumerable<TypeSearch> typesToHave, IEnumerable<IObject> objectsToLookInto = null)

Parameters

Type	Name	Description
IEnumerable<TypeSearch>	typesToHave
IEnumerable<IObject>	objectsToLookInto

Properties

ObjectsToLookInto

Object collection to look into.

Declaration

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

Property Value

Type	Description
HashSet<IObject>

TypesToHave

Declaration

[DataMember]
public HashSet<TypeSearch> TypesToHave { get; set; }

Property Value

Type	Description
HashSet<TypeSearch>

Methods

Deserialize(string)

Declaration

public static ObjectQueryParameters Deserialize(string xml)

Parameters

Type	Name	Description
string	xml

Returns

Type	Description
ObjectQueryParameters

Deserialize(string, out ObjectQueryParameters)

Declaration

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

Parameters

Type	Name	Description
string	xml
ObjectQueryParameters	obj

Returns

Type	Description
bool

Deserialize(string, out ObjectQueryParameters, out Exception)

Deserializes workflow markup into an ObjectQueryParameters object

Declaration

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

Parameters

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

Returns

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

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

GetQueryAllObjects(IEngine)

Get a query to look at all registered object

Declaration

public static ObjectQueryParameters GetQueryAllObjects(IEngine engine)

Parameters

Type	Name	Description
IEngine	engine

Returns

Type	Description
ObjectQueryParameters

LoadFromFile(string)

Declaration

public static ObjectQueryParameters LoadFromFile(string fileName)

Parameters

Type	Name	Description
string	fileName

Returns

Type	Description
ObjectQueryParameters

LoadFromFile(string, out ObjectQueryParameters)

Declaration

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

Parameters

Type	Name	Description
string	fileName
ObjectQueryParameters	obj

Returns

Type	Description
bool

LoadFromFile(string, out ObjectQueryParameters, out Exception)

Deserializes XML markup from file into an ObjectQueryParameters object

Declaration

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

Parameters

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

Returns

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

SaveToFile(string)

Declaration

public virtual void SaveToFile(string fileName)

Parameters

Type	Name	Description
string	fileName

SaveToFile(string, out Exception)

Serializes current ObjectQueryParameters 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 ObjectQueryParameters object into an XML document

Declaration

public virtual string Serialize()

Returns

Type	Description
string	string XML value

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()