Reference Source
public class | source

MetaObject

Metadata corresponding to an Entity that represents an object.

An Entity represents an object when Entity#isObject is true

A MetaObject corresponds to an Entity by having the same MetaObject#id as the Entity#id.

A MetaObject is created within MetaScene#createMetaModel and belongs to a MetaModel.

Each MetaObject is registered by MetaObject#id in MetaScene#metaObjects.

A MetaModel represents its object structure with a tree of MetaObjects, with MetaModel#rootMetaObject referencing the root MetaObject.

Member Summary

Public Members
public

The attributes of this MetaObject.

public

External application-specific metadata

public

Globally-unique ID.

public get

Backwards compatibility with the object belonging to a single MetaModel.

public

The MetaModels that share this MetaObject.

public

Human-readable name.

public abstract

ID of the corresponding object within the originating system, if any.

public

parent: MetaObject | null

The parent MetaObject.

public

ID of the parent MetaObject.

public

propertySetIds: [] | *

IDs of PropertySets associated with this MetaObject.

public

The PropertySets associated with this MetaObject.

public

Type - often an IFC product type.

Method Summary

Public Methods
public

getJSON(): {id: String|Number, type: String, name: String, parent: String|Number|Undefined}

Returns properties of this MeteObject as JSON.

public

Gets the MetaObject#ids of the MetaObjects within the subtree.

public

Gets the MetaObject#ids of the MetaObjects within the subtree that have the given MetaObject#types.

public

Iterates over the MetaObjects within the subtree.

Public Members

public attributes: {} source

The attributes of this MetaObject.

public external: * source

External application-specific metadata

Undefined when there are is no external application-specific metadata.

Properties:

NameTypeAttributeDescription
external *

public id: String | Number source

Globally-unique ID.

MetaObject instances are registered by this ID in MetaScene#metaObjects.

Properties:

NameTypeAttributeDescription
id *

public get metaModel: MetaModel | null source

Backwards compatibility with the object belonging to a single MetaModel.

Properties:

NameTypeAttributeDescription
metaModel *

public metaModels: MetaModel[] source

The MetaModels that share this MetaObject.

public name: String source

Human-readable name.

Properties:

NameTypeAttributeDescription
name *

public abstract originalSystemId: String source

ID of the corresponding object within the originating system, if any.

public parent: MetaObject | null source

The parent MetaObject.

public parentId: String | Number source

ID of the parent MetaObject.

public propertySetIds: [] | * source

IDs of PropertySets associated with this MetaObject.

public propertySets: PropertySet[] source

The PropertySets associated with this MetaObject.

Properties:

NameTypeAttributeDescription
propertySets *

public type: String source

Type - often an IFC product type.

Properties:

NameTypeAttributeDescription
type *

Public Methods

public getJSON(): {id: String|Number, type: String, name: String, parent: String|Number|Undefined} source

Returns properties of this MeteObject as JSON.

Return:

{id: String|Number, type: String, name: String, parent: String|Number|Undefined}

public getObjectIDsInSubtree(): String[] source

Gets the MetaObject#ids of the MetaObjects within the subtree.

Return:

String[]

Array of MetaObject#ids.

public getObjectIDsInSubtreeByType(types: String[]): String[] source

Gets the MetaObject#ids of the MetaObjects within the subtree that have the given MetaObject#types.

Params:

NameTypeAttributeDescription
types String[]

MetaObject#type values.

Return:

String[]

Array of MetaObject#ids.

public withMetaObjectsInSubtree(callback: Function) source

Iterates over the MetaObjects within the subtree.

Params:

NameTypeAttributeDescription
callback Function

Callback fired at each MetaObject.