avid.linkers.caseInstanceLinker.CaseInstanceLinker

class avid.linkers.caseInstanceLinker.CaseInstanceLinker(useStrictLinkage=False, allowOnlyFullLinkage=True, performInternalLinkage=False)

Bases: InnerLinkerBase

Links data on the basis of the artefactProps.CASEINSTANCE entry. If strict linkage is false the linker will also accept instances where one of primary and secondary is none and the other has a defined value.

__init__(useStrictLinkage=False, allowOnlyFullLinkage=True, performInternalLinkage=False)

@param useStrictLinkage If true it will only link with the very same instance id. If false, it will treat None as wildcard that also matches.

Methods

__init__([useStrictLinkage, ...])	@param useStrictLinkage If true it will only link with the very same instance id.
getLinkedSelection(primaryIndex, ...)	Get the subset (splits) of secondary selections that has a meaningful semantic link to the primary selection/index.

getLinkedSelection(primaryIndex, primarySelections, secondarySelections)

Get the subset (splits) of secondary selections that has a meaningful semantic link to the primary selection/index. To change the behavior reimplement self._getLinkedSelection(). The default implementation just passes through the secondarySelections (so everything gets linked). Linker might alter a secondary selections before they are passed back as linked selections (e.g. change the order of the artefact in the selection or its content) @result List of all valid selections (list) of linked artefacts. Therefore all selections of artefacts from secondarySelections that fullfill the link criterion in respect to the primary selection. @param primaryIndex index of the entry in the primarySelections that is defining for the link. @param primarySelections the list of all selections that contain sets of primary artefacts @param secondarySelections the list that is used to generate/pick the linked selections from.