ProductOccurrence

class ProductOccurrence()

Constructors

• constructor()

Properties

• __NodeMixin
• __ProductOccurrence
• _bits
• _nodeId

Methods

• _hasBits()
• _setVisibility()
• addAttachContext()
• addAttribute()
• addBodyInstance()
• addCadView()
• addLoadContext()
• addPendingExternalModel()
• addPmi()
• addProductOccurrence()
• forEachBodyInstance()
• forEachCadView()
• forEachChild()
• forEachPmi()
• getAttributes()
• getAuthoredId()
• getAuthoredLayerId()
• getBodyInstances()
• getBranchVisibility()
• getCadViews()
• getChildContexts()
• getChildren()
• getChildrenSync()
• getExchangeId()
• getGenericId()
• getGenericTypeId()
• getLocalTransform()
• getMeasurementUnit()
• getName()
• getParent()
• getPartDefinition()
• getPartDefinitionSync()
• getPhysicalProperties()
• getPmis()
• getPrototype()
• getRawPartDefinition()
• getRuntimeId()
• getUserData()
• getUserDataIndices()
• hasAuthoredId()
• hasBodyInstances()
• hasLocalTransformOverride()
• hasMeasurementUnit()
• hasPendingExternalModels()
• isAConfigurationNode()
• isADefaultNode()
• isADrawingSheetNode()
• isADrawingViewNode()
• isAGroupNode()
• isAProductNode()
• isAbsoluteRoot()
• isExternalModelRoot()
• isInitiallyShown()
• isLoaded()
• isMissing()
• isOutOfHierarchy()
• isVisible()
• loadPendingExternalModels()
• markBranchVisibilityDirty()
• markIsExternalModelRoot()
• markLoaded()
• overrideLocalTransform()
• purgeContents()
• removeBodyInstance()
• removeLocalTransformOverride()
• removePartDefinition()
• removePmi()
• removeProductOccurrence()
• removePrototype()
• setLocalTransformAsInitial()
• setMeasurementUnit()
• setPartDefinition()
• setPrototype()
• setVisibility()
• tryGetChildrenSync()
• unsetMeasurementUnit()
• createDynamic()
• createMissing()
• parseBinary()
• parseXml()
• reify()
• reifySync()

---

Constructors

ProductOccurrence.constructor(assemblyTree, masterModelKey, info)

Arguments:

• assemblyTree (IAssemblyTree()) – None
• masterModelKey (MasterModelKey()) – None
• info (NodeInfo()) – None

Return type:

ProductOccurrence()

Properties

ProductOccurrence.__NodeMixin

Type:PhantomMember

ProductOccurrence.__ProductOccurrence

Type:PhantomMember

ProductOccurrence._bits

Type:NodeBits | ProductBits

ProductOccurrence._nodeId

Type:AuthoredNodeId | DynamicNodeId

Methods

_hasBits

ProductOccurrence._hasBits(bits)

Arguments:

• bits (NodeBits | ProductBits) – None

Return type:

boolean

_setVisibility

ProductOccurrence._setVisibility(visible)

Arguments:

• visible (boolean()) – None

Return type:

void

addAttachContext

ProductOccurrence.addAttachContext(context)

Arguments:

• context (AttachContext()) – None

Return type:

void

addAttribute

ProductOccurrence.addAttribute(attr)

Arguments:

• attr (Attribute()) – None

Return type:

void

addBodyInstance

ProductOccurrence.addBodyInstance(node)

Arguments:

• node (BodyInstance()) – None

Return type:

void

addCadView

ProductOccurrence.addCadView(node)

Arguments:

• node (CadView()) – None

Return type:

void

addLoadContext

ProductOccurrence.addLoadContext(context)

Arguments:

• context (LoadContext()) – None

Return type:

void

addPendingExternalModel

ProductOccurrence.addPendingExternalModel(info)

Arguments:

• info (ExternalModelInfo) – None

Return type:

void

addPmi

ProductOccurrence.addPmi(node)

Arguments:

• node (Pmi()) – None

Return type:

void

addProductOccurrence

ProductOccurrence.addProductOccurrence(node)

Arguments:

• node (ProductOccurrence()) – None

Return type:

void

forEachBodyInstance

ProductOccurrence.forEachBodyInstance(callback)

Arguments:

• callback (function()) – None

Return type:

Promise <void>

ProductOccurrence.callback(node)

Arguments:

• node (BodyInstance()) – None

Return type:

void | Promise <void>

forEachCadView

ProductOccurrence.forEachCadView(callback)

Arguments:

• callback (function()) – None

Return type:

Promise <void>

ProductOccurrence.callback(node)

Arguments:

• node (CadView()) – None

Return type:

void | Promise <void>

forEachChild

ProductOccurrence.forEachChild(callback)

Arguments:

• callback (function()) – None

Return type:

Promise <void>

