InclusionContext

class InclusionContext()

Constructors

constructor()

Properties

__InclusionContext

Methods

addBimIdToMap()
addBimInfos()
addProductOccurrence()
addRelationship()
getAttachContext()
getBimInfos()
getChildren()
getIdOffset()
getInclusionKey()
getModelKey()
getParent()
getRelationships()
getRuntimeNodeFromBimId()
hasChildren()
isLoaded()
purgeContents()
removeProductOccurrence()
split()
toRuntimeId()

Constructors

InclusionContext.constructor(assemblyTree, attachContext, inclusionKey, modelKey)

Arguments:	assemblyTree (`IAssemblyTree()`) – None attachContext (`AttachContext()`) – None inclusionKey (`InclusionKey()`) – None modelKey (`ModelKey()`) – None
Return type:	`InclusionContext()`

Properties

InclusionContext.__InclusionContext

Type:	PhantomMember

Methods

addBimIdToMap

InclusionContext.addBimIdToMap(bimId, runtimeId)

Arguments:	bimId (BimId) – None runtimeId (RuntimeNodeId) – None
Return type:	void

addBimInfos

InclusionContext.addBimInfos(bimInfo)

Arguments:	bimInfo (`BimObject()`) – None
Return type:	void

addProductOccurrence

InclusionContext.addProductOccurrence(node)

Arguments:	node (`ProductOccurrence()`) – None
Return type:	void

addRelationship

InclusionContext.addRelationship(relationship)

Arguments:	relationship (`Relationship()`) – None
Return type:	void

getAttachContext

InclusionContext.getAttachContext()

Return type:	`AttachContext()`

getBimInfos

InclusionContext.getBimInfos()

Return type:	[`BimObject()`]

getChildren

InclusionContext.getChildren()

Return type:	[`ProductOccurrence()`]

getIdOffset

InclusionContext.getIdOffset()

Return type:	NodeIdOffset

getInclusionKey

InclusionContext.getInclusionKey()

Return type:	InclusionKey

getModelKey

InclusionContext.getModelKey()

Return type:	ModelKey

getParent

InclusionContext.getParent()

Return type:	`AttachContext()`

getRelationships

InclusionContext.getRelationships()

Return type:	[`Relationship()`]

getRuntimeNodeFromBimId

InclusionContext.getRuntimeNodeFromBimId(bimId)

Arguments:	bimId (BimId) – None
Return type:	RuntimeNodeId \| null

hasChildren

InclusionContext.hasChildren()

Return type:	boolean

isLoaded

InclusionContext.isLoaded()

Return type:	boolean

purgeContents

InclusionContext.purgeContents()

Return type:	Promise <void>

removeProductOccurrence

InclusionContext.removeProductOccurrence(node)

Arguments:	node (`ProductOccurrence()`) – None
Return type:	boolean

split

InclusionContext.split(assemblyTree, parent)

Arguments:	assemblyTree (`IAssemblyTree()`) – None parent (`AttachContext()`) – None
Return type:	`InclusionContext()`

toRuntimeId

InclusionContext.toRuntimeId(authoredId)

Arguments:	authoredId (AuthoredNodeId) – None
Return type:	RuntimeNodeId