API Reference › core-backend › Elements › GenericPhysicalType

GenericPhysicalType Class

The Generic:PhysicalType class is used when the physical type cannot be further classified.

@note More-specific BisCore:PhysicalType subclasses should be used wherever possible.

Extends

Methods

Name Description
constructor(props: PhysicalTypeProps, iModel: IModelDb): GenericPhysicalType    

Inherited methods

Name Inherited from Description
collectPredecessorIds(predecessorIds: EntityReferenceSet): void Protected PhysicalType Collect the Ids of this element's references at this level of the class hierarchy.
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected PhysicalType Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void PhysicalType Delete this Element from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void PhysicalType Call a function for each property of this Entity.
getClassMetaData(): undefined | EntityMetaData PhysicalType Get the class metadata for this element.
getDisplayLabel(): string PhysicalType Get a display label for this Element.
getJsonProperty(nameSpace: string): any PhysicalType Get a JSON property of this element, by namespace
getPredecessorIds(): Id64Set PhysicalType Get the Ids of this element's references.
getReferenceIds(): EntityReferenceSet PhysicalType Get the set of this entity's entity references, EntityReferenceSet.
getToolTipMessage(): string[] PhysicalType Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any PhysicalType Get a set of JSON user properties by namespace
insert(): string PhysicalType Insert this Element into the iModel.
removeUserProperties(nameSpace: string): void PhysicalType Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void PhysicalType  
setUserProperties(nameSpace: string, value: any): void PhysicalType Change a set of user JSON properties of this Element by namespace.
toJSON(): PhysicalTypeProps PhysicalType Obtain the JSON representation of this Entity.
update(): void PhysicalType Update this Element in the iModel.
createCode(iModel: IModelDb, scopeModelId: string, codeValue: string): Code Static PhysicalType Create a Code for a PhysicalType element given a name that is meant to be unique within the scope of the specified DefinitionModel.
is(otherClass: undefined): boolean Static PhysicalType return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic PhysicalType Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
onBeforeOutputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic PhysicalType Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void ProtectedStatic PhysicalType Called when an existing element is about to be updated so that an instance of this class will become its new parent.
onChildAdded(_arg: OnChildElementIdArg): void ProtectedStatic PhysicalType Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void ProtectedStatic PhysicalType Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(_arg: OnChildElementIdArg): void ProtectedStatic PhysicalType Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void ProtectedStatic PhysicalType Called when an element with an instance of this class as its parent is about to be updated change to a different parent.
onChildDropped(_arg: OnChildElementIdArg): void ProtectedStatic PhysicalType Called after an element with an instance of this class as its previous parent was updated to have a new parent.
onChildInsert(_arg: OnChildElementPropsArg): void ProtectedStatic PhysicalType Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(_arg: OnChildElementIdArg): void ProtectedStatic PhysicalType Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void ProtectedStatic PhysicalType Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(_arg: OnChildElementIdArg): void ProtectedStatic PhysicalType Called after an element with an instance of this the class as its parent was updated.
onCloned(_context: IModelElementCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void ProtectedStatic PhysicalType Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel.
onDelete(arg: OnElementIdArg): void ProtectedStatic PhysicalType Called before an Element is deleted.
onDeleted(_arg: OnElementIdArg): void ProtectedStatic PhysicalType Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void ProtectedStatic PhysicalType Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void ProtectedStatic PhysicalType Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void ProtectedStatic PhysicalType Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(_arg: OnSubModelIdArg): void ProtectedStatic PhysicalType Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void ProtectedStatic PhysicalType Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(_arg: OnSubModelIdArg): void ProtectedStatic PhysicalType Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void ProtectedStatic PhysicalType Called before an Element is updated.
onUpdated(_arg: OnElementIdArg): void ProtectedStatic PhysicalType Called after an Element was updated.

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string PhysicalType Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string PhysicalType Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string PhysicalType The name of the BIS class associated with this class.
code Code PhysicalType The Code for this element
federationGuid undefined | string PhysicalType A FederationGuid assigned to this element by some other federated database
id string PhysicalType The Id of this Entity.
iModel IModelDb PhysicalType The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" PhysicalType An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
isPrivate boolean PhysicalType If true, don't show this DefinitionElement in user interface lists.
jsonProperties Readonly { T } PhysicalType Optional json properties of this element.
model Readonly string PhysicalType The ModelId of the Model containing this element
parent undefined | RelatedElement PhysicalType The parent element, if present, of this element.
physicalMaterial undefined | RelatedElement PhysicalType If defined, the PhysicalMaterial that makes up this PhysicalType.
recipe undefined | RelatedElement PhysicalType  
requiredReferenceKeys StaticReadonly undefined PhysicalType A required reference is an element that had to be inserted before this element could have been inserted.
schema Static undefined PhysicalType The Schema that defines this class.
schemaName Accessor ReadOnly string PhysicalType The name of the BIS Schema that defines this class
userLabel undefined | string PhysicalType A user-assigned label for this element.

Defined in

Last Updated: 19 April, 2024