Interface IRelationEngine

Defines the interface to the relation engine.

Namespace: Xareus.Relations.Unity

Assembly: Xareus.Relations.Unity.dll

Syntax

public interface IRelationEngine

Properties

Ready

Is the relation engine ready to be used?

Declaration

bool Ready { get; }

Property Value

Type	Description
bool	true whether the relation engine is ready; false otherwise

RegisteredObjects

Get all registered Objects

Declaration

IEnumerable<IObject> RegisteredObjects { get; }

Property Value

Type	Description
IEnumerable<IObject>

RegisteredRelations

Get all registered Relations

Declaration

IEnumerable<IRelation> RegisteredRelations { get; }

Property Value

Type	Description
IEnumerable<IRelation>

Methods

GetObjects()

Get all registered Objects

Declaration

[Obsolete("Use RegisteredObjects instead")]
IEnumerable<IObject> GetObjects()

Returns

Type	Description
IEnumerable<IObject>

GetObjects(IEnumerable<ObjectQueryParameters>, Action<List<IObject>>, bool)

Get all the objects corresponding to the given queries parameters. These queries will be executed together on a separate thread Note that all the queries share the same callback in this case. The callback will be called only once all the queries have been processed

Declaration

void GetObjects(IEnumerable<ObjectQueryParameters> queriesParameters, Action<List<IObject>> resultCallback, bool checkRegistered = true)

Parameters

Type	Name	Description
IEnumerable<ObjectQueryParameters>	queriesParameters	The parameters to use for the queries
Action<List<IObject>>	resultCallback	Returns the Objects.
bool	checkRegistered	if true, checks that all objects are registered.

GetObjects(IEnumerable<ObjectQueryParameters>, bool)

Get all the objects corresponding to the given queries parameters. This query doesn't use a thread and will be executed immediatly

Declaration

List<IObject> GetObjects(IEnumerable<ObjectQueryParameters> queriesParameters, bool checkRegistered = true)

Parameters

Type	Name	Description
IEnumerable<ObjectQueryParameters>	queriesParameters	The parameters to use for the queries
bool	checkRegistered	if true, checks that all objects are registered.

Returns

Type	Description
List<IObject>	The list of Objects corresponding to all the queries

GetObjects(List<ObjectQueryWithCallback>, bool)

Get all the objects corresponding to the given queries parameters. These queries will be executed together on a separate thread Each query is associated with a separate callback that will be called with the query's results. All callback will be called when all the queries have been processed

Declaration

void GetObjects(List<ObjectQueryWithCallback> queriesParametersWithCallbacks, bool checkRegistered = true)

Parameters

Type	Name	Description
List<ObjectQueryWithCallback>	queriesParametersWithCallbacks	The parameters and callbacks to use for the queries
bool	checkRegistered	if true, checks that all objects are registered.

GetObjects(ObjectQueryParameters, Action<List<IObject>>, bool)

Get all the objects corresponding to the given query parameters. These queries will be executed on a separate thread

Declaration

void GetObjects(ObjectQueryParameters queryParameters, Action<List<IObject>> resultCallback, bool checkRegistered = true)

Parameters

Type	Name	Description
ObjectQueryParameters	queryParameters	The parameters to use for the query
Action<List<IObject>>	resultCallback	Returns the Objects.
bool	checkRegistered	if true, checks that all objects are registered.

GetObjects(ObjectQueryParameters, bool)

Get all the objects corresponding to the given query parameters. This query doesn't use a thread and will be executed immediatly

Declaration

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

Parameters

Type	Name	Description
ObjectQueryParameters	queryParameters	The parameters to use for the query
bool	checkRegistered	if true, checks that all objects are registered.

Returns

Type	Description
List<IObject>	The list of Objects corresponding to the query

GetRealizations(IEnumerable<RealizationQueryParameters>, Action<List<XURealization>>, bool)

Get all the realizations corresponding to the given queries parameters. These queries will be executed together on a separate thread Note that all the queries share the same callback in this case. The callback will be called only once all the queries have been processed

Declaration

void GetRealizations(IEnumerable<RealizationQueryParameters> queriesParameters, Action<List<XURealization>> resultCallback, bool checkRegistered = true)

Parameters

Type	Name	Description
IEnumerable<RealizationQueryParameters>	queriesParameters	The parameters to use for the queries
Action<List<XURealization>>	resultCallback	Returns the realizations.
bool	checkRegistered	if true, checks that all objects are registered.

GetRealizations(IEnumerable<RealizationQueryParameters>, bool)

Get all the realizations corresponding to the given queries parameters. This query doesn't use a thread and will be executed immediatly

Declaration

List<XURealization> GetRealizations(IEnumerable<RealizationQueryParameters> queriesParameters, bool checkRegistered = true)

Parameters

Type	Name	Description
IEnumerable<RealizationQueryParameters>	queriesParameters	The parameters to use for the queries
bool	checkRegistered	if true, checks that all objects are registered.

Returns

Type	Description
List<XURealization>	The list of Realizations corresponding to all the queries

GetRealizations(List<RealizationQueryWithCallback>, bool)

Get all the realizations corresponding to the given queries parameters. These queries will be executed together on a separate thread Each query is associated with a separate callback that will be called with the query's results. All callback will be called when all the queries have been processed

Declaration

void GetRealizations(List<RealizationQueryWithCallback> queriesParametersWithCallbacks, bool checkRegistered = true)

Parameters

Type	Name	Description
List<RealizationQueryWithCallback>	queriesParametersWithCallbacks	The parameters and the callbacks to use for the queries
bool	checkRegistered	if true, checks that all objects are registered.

GetRealizations(RealizationQueryParameters, Action<List<XURealization>>, bool)

Get all the realizations corresponding to the given query parameters. This query will be executed on a separate thread

Declaration

void GetRealizations(RealizationQueryParameters queryParameters, Action<List<XURealization>> resultCallback, bool checkRegistered = true)

Parameters

Type	Name	Description
RealizationQueryParameters	queryParameters	The parameters to use for the query
Action<List<XURealization>>	resultCallback	Returns the realizations.
bool	checkRegistered	if true, checks that all objects are registered.

GetRealizations(RealizationQueryParameters, bool)

Get all the realizations corresponding to the given query parameters. This query doesn't use a thread and will be executed immediatly

Declaration

List<XURealization> GetRealizations(RealizationQueryParameters queryParameters, bool checkRegistered = true)

Parameters

Type	Name	Description
RealizationQueryParameters	queryParameters	The parameters to use for the query
bool	checkRegistered	if true, checks that all objects are registered.

Returns

Type	Description
List<XURealization>	The list of Realizations corresponding to the query

GetRelations()

Get all registered Relations

Declaration

[Obsolete("Use RegisteredRelations instead")]
IEnumerable<IRelation> GetRelations()

Returns

Type	Description
IEnumerable<IRelation>