Interface ITechObjectsLinksSource

Представляет источник связей объектов технологических данных.

Namespace: Ascon.Vertical.Core

Assembly: Ascon.Vertical.Core.dll

Syntax

public interface ITechObjectsLinksSource

Methods

Any(ITechObject, string, TechObjectsTypesLinkDirection, string, CancellationToken)

Возвращает признак наличия связи объекта определённого наименования и направления с объектом указанного типа.

Declaration

Task<bool> Any(ITechObject techObject, string linkName, TechObjectsTypesLinkDirection direction, string typeName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObject	techObject	Объект, у которого проверяется наличие связи.
string	linkName	Наименование связи.
TechObjectsTypesLinkDirection	direction	Направление связи.
string	typeName	Наименование типа связанного объекта.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<bool>	Признак наличия связи.

Any(ITechObject, string, TechObjectsTypesLinkDirection, CancellationToken)

Возвращает признак наличия связи объекта определённого наименования и направления.

Declaration

Task<bool> Any(ITechObject techObject, string linkName, TechObjectsTypesLinkDirection direction, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObject	techObject	Объект, у которого проверяется наличие связи.
string	linkName	Наименование связи.
TechObjectsTypesLinkDirection	direction	Направление связи.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<bool>	Признак наличия связи.

CreateCopy(ITechObjectsLink, ITechObject, ITechObject, CancellationToken)

Создаёт копию связи.

Declaration

Task<ITechObjectsLink> CreateCopy(ITechObjectsLink copyLink, ITechObject object1, ITechObject object2, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObjectsLink	copyLink	Связь для копирования.
ITechObject	object1	Объект 1 для связывания созданной копией связи.
ITechObject	object2	Объект 2 для связывания созданной копией связи.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<ITechObjectsLink>	Созданную копию связи.

Remarks

Копирует значения атрибутов связи в зависимости от заданных в модели настроек.

DeleteById(int, CancellationToken)

Удаляет связь по идентификатору.

Declaration

Task DeleteById(int id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	id	Идентификатор связи.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task	Признак успешного удаления связи.

DeleteByIds(List<int>, CancellationToken)

Удаляет связи по идентификатору.

Declaration

Task DeleteByIds(List<int> ids, CancellationToken cancellationToken)

Parameters

Type	Name	Description
List<int>	ids	Идентификаторы связей.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task	Признак успешного удаления связи.

Find(ITechObject, string, string, TechObjectsTypesLinkDirection, CancellationToken)

Возвращает связи заданного объекта определённого наименования и направления.

Declaration

Task<IReadOnlyList<ITechObjectsLink>> Find(ITechObject techObject, string linkName, string typeName, TechObjectsTypesLinkDirection direction, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObject	techObject	Объект, относительно которого ищутся связи.
string	linkName	Наименование связи.
string	typeName	Наименование типа связанного объекта. Если не указан, возвращаются все объекты, привязанные заданным типом связи.
TechObjectsTypesLinkDirection	direction	Направление связи.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObjectsLink>>	Список связей.

Find(List<ITechObject>, IEnumerable<string>, TechObjectsTypesLinkDirection, CancellationToken)

Возвращает все связи заданного списка объектов определённого наименования и направления.

Declaration

Task<IReadOnlyList<ITechObjectsLink>> Find(List<ITechObject> objects, IEnumerable<string> linkNames, TechObjectsTypesLinkDirection direction, CancellationToken cancellationToken)

Parameters

Type	Name	Description
List<ITechObject>	objects	Перечень объектов, относительно которых ищутся связи.
IEnumerable<string>	linkNames	Перечень наименований связей.
TechObjectsTypesLinkDirection	direction	Направление связи.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObjectsLink>>	Список связей.

Find(List<ITechObject>, string, TechObjectsTypesLinkDirection, CancellationToken)

Возвращает все связи заданного списка объектов определённого наименования и направления.

Declaration

Task<IReadOnlyList<ITechObjectsLink>> Find(List<ITechObject> objects, string linkName, TechObjectsTypesLinkDirection direction, CancellationToken cancellationToken)

Parameters

Type	Name	Description
List<ITechObject>	objects	Перечень объектов, относительно которых ищутся связи.
string	linkName	Наименование связи.
TechObjectsTypesLinkDirection	direction	Направление связи.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObjectsLink>>	Список связей.

FindAllLinksPaths(int, int, CancellationToken)

Возвращает все найденные пути между объектами.

Declaration

Task<IReadOnlyList<IReadOnlyList<ITechObjectsLink>>> FindAllLinksPaths(int objectId1, int objectId2, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	objectId1	Идентификатор вышестоящего объекта.
int	objectId2	Идентификатор нижестоящего объекта.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<IReadOnlyList<ITechObjectsLink>>>	Список найденных путей (каждый путь содержит список связей между объектами).

FindLinksPath(int, ITechObjectsLink, CancellationToken)

Возвращает путь из связей от головного объекта до объекта с указанной связью.

Declaration

Task<IReadOnlyList<ITechObjectsLink>> FindLinksPath(int rootObjectId, ITechObjectsLink link, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	rootObjectId	Идентификатор головного объекта.
ITechObjectsLink	link	Связь с самым нижним объектом.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObjectsLink>>	Список связей пути между объектами.

FindObjectsPath(int, int, CancellationToken)

Возвращает кратчайший путь между объектами.

Declaration

Task<IReadOnlyList<TechObjectFindPathResult>> FindObjectsPath(int objectId1, int objectId2, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	objectId1	Идентификатор вышестоящего объекта.
int	objectId2	Идентификатор нижестоящего объекта.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<TechObjectFindPathResult>>	Список узлов кратчайшего пути между объектами.

GetAllRecursive(ITechObject, CancellationToken)

Возвращает список прямых связей объекта, включая всю вложенную структуру на всех уровнях.

Declaration

Task<IReadOnlyList<ITechObjectsLink>> GetAllRecursive(ITechObject techObject, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObject	techObject	Объект, для которого необходимо получить связи.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObjectsLink>>	Список связей.

GetById(int, CancellationToken)

Возвращает связь по идентификатру.

Declaration

Task<ITechObjectsLink?> GetById(int id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
int	id	Идентификатор связи объектов.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<ITechObjectsLink>	Связь с указанным идентификатором или null.

GetByIds(IEnumerable<int>, CancellationToken)

Возвращает список связей по идентификатрам.

Declaration

Task<IReadOnlyList<ITechObjectsLink>> GetByIds(IEnumerable<int> ids, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IEnumerable<int>	ids	Идентификаторы связей объектов.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObjectsLink>>	Список связей.

GetObjectLinks(ITechObject, TechObjectsTypesLinkDirection, CancellationToken)

Возвращает все связи объекта определённого направления.

Declaration

Task<IReadOnlyList<ITechObjectsLink>> GetObjectLinks(ITechObject techObject, TechObjectsTypesLinkDirection direction, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITechObject	techObject	Объект, относительно которого ищутся связи.
TechObjectsTypesLinkDirection	direction	Направление связи.
CancellationToken	cancellationToken	Признак отмены операции.

Returns

Type	Description
Task<IReadOnlyList<ITechObjectsLink>>	Список связей объекта.