Class IfcObject

Inheritance
System.Object
PersistEntity
IfcRoot
IfcObjectDefinition
IfcObject
IfcActor
IfcControl
IfcGroup
IfcProcess
IfcProduct
IfcResource
Implements
System.ComponentModel.INotifyPropertyChanged
System.IEquatable<IfcRoot>
System.IEquatable<IfcObjectDefinition>
System.IEquatable<IfcObject>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Xbim.Ifc4.Kernel
Assembly: Xbim.Ifc4.dll
Syntax
[ExpressType("IfcObject", 21)]
public abstract class IfcObject : IfcObjectDefinition, INotifyPropertyChanged, IEquatable<IfcRoot>, IEquatable<IfcObjectDefinition>, IIfcObject, IIfcObjectDefinition, IIfcRoot, IfcDefinitionSelect, IIfcDefinitionSelect, IExpressSelectType, IPersistEntity, IPersist, IEquatable<IfcObject>, IExpressValidatable

Properties

| Improve this Doc View Source

Declares

Declaration
[InverseProperty("RelatingObject")]
[EntityAttribute(-1, EntityAttributeState.Mandatory, EntityAttributeType.Set, EntityAttributeType.Class, new int[]{0}, new int[]{-1}, 14)]
public IEnumerable<IfcRelDefinesByObject> Declares { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IfcRelDefinesByObject>
| Improve this Doc View Source

ElementQuantities

Use this method to get all element quantities related to this object

Declaration
public IEnumerable<IIfcElementQuantity> ElementQuantities { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IIfcElementQuantity>

All related element quantities
| Improve this Doc View Source

IsDeclaredBy

Declaration
[InverseProperty("RelatedObjects")]
[EntityAttribute(-1, EntityAttributeState.Mandatory, EntityAttributeType.Set, EntityAttributeType.Class, new int[]{0}, new int[]{1}, 13)]
public IEnumerable<IfcRelDefinesByObject> IsDeclaredBy { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IfcRelDefinesByObject>
| Improve this Doc View Source

IsDefinedBy

Declaration
[InverseProperty("RelatedObjects")]
[EntityAttribute(-1, EntityAttributeState.Mandatory, EntityAttributeType.Set, EntityAttributeType.Class, new int[]{0}, new int[]{-1}, 16)]
public IEnumerable<IfcRelDefinesByProperties> IsDefinedBy { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IfcRelDefinesByProperties>
| Improve this Doc View Source

IsTypedBy

Declaration
[InverseProperty("RelatedObjects")]
[EntityAttribute(-1, EntityAttributeState.Mandatory, EntityAttributeType.Set, EntityAttributeType.Class, new int[]{0}, new int[]{1}, 15)]
public IEnumerable<IfcRelDefinesByType> IsTypedBy { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IfcRelDefinesByType>
| Improve this Doc View Source

ObjectType

Declaration
[EntityAttribute(5, EntityAttributeState.Optional, EntityAttributeType.None, EntityAttributeType.None, null, null, 12)]
public IfcLabel? ObjectType { get; set; }
Property Value
Type Description
System.Nullable<IfcLabel>
| Improve this Doc View Source

PhysicalSimpleQuantities

Use this to get all physical simple quantities (like length, area, volume, count, etc.)

Declaration
public IEnumerable<IIfcPhysicalSimpleQuantity> PhysicalSimpleQuantities { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IIfcPhysicalSimpleQuantity>

All physical simple quantities (like length, area, volume, count, etc.)
| Improve this Doc View Source

PropertySets

Declaration
public IEnumerable<IIfcPropertySet> PropertySets { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IIfcPropertySet>

Methods

| Improve this Doc View Source

AddDefiningType(IfcTypeObject)

Adds an element type to the object if it doesn't already have one, return the new or existing relationship that holds the type and this element. If there is a relationship for this type but this element is not related it adds it to the exosting relationship

Declaration
public IfcRelDefinesByType AddDefiningType(IfcTypeObject theType)
Parameters
Type Name Description
IfcTypeObject theType
Returns
Type Description
IfcRelDefinesByType
| Improve this Doc View Source

AddPropertySet(IfcPropertySet)

Adds an existing property set to the object, NB no check is done for duplicate psets

Declaration
public void AddPropertySet(IfcPropertySet pSet)
Parameters
Type Name Description
IfcPropertySet pSet
| Improve this Doc View Source

AddQuantity(String, IIfcPhysicalQuantity)

Adds a new IfcPhysicalQuantity to the IfcElementQuantity called propertySetName

Declaration
public IIfcElementQuantity AddQuantity(string propertySetName, IIfcPhysicalQuantity quantity)
Parameters
Type Name Description
System.String propertySetName

Name of the IfcElementQuantity property set
IIfcPhysicalQuantity quantity

quantity to be added
Returns
Type Description
IIfcElementQuantity
| Improve this Doc View Source

AddQuantity(String, IIfcPhysicalQuantity, String)

Adds a new IfcPhysicalQuantity to the IfcElementQuantity called propertySetName

Declaration
public IIfcElementQuantity AddQuantity(string propertySetName, IIfcPhysicalQuantity quantity, string methodOfMeasurement)
Parameters
Type Name Description
System.String propertySetName

Name of the IfcElementQuantity property set
IIfcPhysicalQuantity quantity

quantity to be added
System.String methodOfMeasurement

Sets the method of measurement, if not null overrides previous value
Returns
Type Description
IIfcElementQuantity
| Improve this Doc View Source

Equals(IfcObject)

Declaration
public bool Equals(IfcObject other)
Parameters
Type Name Description
IfcObject other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetElementPhysicalSimpleQuantity(String, String)

Returns simple physical quality of the element.

Declaration
public IIfcPhysicalSimpleQuantity GetElementPhysicalSimpleQuantity(string pSetName, string qualityName)
Parameters
Type Name Description
System.String pSetName
System.String qualityName
Returns
Type Description
IIfcPhysicalSimpleQuantity
| Improve this Doc View Source

GetElementQuantity(String, Boolean)

Declaration
public IIfcElementQuantity GetElementQuantity(string pSetName, bool caseSensitive = true)
Parameters
Type Name Description
System.String pSetName
System.Boolean caseSensitive
Returns
Type Description
IIfcElementQuantity
| Improve this Doc View Source

GetExternalElements(IModel)

Returns a list of all the elements that bound the external of the building

Declaration
public IEnumerable<IIfcElement> GetExternalElements(IModel model)
Parameters
Type Name Description
IModel model
Returns
Type Description
System.Collections.Generic.IEnumerable<IIfcElement>
| Improve this Doc View Source

GetPropertySet(String, Boolean)

Returns the propertyset of the specified name, null if it does not exist

Declaration
public IIfcPropertySet GetPropertySet(string pSetName, bool caseSensitive = true)
Parameters
Type Name Description
System.String pSetName
System.Boolean caseSensitive
Returns
Type Description
IIfcPropertySet
| Improve this Doc View Source

GetPropertySingleNominalValue(String, String)

If the property value exists, returns the Nominal Value of the contents

Declaration
public IIfcValue GetPropertySingleNominalValue(string pSetName, string propertyName)
Parameters
Type Name Description
System.String pSetName
System.String propertyName
Returns
Type Description
IIfcValue
| Improve this Doc View Source

GetPropertySingleValue(String, String)

Declaration
public IIfcPropertySingleValue GetPropertySingleValue(string pSetName, string propertyName)
Parameters
Type Name Description
System.String pSetName
System.String propertyName
Returns
Type Description
IIfcPropertySingleValue
| Improve this Doc View Source

GetPropertySingleValue<TValueType>(String, String)

Declaration
public TValueType GetPropertySingleValue<TValueType>(string pSetName, string propertyName)
    where TValueType : IIfcValue
Parameters
Type Name Description
System.String pSetName
System.String propertyName
Returns
Type Description
TValueType
Type Parameters
Name Description
TValueType
| Improve this Doc View Source

GetQuantity<TQType>(String)

Returns the first quantity that matches the quantity name

Declaration
public TQType GetQuantity<TQType>(string qName)
    where TQType : IIfcPhysicalQuantity
Parameters
Type Name Description
System.String qName
Returns
Type Description
TQType
Type Parameters
Name Description
TQType
| Improve this Doc View Source

GetQuantity<TQType>(String, String)

Returns the first quantity in the property set pSetName of name qName

Declaration
public TQType GetQuantity<TQType>(string pSetName, string qName)
    where TQType : IIfcPhysicalQuantity
Parameters
Type Name Description
System.String pSetName
System.String qName
Returns
Type Description
TQType
Type Parameters
Name Description
TQType
| Improve this Doc View Source

Parse(Int32, IPropertyValue, Int32[])

Declaration
public override void Parse(int propIndex, IPropertyValue value, int[] nestedIndex)
Parameters
Type Name Description
System.Int32 propIndex
IPropertyValue value
System.Int32[] nestedIndex
Overrides
| Improve this Doc View Source

RemoveElementPhysicalSimpleQuantity(String, String)

Declaration
public void RemoveElementPhysicalSimpleQuantity(string pSetName, string qualityName)
Parameters
Type Name Description
System.String pSetName
System.String qualityName
| Improve this Doc View Source

RemovePropertySingleValue(String, String)

Declaration
public void RemovePropertySingleValue(string pSetName, string propertyName)
Parameters
Type Name Description
System.String pSetName
System.String propertyName
| Improve this Doc View Source

SetElementPhysicalSimpleQuantity(String, String, Double, XbimQuantityTypeEnum, IIfcNamedUnit)

Declaration
public void SetElementPhysicalSimpleQuantity(string qSetName, string qualityName, double value, XbimQuantityTypeEnum quantityType, IIfcNamedUnit unit)
Parameters
Type Name Description
System.String qSetName
System.String qualityName
System.Double value
XbimQuantityTypeEnum quantityType
IIfcNamedUnit unit
| Improve this Doc View Source

SetPropertySingleValue(String, String, Type)

Creates property single value with specified type and default value of this type (0 for numeric types, empty string tor string types and false for bool types)

Declaration
public IIfcPropertySingleValue SetPropertySingleValue(string pSetName, string propertyName, Type type)
Parameters
Type Name Description
System.String pSetName

Property set name
System.String propertyName

Property name
System.Type type

Type of the property
Returns
Type Description
IIfcPropertySingleValue

Property single value with default value of the specified type
| Improve this Doc View Source

SetPropertySingleValue(String, String, IfcValue)

Declaration
public IIfcPropertySingleValue SetPropertySingleValue(string pSetName, string propertyName, IfcValue value)
Parameters
Type Name Description
System.String pSetName
System.String propertyName
IfcValue value
Returns
Type Description
IIfcPropertySingleValue
| Improve this Doc View Source

Validate()

Declaration
public virtual IEnumerable<ValidationResult> Validate()
Returns
Type Description
System.Collections.Generic.IEnumerable<ValidationResult>
| Improve this Doc View Source

ValidateClause(IfcObject.IfcObjectClause)

Tests the express where-clause specified in param 'clause'

Declaration
public bool ValidateClause(IfcObject.IfcObjectClause clause)
Parameters
Type Name Description
IfcObject.IfcObjectClause clause

The express clause to test
Returns
Type Description
System.Boolean

true if the clause is satisfied.

Explicit Interface Implementations

| Improve this Doc View Source

IIfcObject.Declares

Declaration
IEnumerable<IIfcRelDefinesByObject> IIfcObject.Declares { get; }
Returns
Type Description
System.Collections.Generic.IEnumerable<IIfcRelDefinesByObject>
| Improve this Doc View Source

IIfcObject.IsDeclaredBy

Declaration
IEnumerable<IIfcRelDefinesByObject> IIfcObject.IsDeclaredBy { get; }
Returns
Type Description
System.Collections.Generic.IEnumerable<IIfcRelDefinesByObject>
| Improve this Doc View Source

IIfcObject.IsDefinedBy

Declaration
IEnumerable<IIfcRelDefinesByProperties> IIfcObject.IsDefinedBy { get; }
Returns
Type Description
System.Collections.Generic.IEnumerable<IIfcRelDefinesByProperties>
| Improve this Doc View Source

IIfcObject.IsTypedBy

Declaration
IEnumerable<IIfcRelDefinesByType> IIfcObject.IsTypedBy { get; }
Returns
Type Description
System.Collections.Generic.IEnumerable<IIfcRelDefinesByType>
| Improve this Doc View Source

IIfcObject.ObjectType

Declaration
IfcLabel? IIfcObject.ObjectType { get; set; }
Returns
Type Description
System.Nullable<IfcLabel>

Implements

System.ComponentModel.INotifyPropertyChanged
System.IEquatable<T>
System.IEquatable<T>
System.IEquatable<T>