### InMemoryGeometryStore Methods - BeginInit Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/Xbim.Common.Model Initiates the initialization process for the InMemoryGeometryStore, returning an IGeometryStoreInitialiser to facilitate setup. ```csharp public IGeometryStoreInitialiser BeginInit() ``` -------------------------------- ### IIfcSpace.ElevationWithFlooring Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ProductExtension Gets or sets the elevation with flooring for an IfcSpace. ```APIDOC ## GET /IfcSpace/ElevationWithFlooring ### Description Gets the elevation with flooring for an IfcSpace. ### Method GET ### Endpoint /IfcSpace/ElevationWithFlooring ### Response #### Success Response (200) - **elevationWithFlooring** (System.Nullable) - The elevation with flooring value. ## PUT /IfcSpace/ElevationWithFlooring ### Description Sets the elevation with flooring for an IfcSpace. ### Method PUT ### Endpoint /IfcSpace/ElevationWithFlooring ### Parameters #### Request Body - **elevationWithFlooring** (IfcLengthMeasure) - Required - The new elevation with flooring value. ### Response #### Success Response (200) - **message** (string) - Indicates successful update. #### Response Example ```json { "message": "ElevationWithFlooring updated successfully." } ``` ``` -------------------------------- ### IIfcSpace.PredefinedType Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ProductExtension Gets or sets the predefined type for an IfcSpace. ```APIDOC ## GET /IfcSpace/PredefinedType ### Description Gets the predefined type for an IfcSpace. ### Method GET ### Endpoint /IfcSpace/PredefinedType ### Response #### Success Response (200) - **predefinedType** (System.Nullable) - The predefined type of the IfcSpace. ## PUT /IfcSpace/PredefinedType ### Description Sets the predefined type for an IfcSpace. ### Method PUT ### Endpoint /IfcSpace/PredefinedType ### Parameters #### Request Body - **predefinedType** (IfcSpaceTypeEnum) - Required - The new predefined type for the IfcSpace. ### Response #### Success Response (200) - **message** (string) - Indicates successful update. #### Response Example ```json { "message": "PredefinedType updated successfully." } ``` ``` -------------------------------- ### Get Entity References in C# Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.FacilitiesMgmtDomain Provides an IEnumerable collection of IPersistEntity references. This is an explicit interface implementation for IContainsEntityReferences. It allows retrieval of all referenced entities within the current context. ```csharp IEnumerable IContainsEntityReferences.References { get; } ``` -------------------------------- ### IfcPresentableText Properties and Methods (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.PresentationResource Details the properties and methods of the IfcPresentableText struct. It includes a 'Value' property to get the underlying string, and methods for equality checks, hashing, and string conversion. ```csharp public readonly object Value { get; } public override bool Equals(object obj) { // Implementation details omitted for brevity } public bool Equals(string other) { // Implementation details omitted for brevity } public override int GetHashCode() { // Implementation details omitted for brevity } public override string ToString() { // Implementation details omitted for brevity } ``` -------------------------------- ### Get and Set Name for IIfcTable (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.UtilityResource Allows getting and setting the name of an IIfcTable. The name is represented by an IfcLabel, which can be nullable. ```csharp IfcLabel? IIfcTable.Name { get; set; } ``` -------------------------------- ### System.Object Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the base System.Object class and its members. ```APIDOC ## System.Object ### Description Provides fundamental properties and methods for all classes in the .NET Framework. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **Equals(System.Object, System.Object)** - **ReferenceEquals(System.Object, System.Object)** - **GetType()** - **MemberwiseClone()** ``` -------------------------------- ### Get Property Single Value Value (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.Kernel Retrieves the IfcValue of a specific property within a property set, identified by the property set name and property name. This method is a direct way to get the actual data stored in a single-value property. ```csharp public IfcValue GetPropertySingleValueValue(string pSetName, string propertyName) ``` -------------------------------- ### IfcProduct Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the IfcProduct class and its inherited members. ```APIDOC ## IfcProduct ### Description Represents a product, which is a physical object that is part of a building or construction. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **IIfcProduct.ObjectPlacement** - **IIfcProduct.Representation** - **IIfcProduct.ReferencedBy** - **ObjectPlacement** - **Representation** - **ReferencedBy** - **Equals(IfcProduct)** - **IsContainedIn** - **ValidateClause(IfcProduct.IfcProductClause)** ``` -------------------------------- ### Rule Class Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/QUT.Gppg Detailed documentation for the Rule class, including its constructor and parameters. ```APIDOC ## Class Rule Rule representation at runtime. ##### Inheritance System.Object Rule ##### Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() ###### **Namespace** : QUT.Gppg ###### **Assembly** : Xbim.Common.dll ##### Syntax ``` public class Rule ``` ### Constructors #### Rule(Int32, Int32[]) Rule constructor. This holds the ordinal of the left hand side symbol, and the list of right hand side symbols, in lexical order. ##### Declaration ``` public Rule(int left, int[] right) ``` ##### Parameters Type | Name | Description ---|---|--- System.Int32 | left | The LHS non-terminal System.Int32[] | right | The RHS symbols, in lexical order ``` -------------------------------- ### StepFileHeader Constructor Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/Xbim.Common.Step21 This C# code snippet defines the constructor for the StepFileHeader class. It accepts a HeaderCreationMode and an IModel as parameters, used for initializing a new instance of the StepFileHeader. ```csharp public StepFileHeader(StepFileHeader.HeaderCreationMode mode, IModel model) ``` -------------------------------- ### Set/Get IFC Space Predefined Type Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ProductExtension Gets or sets the predefined type of the IFC space. This property accepts and returns a nullable IfcSpaceTypeEnum. ```csharp IfcSpaceTypeEnum? IIfcSpace.PredefinedType { get; set; } ``` -------------------------------- ### InMemoryGeometryStore Methods - BeginRead Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/Xbim.Common.Model Begins a read operation on the InMemoryGeometryStore, returning an IGeometryStoreReader for data retrieval. ```csharp public IGeometryStoreReader BeginRead() ``` -------------------------------- ### IIfcElementType.ElementType Property Declaration (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.BuildingcontrolsDomain Explicit interface implementation for IIfcElementType.ElementType. This property allows setting or getting the element type as an optional IfcLabel. ```csharp IfcLabel? IIfcElementType.ElementType { get; set; } ``` -------------------------------- ### IfcObject Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the IfcObject class and its inherited members. ```APIDOC ## IfcObject ### Description Represents a generic object in an IFC model. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **IIfcObject.ObjectType** - **IIfcObject.IsDeclaredBy** - **IIfcObject.Declares** - **IIfcObject.IsTypedBy** - **IIfcObject.IsDefinedBy** - **ObjectType** - **IsDeclaredBy** - **Declares** - **IsTypedBy** - **IsDefinedBy** - **Equals(IfcObject)** - **AddDefiningType(IfcTypeObject)** - **AddPropertySet(IfcPropertySet)** - **GetPropertySet(String, Boolean)** - **GetPropertySingleValue(String, String)** - **GetPropertySingleValue(String, String)** - **GetPropertySingleNominalValue(String, String)** - **PropertySets** - **SetPropertySingleValue(String, String, Type)** - **SetPropertySingleValue(String, String, IfcValue)** - **GetExternalElements(IModel)** - **GetElementQuantity(String, Boolean)** - **ElementQuantities** - **PhysicalSimpleQuantities** - **GetQuantity(String, String)** - **GetQuantity(String)** - **AddQuantity(String, IIfcPhysicalQuantity, String)** - **AddQuantity(String, IIfcPhysicalQuantity)** - **GetElementPhysicalSimpleQuantity(String, String)** - **SetElementPhysicalSimpleQuantity(String, String, Double, XbimQuantityTypeEnum, IIfcNamedUnit)** - **RemovePropertySingleValue(String, String)** - **RemoveElementPhysicalSimpleQuantity(String, String)** - **ValidateClause(IfcObject.IfcObjectClause)** ``` -------------------------------- ### Get Rows from IIfcTable (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.UtilityResource Retrieves a set of IIfcTableRow objects belonging to an IIfcTable. This is a read-only property returning an IItemSet. ```csharp IItemSet IIfcTable.Rows { get; } ``` -------------------------------- ### IfcElement Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the IfcElement class and its inherited members. ```APIDOC ## IfcElement ### Description Represents a general element in an IFC model. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **IIfcElement.Tag** - **IIfcElement.FillsVoids** - **IIfcElement.ConnectedTo** - **IIfcElement.IsInterferedByElements** - **IIfcElement.InterferesElements** - **IIfcElement.HasProjections** - **IIfcElement.ReferencedInStructures** - **IIfcElement.HasOpenings** - **IIfcElement.IsConnectionRealization** - **IIfcElement.ProvidesBoundaries** - **IIfcElement.ConnectedFrom** - **IIfcElement.ContainedInStructure** - **IIfcElement.HasCoverings** - **Tag** - **FillsVoids** - **ConnectedTo** - **IsInterferedByElements** - **InterferesElements** - **HasProjections** - **ReferencedInStructures** - **HasOpenings** - **IsConnectionRealization** - **ProvidesBoundaries** - **ConnectedFrom** - **ContainedInStructure** - **HasCoverings** - **Equals(IfcElement)** - **Openings** ``` -------------------------------- ### Methods Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.StructuralElementsDomain Details the methods available for the IfcBuildingElementPart class. ```APIDOC ## Methods for IfcBuildingElementPart ### Equals(IfcBuildingElementPart) #### Description Checks if two IfcBuildingElementPart objects are equal. #### Declaration ```csharp public bool Equals(IfcBuildingElementPart other) ``` #### Parameters | Type | Name | Description | |--------------------|-------|-------------| | IfcBuildingElementPart | other | | #### Returns | Type | Description | |---------------|-------------| | System.Boolean | | ### Parse(Int32, IPropertyValue, Int32[]) #### Description Parses the properties of the IfcBuildingElementPart object. #### Declaration ```csharp public override void Parse(int propIndex, IPropertyValue value, int[] nestedIndex) ``` #### Parameters | Type | Name | Description | |------------------|-------------|-------------| | System.Int32 | propIndex | | | IPropertyValue | value | | | System.Int32[] | nestedIndex | | #### Overrides IfcBuildingElementComponent.Parse(Int32, IPropertyValue, Int32[]) ``` -------------------------------- ### Get Columns from IIfcTable (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.UtilityResource Retrieves a set of IIfcTableColumn objects associated with an IIfcTable. This property is read-only and returns an IItemSet. ```csharp IItemSet IIfcTable.Columns { get; } ``` -------------------------------- ### Set/Get IFC Space Elevation with Flooring Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ProductExtension Gets or sets the elevation of the IFC space relative to the flooring. This property accepts and returns a nullable IfcLengthMeasure. ```csharp IfcLengthMeasure? IIfcSpace.ElevationWithFlooring { get; set; } ``` -------------------------------- ### IfcRoot Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the IfcRoot class and its inherited members. ```APIDOC ## IfcRoot ### Description Represents the root of an IFC entity. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **IIfcRoot.GlobalId** - **IIfcRoot.OwnerHistory** - **IIfcRoot.Name** - **IIfcRoot.Description** - **GlobalId** - **OwnerHistory** - **Name** - **Description** - **Equals(IfcRoot)** ``` -------------------------------- ### Get IFC Space Boundaries Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ProductExtension Retrieves a collection of IIfcRelSpaceBoundary objects that define the boundaries of the IFC space. This is a read-only property and returns an IEnumerable collection. ```csharp IEnumerable IIfcSpace.BoundedBy { get; } ``` -------------------------------- ### StepFileHeader Methods Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/Xbim.Common.Step21 This C# code snippet lists the methods available in the StepFileHeader class. These methods include OnPropertyChanged for handling property change notifications, Read for parsing data from a BinaryReader, StampXbimApplication for stamping the STEP file with Xbim application information, and Write for serializing the header to a BinaryWriter. ```csharp protected virtual void OnPropertyChanged(string propertyName) ``` ```csharp public void Read(BinaryReader binaryReader) ``` ```csharp public void StampXbimApplication(XbimSchemaVersion schemaVersion, IModel model) ``` ```csharp public void Write(BinaryWriter binaryWriter) ``` -------------------------------- ### C# IfcEquipmentStandard Equals Method Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.FacilitiesMgmtDomain Implements the Equals method for the IfcEquipmentStandard class to compare two instances for equality. It takes another IfcEquipmentStandard object as input. ```csharp public bool Equals(IfcEquipmentStandard other) { // Implementation details would go here return false; // Placeholder } ``` -------------------------------- ### Get IFC Space Coverings Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ProductExtension Retrieves a collection of IIfcRelCoversSpaces objects that represent coverings associated with the IFC space. This is a read-only property and returns an IEnumerable collection. ```csharp IEnumerable IIfcSpace.HasCoverings { get; } ``` -------------------------------- ### Basic Object Methods (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.IO.Esent/Xbim.IO.Esent This snippet lists the fundamental methods inherited from System.Object that are available for any object instance, including XbimSurfaceStyleMap. These include methods for string representation, equality comparison, hashing, and type information. ```csharp System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() ``` -------------------------------- ### Get Definitions By Properties for IIfcTypeObject Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.Kernel Retrieves a collection of IFC relationships that define properties for this IFC type object. This property is read-only. ```csharp IEnumerable IIfcTypeObject.DefinedByProperties { get; } ``` -------------------------------- ### Get Property Sets for IIfcTypeObject Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.Kernel Retrieves the set of property set definitions associated with an IFC type object. This property is read-only. ```csharp IItemSet IIfcTypeObject.HasPropertySets { get; } ``` -------------------------------- ### ProxyNestedItemSet Class Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/Xbim.Common.Collections Documentation for the ProxyNestedItemSet class, including its constructors, properties, and methods. ```APIDOC ## Class ProxyNestedItemSet ### Description Represents a nested item set with inner and outer types, implementing various collection interfaces. ### Namespace Xbim.Common.Collections ### Assembly Xbim.Common.dll ### Syntax ```csharp public class ProxyNestedItemSet : IItemSet>, IList>, ICollection>, IEnumerable>, INotifyCollectionChanged, INotifyPropertyChanged, IExpressEnumerable, IItemSet, IList, ICollection, IEnumerable where TInner : TOuter ``` ### Type Parameters - **TInner**: Represents the inner type. - **TOuter**: Represents the outer type. ### Constructors #### ProxyNestedItemSet(IItemSet>) ##### Description Initializes a new instance of the ProxyNestedItemSet class. ##### Declaration ```csharp public ProxyNestedItemSet(IItemSet> inner) ``` ##### Parameters - **inner** (IItemSet>): The inner item set. ### Properties #### IsFixedSize ##### Description Gets a value indicating whether the collection has a fixed size. ##### Declaration ```csharp public bool IsFixedSize { get; } ``` ##### Property Value - **System.Boolean**: True if the collection has a fixed size; otherwise, false. #### IsSynchronized ##### Description Gets a value indicating whether the collection is synchronized (thread-safe). ##### Declaration ```csharp public bool IsSynchronized { get; } ``` ##### Property Value - **System.Boolean**: True if the collection is synchronized; otherwise, false. #### Item[Int32] ##### Description Gets or sets the element at the specified index. ##### Declaration ```csharp public IItemSet this[int index] { get; set; } ``` ##### Parameters - **index** (System.Int32): The zero-based index of the element to get or set. ##### Property Value - **IItemSet**: The element at the specified index. #### OwningEntity ##### Description Gets the owning entity of this item set. ##### Declaration ```csharp public IPersistEntity OwningEntity { get; } ``` ##### Property Value - **IPersistEntity**: The owning entity. #### SyncRoot ##### Description Gets an object that can be used to synchronize access to the collection. ##### Declaration ```csharp public object SyncRoot { get; } ``` ##### Property Value - **System.Object**: An object that can be used to synchronize access to the collection. ### Methods #### Add(Object) ##### Description Adds an item to the collection. ##### Declaration ```csharp public int Add(object value) ``` ##### Parameters - **value** (System.Object): The item to add to the collection. ##### Returns - **System.Int32**: The zero-based index at which the object was added. #### Add(IItemSet) ##### Description Adds an item to the end of the collection. ##### Declaration ```csharp public void Add(IItemSet item) ``` ##### Parameters - **item** (IItemSet): The item to add to the end of the collection. #### AddRange(IEnumerable>) ##### Description Adds a collection of items to the end of the collection. ##### Declaration ```csharp public void AddRange(IEnumerable> values) ``` ##### Parameters - **values** (System.Collections.Generic.IEnumerable>): The collection of items to add to the end of the collection. #### Contains(Object) ##### Description Determines whether the collection contains a specific value. ##### Declaration ```csharp public bool Contains(object value) ``` ##### Parameters - **value** (System.Object): The value to locate in the collection. ##### Returns - **System.Boolean**: True if the value is found in the collection; otherwise, false. #### Contains(IItemSet) ##### Description Determines whether the collection contains a specific item. ##### Declaration ```csharp public bool Contains(IItemSet item) ``` ##### Parameters - **item** (IItemSet): The item to locate in the collection. ##### Returns - **System.Boolean**: True if the item is found in the collection; otherwise, false. #### CopyTo(Array, Int32) ##### Description Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. ##### Declaration ```csharp public void CopyTo(Array array, int index) ``` ##### Parameters - **array** (System.Array): The one-dimensional Array that is the destination of the elements copied from the collection. Must have zero-based indexing. - **index** (System.Int32): The zero-based index in array at which copying begins. #### CopyTo(IItemSet[], Int32) ##### Description Copies the entire collection to a compatible one-dimensional array of items, starting at the specified index of the target array. ##### Declaration ```csharp public void CopyTo(IItemSet[] array, int arrayIndex) ``` ##### Parameters - **array** (IItemSet[]): The one-dimensional Array that is the destination of the elements copied from the collection. Must have zero-based indexing. - **arrayIndex** (System.Int32): The zero-based index in array at which copying begins. #### FirstOrDefault(Func, Boolean>) ##### Description Returns the first element of a sequence that satisfies a condition, or a default value if no such element is found. ##### Declaration ```csharp public IItemSet FirstOrDefault(Func, bool> predicate) ``` ##### Parameters - **predicate** (System.Func, System.Boolean>): A function to test each element for a condition. ##### Returns - **IItemSet**: The first element in the sequence that passes the test in the specified predicate; otherwise, the default value for the type of the element. #### FirstOrDefault(Func) ##### Description Returns the first element of a sequence that satisfies a condition, or a default value if no such element is found. ##### Declaration ```csharp public TF FirstOrDefault(Func predicate) ``` ##### Parameters - **predicate** (System.Func): A function to test each element for a condition. ##### Returns - **TF**: The first element in the sequence that passes the test in the specified predicate; otherwise, the default value for the type of the element. ``` -------------------------------- ### Get Types for IIfcTypeObject Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.Kernel Retrieves a collection of IFC relationships that define the types of objects associated with this IFC type object. This property is read-only. ```csharp IEnumerable IIfcTypeObject.Types { get; } ``` -------------------------------- ### PersistEntity Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the PersistEntity class and its inherited members. ```APIDOC ## PersistEntity ### Description Base class for persistent entities in the Xbim framework. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **_activated** - **Activate()** - **NotifyPropertyChanged(String)** - **SetValue(Action, TProperty, TProperty, String, Int32)** - **Equals(Object)** - **GetHashCode()** - **ToString()** - **EntityLabel** - **Model** - **ModelOf** - **IPersistEntity.Activated** - **IPersistEntity.ExpressType** - **PropertyChanged** ``` -------------------------------- ### Implement Explicit Interface Property Workability Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.MaterialPropertyResource Implements the Workability property from the IIfcMechanicalConcreteMaterialProperties interface. This property allows getting and setting the workability of the material. ```csharp IfcText? IIfcMechanicalConcreteMaterialProperties.Workability { get; set; } ``` -------------------------------- ### IfcDistributionElement Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the IfcDistributionElement class and its inherited members. ```APIDOC ## IfcDistributionElement ### Description Represents a general element within a distribution system. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **IIfcDistributionElement.HasPorts** - **HasPorts** - **Equals(IfcDistributionElement)** ``` -------------------------------- ### Implement Explicit Interface Property WaterImpermeability Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.MaterialPropertyResource Implements the WaterImpermeability property from the IIfcMechanicalConcreteMaterialProperties interface. This property allows getting and setting the water impermeability. ```csharp IfcText? IIfcMechanicalConcreteMaterialProperties.WaterImpermeability { get; set; } ``` -------------------------------- ### IfcConstructionResource Class Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.ConstructionMgmtDomain Documentation for the IfcConstructionResource abstract class, detailing its inheritance hierarchy, implemented interfaces, and properties. ```APIDOC ## IfcConstructionResource Class ### Description Represents a construction resource in the IFC schema. This is an abstract class and serves as a base for more specific construction resource types. ### Inheritance - System.Object - PersistEntity - IfcRoot - IfcObjectDefinition - IfcObject - IfcResource - IfcConstructionResource ### Implements - System.ComponentModel.INotifyPropertyChanged - System.IEquatable - System.IEquatable - System.IEquatable - IExpressValidatable - System.IEquatable - IIfcConstructionResource - IIfcResource - IIfcObject - IIfcObjectDefinition - IIfcRoot - System.IEquatable - IfcDefinitionSelect - IIfcDefinitionSelect - IfcResourceSelect - IIfcResourceSelect - IExpressSelectType - IPersistEntity - IPersist ### Namespace Xbim.Ifc2x3.ConstructionMgmtDomain ### Assembly Xbim.Ifc2x3.dll ### Syntax ```csharp [ExpressType("IfcConstructionResource", 157)] public abstract class IfcConstructionResource : IfcResource, INotifyPropertyChanged, IEquatable, IEquatable, IEquatable, IExpressValidatable, IEquatable, IIfcConstructionResource, IIfcResource, IIfcObject, IIfcObjectDefinition, IIfcRoot, IEquatable, IIfcConstructionResource, IIfcResource, IIfcObject, IIfcObjectDefinition, IIfcRoot, IfcDefinitionSelect, IIfcDefinitionSelect, IfcResourceSelect, IIfcResourceSelect, IExpressSelectType, IPersistEntity, IPersist ``` ### Properties #### BaseQuantity Represents the base quantity associated with the construction resource. (Specific type and details depend on context and implementation.) ``` -------------------------------- ### Implement Explicit Interface Property AdmixturesDescription Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.MaterialPropertyResource Implements the AdmixturesDescription property from the IIfcMechanicalConcreteMaterialProperties interface. This property allows getting and setting the description of admixtures. ```csharp IfcText? IIfcMechanicalConcreteMaterialProperties.AdmixturesDescription { get; set; } ``` -------------------------------- ### IfcObjectDefinition Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the IfcObjectDefinition class and its inherited members. ```APIDOC ## IfcObjectDefinition ### Description Represents a definition of an object. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **IIfcObjectDefinition.HasAssignments** - **IIfcObjectDefinition.Nests** - **IIfcObjectDefinition.IsNestedBy** - **IIfcObjectDefinition.HasContext** - **IIfcObjectDefinition.IsDecomposedBy** - **IIfcObjectDefinition.Decomposes** - **IIfcObjectDefinition.HasAssociations** - **HasAssignments** - **Nests** - **IsNestedBy** - **HasContext** - **IsDecomposedBy** - **Decomposes** - **HasAssociations** - **Equals(IfcObjectDefinition)** - **Material** - **Item[String]** ``` -------------------------------- ### IIfcBuildingElementPart.PredefinedType Property Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.StructuralElementsDomain This C# code implements the 'PredefinedType' property from the IIfcBuildingElementPart interface. It allows getting and setting the predefined type of the building element part, which is a nullable enum value. ```csharp [CrossSchemaAttribute(typeof(IIfcBuildingElementPart), 9)] IfcBuildingElementPartTypeEnum? IIfcBuildingElementPart.PredefinedType { get; set; } ``` -------------------------------- ### Dictionary Properties Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/Xbim.Common This section details the properties available for dictionaries mapping XbimInstanceHandle to XbimInstanceHandle, such as Count and Keys. ```APIDOC ## Dictionary Properties ### Description This endpoint group provides documentation for properties of a dictionary where both keys and values are of type `XbimInstanceHandle`. Key properties include the number of elements and access to the keys. ### Method - Comparer - Count - Keys ### Endpoint N/A (Represents a set of class properties) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "message": "Refer to the specific property documentation for request details." } ``` ### Response #### Success Response (200) - **Value** (Various) - The value of the requested property. #### Response Example ```json { "propertyName": "Count", "value": 15 } ``` ``` -------------------------------- ### IIfcFastenerType PredefinedType Getter/Setter (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.SharedComponentElements Implements the PredefinedType property from the IIfcFastenerType interface. This property is used to get or set the predefined type of the fastener, with a CrossSchemaAttribute indicating its schema mapping. ```csharp [CrossSchemaAttribute(typeof(IIfcFastenerType), 10)] IfcFastenerTypeEnum IIfcFastenerType.PredefinedType { get; set; } ``` -------------------------------- ### XbimInstanceHandleMap Constructor Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/Xbim.Common Initializes a new instance of the XbimInstanceHandleMap class with specified 'from' and 'to' models. This constructor is used to create a mapping between instances from two different models. ```csharp public XbimInstanceHandleMap(IModel from, IModel to) ``` -------------------------------- ### IfcDistributionFlowElement Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the IfcDistributionFlowElement class and its inherited members. ```APIDOC ## IfcDistributionFlowElement ### Description Represents a general element within a distribution system that carries flow. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **IIfcDistributionFlowElement.HasControlElements** - **HasControlElements** - **Equals(IfcDistributionFlowElement)** ``` -------------------------------- ### Implement Explicit Interface Property ProtectivePoreRatio Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.MaterialPropertyResource Implements the ProtectivePoreRatio property from the IIfcMechanicalConcreteMaterialProperties interface. This property allows getting and setting the protective pore ratio. ```csharp IfcNormalisedRatioMeasure? IIfcMechanicalConcreteMaterialProperties.ProtectivePoreRatio { get; set; } ``` -------------------------------- ### IfcFlowTerminal Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.ElectricalDomain Documentation for the IfcFlowTerminal class and its inherited members. ```APIDOC ## IfcFlowTerminal ### Description Represents a terminal element in a flow system. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Inherited Members - **Equals(IfcFlowTerminal)** ``` -------------------------------- ### Implement Explicit Interface Property MaxAggregateSize Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.MaterialPropertyResource Implements the MaxAggregateSize property from the IIfcMechanicalConcreteMaterialProperties interface. This property allows getting and setting the maximum aggregate size. ```csharp IfcPositiveLengthMeasure? IIfcMechanicalConcreteMaterialProperties.MaxAggregateSize { get; set; } ``` -------------------------------- ### XbimSurfaceStyle Dictionary Operations Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.IO.Esent/Xbim.IO.Esent This section covers the various operations that can be performed on a dictionary where XbimSurfaceStyle is used as the key. ```APIDOC ## XbimSurfaceStyle Dictionary Operations ### Description This section outlines the methods for interacting with a dictionary that uses `Xbim.IO.Esent.XbimSurfaceStyle` as its key type. These operations allow for the management of surface style data. ### Methods and Endpoints This documentation describes C# method signatures, not HTTP endpoints, as the provided text appears to be from a .NET code context. #### Adding Items ##### `Add(Xbim.IO.Esent.XbimSurfaceStyle key, Xbim.IO.Esent.XbimGeometryHandleCollection value)` - **Description**: Adds a new key-value pair to the dictionary. - **Method**: N/A (C# Method) ##### `System.Collections.Generic.ICollection>.Add(System.Collections.Generic.KeyValuePair pair)` - **Description**: Adds a key-value pair using a KeyValuePair structure. - **Method**: N/A (C# Method) #### Checking for Existence ##### `ContainsKey(Xbim.IO.Esent.XbimSurfaceStyle key)` - **Description**: Determines whether the dictionary contains the specified key. - **Method**: N/A (C# Method) ##### `ContainsValue(Xbim.IO.Esent.XbimGeometryHandleCollection value)` - **Description**: Determines whether the dictionary contains the specified value. - **Method**: N/A (C# Method) ##### `System.Collections.Generic.ICollection>.Contains(System.Collections.Generic.KeyValuePair pair)` - **Description**: Determines whether the dictionary contains the specified KeyValuePair. - **Method**: N/A (C# Method) #### Removing Items ##### `Remove(Xbim.IO.Esent.XbimSurfaceStyle key)` - **Description**: Removes the element with the specified key from the dictionary. - **Method**: N/A (C# Method) ##### `System.Collections.Generic.ICollection>.Remove(System.Collections.Generic.KeyValuePair pair)` - **Description**: Removes the first occurrence of a specific KeyValuePair from the dictionary. - **Method**: N/A (C# Method) #### Clearing the Dictionary ##### `Clear()` - **Description**: Removes all elements from the dictionary. - **Method**: N/A (C# Method) #### Retrieving Values ##### `TryGetValue(Xbim.IO.Esent.XbimSurfaceStyle key, out Xbim.IO.Esent.XbimGeometryHandleCollection value)` - **Description**: Gets the value associated with the specified key. Returns true if the key is found, false otherwise. - **Method**: N/A (C# Method) #### Enumeration ##### `GetEnumerator()` - **Description**: Returns an enumerator that iterates through the dictionary. - **Method**: N/A (C# Method) ##### `System.Collections.Generic.IEnumerable>.GetEnumerator()` - **Description**: Returns an enumerator that iterates through the generic collection. - **Method**: N/A (C# Method) #### Serialization and Deserialization ##### `GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)` - **Description**: Populates a SerializationInfo with the data needed to serialize the dictionary. - **Method**: N/A (C# Method) ##### `OnDeserialization(System.Object sender)` - **Description**: Executes when deserialization is complete. - **Method**: N/A (C# Method) #### Copying Elements ##### `System.Collections.Generic.ICollection>.CopyTo(System.Collections.Generic.KeyValuePair[] array, System.Int32 arrayIndex)` - **Description**: Copies the elements of the dictionary to an array, starting at the specified array index. - **Method**: N/A (C# Method) ##### `System.Collections.ICollection.CopyTo(System.Array array, System.Int32 arrayIndex)` - **Description**: Copies the elements of the dictionary to an array, starting at the specified array index. - **Method**: N/A (C# Method) #### IDictionary Interface Implementation ##### `System.Collections.IDictionary.get_Item(System.Object key)` - **Description**: Gets or sets the value associated with the specified key. - **Method**: N/A (C# Method) ##### `System.Collections.IDictionary.set_Item(System.Object key, System.Object value)` - **Description**: Sets the value associated with the specified key. - **Method**: N/A (C# Method) ##### `System.Collections.IDictionary.Add(System.Object key, System.Object value)` - **Description**: Adds an element with the specified key and value. - **Method**: N/A (C# Method) ##### `System.Collections.IDictionary.Contains(System.Object key)` - **Description**: Determines whether the dictionary contains an element with the specified key. - **Method**: N/A (C# Method) ##### `System.Collections.IDictionary.GetEnumerator()` - **Description**: Returns an enumerator that iterates through the dictionary. - **Method**: N/A (C# Method) ##### `System.Collections.IDictionary.Remove(System.Object key)` - **Description**: Removes the element with the specified key. - **Method**: N/A (C# Method) #### Comparer Property ##### `Comparer` - **Description**: Gets an `IComparer` object that is used to order the keys in the dictionary. - **Method**: N/A (C# Property) ``` -------------------------------- ### Implement Explicit Interface Property CompressiveStrength Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.MaterialPropertyResource Implements the CompressiveStrength property from the IIfcMechanicalConcreteMaterialProperties interface. This property allows getting and setting the compressive strength of the material. ```csharp IfcPressureMeasure? IIfcMechanicalConcreteMaterialProperties.CompressiveStrength { get; set; } ``` -------------------------------- ### XbimSurfaceStyleMap Syntax (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.IO.Esent/Xbim.IO.Esent This C# code defines the syntax for the XbimSurfaceStyleMap class, indicating its inheritance from Dictionary and its implementation of various IDictionary and ICollection interfaces. This defines the structure and capabilities of the map. ```csharp public class XbimSurfaceStyleMap : Dictionary, IDictionary, ICollection>, IDictionary, ICollection, IReadOnlyDictionary, IReadOnlyCollection>, IEnumerable>, IEnumerable, ISerializable, IDeserializationCallback ``` -------------------------------- ### IIfcClassificationReference.Description Property (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.ExternalReferenceResource Implements the Description property from the IIfcClassificationReference interface. It allows getting and setting an IfcText value representing the description of the classification reference. ```csharp IfcText? IIfcClassificationReference.Description { get; set; } ``` -------------------------------- ### Get Object Types Defined By IIfcTypeObject Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.Kernel Retrieves a collection of IFC relationships that define the type of objects associated with this IFC type object. This property is read-only. ```csharp IEnumerable IIfcTypeObject.ObjectTypeOf { get; } ``` -------------------------------- ### IfcTypeObject.HasPropertySets Property - C# Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.Kernel Gets the collection of property set definitions associated with this IfcTypeObject. Property sets are used to group related properties for an object type. ```csharp [IndexedProperty] [EntityAttribute(6, EntityAttributeState.Optional, EntityAttributeType.Set, EntityAttributeType.Class, new int[]{1}, new int[]{-1}, 10)] public IOptionalItemSet HasPropertySets { get; } ``` -------------------------------- ### Explicit Interface Implementations Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.StructuralElementsDomain Details the explicit implementations of interfaces by the IfcBuildingElementPart class. ```APIDOC ## Explicit Interface Implementations for IfcBuildingElementPart ### IContainsEntityReferences.References #### Declaration ```csharp IEnumerable IContainsEntityReferences.References { get; } ``` #### Returns | Type | Description | |---------------------------|-------------| | System.Collections.Generic.IEnumerable | | ### IContainsIndexedReferences.IndexedReferences #### Declaration ```csharp IEnumerable IContainsIndexedReferences.IndexedReferences { get; } ``` #### Returns | Type | Description | |---------------------------|-------------| | System.Collections.Generic.IEnumerable | | ### IIfcBuildingElementPart.PredefinedType #### Declaration ```csharp [CrossSchemaAttribute(typeof(IIfcBuildingElementPart), 9)] IfcBuildingElementPartTypeEnum? IIfcBuildingElementPart.PredefinedType { get; set; } ``` #### Returns | Type | Description | |------------------------------------------|-------------| | System.Nullable | | ``` -------------------------------- ### PredefinedType Property in C# Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.SharedComponentElements This C# property, part of the IIfcDiscreteAccessoryType interface, allows getting and setting the predefined type of a discrete accessory. The type is represented by the IfcDiscreteAccessoryTypeEnum enumeration. ```csharp IfcDiscreteAccessoryTypeEnum IIfcDiscreteAccessoryType.PredefinedType { get; set; } ``` -------------------------------- ### IfcEdge Methods - C# Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.TopologyResource C# declarations for the Equals and Parse methods of the IfcEdge class. Equals is used for comparison, and Parse is an override for handling property value assignment during data parsing. ```csharp public bool Equals(IfcEdge other) ``` ```csharp public override void Parse(int propIndex, IPropertyValue value, int[] nestedIndex) ``` -------------------------------- ### IfcQuantityLength.LengthValue Declaration (C#) Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc4/Xbim.Ifc4.QuantityResource This C# code snippet shows the declaration of the LengthValue property for the IfcQuantityLength class. It indicates that LengthValue is of type IfcLengthMeasure and supports both getting and setting its value. ```csharp IfcLengthMeasure IIfcQuantityLength.LengthValue { get; set; } ``` -------------------------------- ### XbimInstanceHandleMap Properties Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/Xbim.Common Provides access to the 'from' and 'to' models associated with the XbimInstanceHandleMap. These properties allow retrieval of the source and target models used in the instance handle mapping. ```csharp public IModel FromModel { get; } ``` ```csharp public IModel ToModel { get; } ``` -------------------------------- ### IfcDraughtingCalloutElement Interface Documentation Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Ifc2x3/Xbim.Ifc2x3.PresentationDimensioningResource This section details the IfcDraughtingCalloutElement interface, its inherited members from IPersistEntity and IPersist, and its syntax. ```APIDOC ## Interface IfcDraughtingCalloutElement ### Description Represents a draughting callout element in the IFC schema, inheriting properties and methods from related interfaces. ### Namespace Xbim.Ifc2x3.PresentationDimensioningResource ### Assembly Xbim.Ifc2x3.dll ### Inherited Members #### From IPersistEntity - **EntityLabel** (int) - Gets or sets the entity label. - **Model** (IfcModel) - Gets the model this entity belongs to. - **Activated** (bool) - Gets or sets the activation status. - **ExpressType** (IfcExpressType) - Gets the express type of the entity. - **ModelOf** (IfcModel) - Gets the model containing this entity. #### From IPersist - **Parse(Int32, IPropertyValue, Int32[])** - Parses entity data. ### Syntax ```csharp public interface IfcDraughtingCalloutElement : IIfcDraughtingCalloutElement, IExpressSelectType, IPersistEntity, IPersist ``` ``` -------------------------------- ### StepFileHeader Properties Source: https://docs.xbim.net/XbimDocs/documentation/Xbim.Common/Xbim.Common.Step21 This C# code snippet outlines the properties of the StepFileHeader class. These properties provide access to various attributes of a STEP file header, such as the creating application, file description, file name, file schema, model view definition, name, schema version, timestamp, and Xbim schema version. ```csharp public string CreatingApplication { get; } ``` ```csharp public IStepFileDescription FileDescription { get; set; } ``` ```csharp public IStepFileName FileName { get; set; } ``` ```csharp public IStepFileSchema FileSchema { get; set; } ``` ```csharp public string ModelViewDefinition { get; } ``` ```csharp public string Name { get; } ``` ```csharp public string SchemaVersion { get; } ``` ```csharp public string TimeStamp { get; } ``` ```csharp public XbimSchemaVersion XbimSchemaVersion { get; } ```