ProductOccurrence.callback(node)

Arguments:

• node (ProductOccurrence()) – None

Return type:

void | Promise <void>

forEachPmi

ProductOccurrence.forEachPmi(callback)

Arguments:

• callback (function()) – None

Return type:

Promise <void>

ProductOccurrence.callback(node)

Arguments:

• node (Pmi()) – None

Return type:

void | Promise <void>

getAttributes

ProductOccurrence.getAttributes()

Return type:Promise <[Attribute()]>

getAuthoredId

ProductOccurrence.getAuthoredId()

Return type:AuthoredNodeId

getAuthoredLayerId

ProductOccurrence.getAuthoredLayerId()

Return type:AuthoredLayerId | null

getBodyInstances

ProductOccurrence.getBodyInstances()

Return type:[BodyInstance()]

getBranchVisibility

ProductOccurrence.getBranchVisibility()

Return type:BranchVisibility

getCadViews

ProductOccurrence.getCadViews()

Return type:[CadView()]

getChildContexts

ProductOccurrence.getChildContexts()

Return type:[ChildContext]

getChildren

ProductOccurrence.getChildren()

Return type:Promise <[ProductOccurrence()]>

getChildrenSync

ProductOccurrence.getChildrenSync()

Return type:[ProductOccurrence()]

getExchangeId

ProductOccurrence.getExchangeId()

Return type:ExchangeId | null

getGenericId

ProductOccurrence.getGenericId()

Return type:GenericId | null

getGenericTypeId

ProductOccurrence.getGenericTypeId()

Return type:GenericTypeId | null

getLocalTransform

ProductOccurrence.getLocalTransform()

Return type:Matrix16 | null

getMeasurementUnit

ProductOccurrence.getMeasurementUnit()

Return type:number

getName

ProductOccurrence.getName()

Return type:string | null

getParent

ProductOccurrence.getParent()

Return type:ProductOccurrenceParent

getPartDefinition

ProductOccurrence.getPartDefinition()

Return type:Promise <Boxed() <LazyPromise() <PartDefinition()>> | null>

getPartDefinitionSync

ProductOccurrence.getPartDefinitionSync()

Return type:PartDefinition() | null

getPhysicalProperties

ProductOccurrence.getPhysicalProperties(gatherFromChildren)

Arguments:

• gatherFromChildren (boolean()) – None

Return type:

Promise <PhysicalProperties() | null>

getPmis

ProductOccurrence.getPmis()

Return type:[Pmi()]

getPrototype

ProductOccurrence.getPrototype()

Return type:PrototypeContext() | null

getRawPartDefinition

ProductOccurrence.getRawPartDefinition()

Return type:Promise <Boxed() <LazyPromise() <PartDefinition()>> | null> | LazyPromise() <PartDefinition()> | null

getRuntimeId

ProductOccurrence.getRuntimeId()

Return type:RuntimeNodeId

getUserData

ProductOccurrence.getUserData(index)

Arguments:

• index (UserDataIndex) – None

Return type:

Uint8Array

getUserDataIndices

ProductOccurrence.getUserDataIndices()

Return type:[UserDataIndex]

hasAuthoredId

ProductOccurrence.hasAuthoredId()

Return type:boolean

hasBodyInstances

ProductOccurrence.hasBodyInstances()

Return type:boolean

hasLocalTransformOverride

ProductOccurrence.hasLocalTransformOverride()

Return type:boolean

hasMeasurementUnit

ProductOccurrence.hasMeasurementUnit()

Return type:boolean

hasPendingExternalModels

ProductOccurrence.hasPendingExternalModels()

Return type:boolean

isAConfigurationNode

ProductOccurrence.isAConfigurationNode()

Return type:boolean

isADefaultNode

ProductOccurrence.isADefaultNode()

Return type:boolean

isADrawingSheetNode

ProductOccurrence.isADrawingSheetNode()

Return type:boolean

isADrawingViewNode

ProductOccurrence.isADrawingViewNode()

Return type:boolean

isAGroupNode

ProductOccurrence.isAGroupNode()

Return type:boolean

isAProductNode

ProductOccurrence.isAProductNode()

Return type:boolean

isAbsoluteRoot

ProductOccurrence.isAbsoluteRoot()

Return type:boolean

isExternalModelRoot

ProductOccurrence.isExternalModelRoot()

Return type:boolean

isInitiallyShown

ProductOccurrence.isInitiallyShown()

Return type:boolean

isLoaded

ProductOccurrence.isLoaded()

Return type:boolean

isMissing

ProductOccurrence.isMissing()

Return type:boolean

isOutOfHierarchy

ProductOccurrence.isOutOfHierarchy()

Return type:boolean

isVisible

ProductOccurrence.isVisible()

Return type:boolean

loadPendingExternalModels

ProductOccurrence.loadPendingExternalModels(treeLoader)

Arguments:

