IDSSpecifications

Component that manages Information Delivery Specification (IDS) data. It provides functionality for importing, exporting, and manipulating IDS data. 📕 Tutorial. 📘 API.

Extends

• Component

Methods

create()

create(name, ifcVersion, identifier?): IDSSpecification

Creates a new IDSSpecification instance and adds it to the list.

Parameters

Parameter	Type	Description
name	string	The name of the IDSSpecification.
ifcVersion	IfcVersion[]	An array of IfcVersion values that the specification supports.
identifier?	string	-

Returns

IDSSpecification

The newly created IDSSpecification instance.

---

export()

export(info, specifications): string

Exports the IDSSpecifications data into an XML string.

Parameters

Parameter	Type	Description
info	IDSInfo	The metadata information for the exported XML.
specifications	Iterable <IDSSpecification>	An optional iterable of IDSSpecification instances to export.
If not provided, all specifications in the list will be exported.

Returns

string

A string containing the exported IDSSpecifications data in XML format.

---

getModelIdMap()

getModelIdMap(result): object

Processes the results of an IDS check and categorizes the items into passing and failing.

Parameters

Parameter	Type	Description
result	IDSCheckResult	An IDSCheckResult object containing the check results for various model IDs.

Returns

object

An object containing two ModelIdMap objects:

• pass: A ModelIdMap representing items that passed the check.
• fail: A ModelIdMap representing items that failed the check.

fail

fail: ModelIdMap

pass

pass: ModelIdMap

---

isConfigurable()

isConfigurable(): this is Configurable<any, any>

Whether is component is Configurable.

Returns

this is Configurable<any, any>

Inherited from

Component . isConfigurable

---

isDisposeable()

isDisposeable(): this is Disposable

Whether is component is Disposable.

Returns

this is Disposable

Inherited from

Component . isDisposeable

---

isHideable()

isHideable(): this is Hideable

Whether is component is Hideable.

Returns

this is Hideable

Inherited from

Component . isHideable

---

isResizeable()

isResizeable(): this is Resizeable

Whether is component is Resizeable.

Returns

this is Resizeable

Inherited from

Component . isResizeable

---

isSerializable()

isSerializable(): this is Serializable<any, Record<string, any>>

Whether is component is Serializable.

Returns

this is Serializable<any, Record<string, any>>

Inherited from

Component . isSerializable

---

isUpdateable()

isUpdateable(): this is Updateable

Whether is component is Updateable.

Returns

this is Updateable

Inherited from

Component . isUpdateable

---

load()

load(data): IDSSpecification[]

Parses and processes an XML string containing Information Delivery Specification (IDS) data. It creates IDSSpecification instances based on the parsed data and returns them in an array. Also, the instances are added to the list array.

Parameters

Parameter	Type	Description
data	string	The XML string to parse.

Returns

IDSSpecification[]

An array of IDSSpecification instances created from the parsed data.