FunctionalModel Class

A container for persisting FunctionalElements.




Name Description
constructor(props: ModelProps, iModel: IModelDb): FunctionalModel    
insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String Static Insert a FunctionalPartition and a FunctionalModel that breaks it down.  

Inherited methods

Name Inherited from Description
buildConcurrencyControlRequest(opcode: DbOpcode): void Model Add a request for the locks that would be needed to carry out the specified operation.
clone(): this Entity Make a deep copy of this Entity
forEachProperty(func: PropertyCallback, includeCustom: boolean = false): void Entity Call a function for each property of this Entity.
getJsonProperty(name: string): any Model  
getUserProperties(namespace: string): any Model Get a set of JSON user properties by namespace
removeUserProperties(nameSpace: string): void Model Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(name: string, value: any): void Model  
setUserProperties(nameSpace: string, value: any): void Model Change a set of user JSON properties of this Element by namespace.
onDelete(_props: ModelProps): IModelStatus Static Model  
onDeleted(_props: ModelProps): void Static Model  
onInsert(_props: ModelProps): IModelStatus Static Model  
onInserted(_id: string): void Static Model  
onUpdate(_props: ModelProps): IModelStatus Static Model  
onUpdated(_props: ModelProps): void Static Model  

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string Entity Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string Entity Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string Entity The name of the BIS class associated with this class.
id Id64String Entity The Id of this Entity.
iModel IModelDb Entity The Entity.IModelDb that contains this Entity
isPrivate boolean Model  
isTemplate boolean Model  
jsonProperties any Model  
modeledElement RelatedElement Model  
name string Model  
parentModel Id64String Model  
schema Static Schema Entity The Schema that defines this class.
schemaName Accessor ReadOnly string Entity The name of the BIS Schema that defines this class

Defined in

Last Updated: 03 June, 2019