• treeLoader (TreeLoader()) – None

Return type:

Promise <[AttachContext()]>

markBranchVisibilityDirty

ProductOccurrence.markBranchVisibilityDirty()

Return type:void

markIsExternalModelRoot

ProductOccurrence.markIsExternalModelRoot(assemblyTree)

Arguments:

• assemblyTree (IAssemblyTree()) – None

Return type:

void

markLoaded

ProductOccurrence.markLoaded()

Return type:void

overrideLocalTransform

ProductOccurrence.overrideLocalTransform(matrix)

Arguments:

• matrix (Matrix16()) – None

Return type:

void

purgeContents

ProductOccurrence.purgeContents()

Return type:Promise <void>

removeBodyInstance

ProductOccurrence.removeBodyInstance(node)

Arguments:

• node (BodyInstance()) – None

Return type:

boolean

removeLocalTransformOverride

ProductOccurrence.removeLocalTransformOverride()

Return type:void

removePartDefinition

ProductOccurrence.removePartDefinition()

Return type:PartDefinition()

removePmi

ProductOccurrence.removePmi(node)

Arguments:

• node (Pmi()) – None

Return type:

boolean

removeProductOccurrence

ProductOccurrence.removeProductOccurrence(node)

Arguments:

• node (ProductOccurrence()) – None

Return type:

boolean

removePrototype

ProductOccurrence.removePrototype()

Return type:PrototypeContext()

setLocalTransformAsInitial

ProductOccurrence.setLocalTransformAsInitial(matrix)

Arguments:

• matrix (Matrix16()) – None

Return type:

void

setMeasurementUnit

ProductOccurrence.setMeasurementUnit(unit)

Arguments:

• unit (number()) – None

Return type:

void

setPartDefinition

ProductOccurrence.setPartDefinition(partDef)

Arguments:

• partDef (PartDefinition()) – None

Return type:

void

setPrototype

ProductOccurrence.setPrototype(prototype)

Arguments:

• prototype (PrototypeContext()) – None

Return type:

void

setVisibility

ProductOccurrence.setVisibility(visible)

Arguments:

• visible (boolean()) – None

Return type:

void

tryGetChildrenSync

ProductOccurrence.tryGetChildrenSync()

Return type:[ProductOccurrence()] | null

unsetMeasurementUnit

ProductOccurrence.unsetMeasurementUnit()

Return type:void

static createDynamic

ProductOccurrence.createDynamic(assemblyTree, parent, name, authoredId, localTransform, visible, outOfHierarchy, measurementUnit)

Arguments:

• assemblyTree (IAssemblyTree()) – None
• parent (ProductOccurrenceParent) – None
• name (string | null()) – None
• authoredId (AuthoredNodeId | null) – None
• localTransform (Matrix16 | null()) – None
• visible (boolean()) – None
• outOfHierarchy (boolean()) – None
• measurementUnit (number | null()) – None

Return type:

ProductOccurrence()

static createMissing

ProductOccurrence.createMissing(assemblyTree, parent)

Arguments:

• assemblyTree (IAssemblyTree()) – None
• parent (ProductOccurrenceParent) – None

Return type:

ProductOccurrence()

static parseBinary

ProductOccurrence.parseBinary(config, assemblyTree, inclusionContext, parser)

Arguments:

• config (LoadSubtreeConfig()) – None
• assemblyTree (IAssemblyTree()) – None
• inclusionContext (InclusionContext()) – None
• parser (AssemblyDataParser()) – None

Return type:

ProductOccurrenceInfo()

static parseXml

ProductOccurrence.parseXml(config, assemblyTree, inclusionContext, elem, toAttachData)

Arguments:

• config (LoadSubtreeConfig()) – None
• assemblyTree (IAssemblyTree()) – None
• inclusionContext (InclusionContext()) – None
• elem (Element()) – None
• toAttachData (ToAttachDataFunc) – None

Return type:

ProductOccurrenceInfo()

static reify

ProductOccurrence.reify(config, treeLoader, assemblyTree, inclusionContext, info, parent)

Arguments:

• config (LoadSubtreeConfig()) – None
• treeLoader (TreeLoader()) – None
• assemblyTree (IAssemblyTree()) – None
• inclusionContext (InclusionContext()) – None
• info (ProductOccurrenceInfo()) – None
• parent (ProductOccurrenceParent) – None

Return type:

Promise <ProductOccurrence()>

static reifySync

ProductOccurrence.reifySync(config, treeLoader, assemblyTree, inclusionContext, info, parent)

Arguments:

• config (LoadSubtreeConfig()) – None
• treeLoader (TreeLoader()) – None
• assemblyTree (IAssemblyTree()) – None
• inclusionContext (InclusionContext()) – None
• info (ProductOccurrenceInfo()) – None
• parent (ProductOccurrenceParent) – None

Return type:

ProductOccurrence()