IFCWebServer-API extensions

What are server extensions?

Server extensions are modules or classes methods written in Ruby language.

They can extend and customize the functionality of the Server and IFC classes.

Class methods can be used within server scripts or within any information report.

Example 1

As a first example, let us assume that you need to use the area value of windows and doors inside your queries/reports. According to the IFC specification the area is not saved inside the IFC files, but it can be calculated simply through the attributes "overallHeight" and "overallWidth", so we can write a simple extension methods "area" like this:



class IFCWINDOW 

def area

 @overallHeight.to_f*@overallWidth.to_f 

end 

end

class IFCDOOR 

def area 

  @overallHeight.to_f*@overallWidth.to_f 

end 

end

IFC

getObjectByLineID(id)

Return an IFC object by its STEP ID

IFC_CLASS_NAME.nonInverseAttributes

IFCObject.to_xml (obj)

Serialize any IFC object as XML

Example: "#61185".to_obj.to_xml -->>>

<IFCCOLUMN>
<line_id>61185</line_id>
<globalId>'0APvzagRfDa8S2CxmCLJFH'</globalId>
<ownerHistory>#13</ownerHistory>
<name>'St\S\|tze-001'</name>
<description>''</description>
<objectType>$</objectType>
<objectPlacement>#61239</objectPlacement>
<representation>#61228</representation>
<tag>$</tag>
</IFCCOLUMN>

IFCObject.to_csv(obj)

Serialize any IFC object as Comma-Separated Values (CSV)

IFCObject.to_html (obj)

Serialize any IFC object as row in HTML table

IFCObject.to_json(obj)

Serialize any IFC object as JSON obejct

IFC_CLASS_NAME.list(cols="")

Return a list of all IFC class instances, the parameter 'cols' can be used to define a set of custom data fields to be reported

IFCObject.as_link

Return HTML hyperlink to any IFC object instance

IFC_CLASS_NAME.where (cond,output)

Return a hash of user defined output applied on IFCCLASS object's instances which meet the 'cond' expression, 'all' or true can be used to retrieve all instances, 'cond' can be any valid Ruby expression applied on each object instance, the 'o' is used as place holder for object instances
IFCWINDOW.where("all","o.area > 2.00")

IfcAlignment2DHorizontalSegment

to_svg

polarToCartesian(centerX, centerY, radius, angleInDegrees)

IfcArbitraryClosedProfileDef

area

diameter

perimeter

to_svg

svg(scale=1,transformation="")
method:

xyz_array

xy_array

IfcArbitraryOpenProfileDef

perimeter

xyz_array

xy_array

to_svg

IfcArbitraryProfileDefWithVoids

area

xyz_array

IfcAsymmetricIShapeProfileDef

to_svg

svg(scale=1,transformation="")

IfcAxis2Placement2D

matrix

matrix2d

IfcAxis2Placement3D

x_axis

z_axis

xyz

matrix

matrix2d

IfcBoundingBox

to_dae(objectPlacement=nil,*args)

convert the geometry data of IfcBoundingBox object to COLLADA format

corner_xyz
method:

x_min

x_max

y_min

y_max

z_min

z_max

volume

return the volume of the BoundingBox object

center *

IfcBuilding

getBuildingAddress *
method:

getBuildingStoreys *
method:

getGrossFloorArea *
method:

getGetPropertySet *
method:

getContainedElements() *

IfcBuildingElement

hasCoverings *

IfcBuildingElementType_classes

attach_to_obj(obj)
method:

attach_to_obj(obj)

IfcCShapeProfileDef

IfcCartesianPoint

to_xml( o=self)
method:

to_xyz

xyz

min_max

return a list of Xmin,Xmax,Ymin,Ymax,Zmin,Zmax of all IfcCartesianPoint instances

IfcCartesianPointList

size

coordArray
method:

dim

IfcCircle

area

perimeter

positionXYZ
method:

xyz_array

to_svg

svg(scale=1,transformation="")

IfcCircleHollowProfileDef

area

perimeter

xyz_array *
method:

to_svg

svg(scale=1,transformation="")

IfcCircleProfileDef

area

perimeter

xyz_array

xy_array

to_svg

svg(scale=1,transformation="")

IfcClassification

classificationForObjects *
method:

hasReferences *
method:

contains *

IfcClassificationReference

attach_to_obj(obj)
method:

classificationRefForObjects *
method:

hasReferences *

IfcClosedShell

area

to_dae(placement=nil, *args)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(placement=nil)

IfcColourRgb

to_RGB

to_RGB_HEX
method:

to_html_div
method:

to_html_div_details

IfcColourRgbList

to_html_div

IfcComplexProperty

to_row

to_table

IfcCompositeCurve

xyz_array

IfcCompositeCurveSegment

xyz_array

usingCurves *

IfcCompositeProfileDef

IfcConnectedFaceSet

to_dae(objectPlacement=nil, *args)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(placement=nil)

IfcConstraint

hasExternalReferences *
method:

propertiesForConstraint *

IfcConversionBasedUnit

IfcDateTime

date_time

attach_to_obj(obj)

This method links the name of the material object to the associated objects through the relation IfcRelAssociatesMaterial as a new attribute .
The new attribute to be used in reports or filters called:

ext_material_name

IfcDerivedProfileDef

IfcDimensionalExponents

unitExponent

IfcDirection

get_normal

IfcDistributionFlowElement

hasControlElements *

IfcDoor

area

IfcDoorLiningProperties

property_details
method:

attach_to_obj(obj)

IfcDoorPanelProperties

property_details
method:

attach_to_obj(obj)

IfcDoorStyle

property_details

IfcDraughtingPreDefinedColour

to_html_div
method:

to_RGB

to_RGB_HEX

IfcEdge

length

to_dae

to_dae_geometry(mesh_id="")
method:

to_dae_node(ifclocalplacemenet=nil)
method:

to_xml( o=self)

IfcElement

get_inverse_attributes *
method:

fillsVoids1
method:

hasStructuralMember1 *
method:

connectedTo1

return information (class, globalId, name) about the elements which are connected to this element through IfcRelConnectsEelement relationship

Example: List all connected IfcBuildingElements in the IFC model: __4D_IFC2x4.ifc

hasCoverings1
method:

referencedInStructures1

List the spatial structure elements(site, building, buildingStorey, space) in which this IfcElement object is referenced (through IfcRelReferencedInSpatialStructure), but not primarily contained

hasPorts1 *
method:

hasOpenings1
method:

providesBoundaries1

return a table of spaces objects of space boundaries which are defined through IfcRelSpaceBoundary relation for this IfcElement instance

Example: List space boundaries of slabs and walls in the IFC model :AC10-Institute-Var-1.ifc

connectedFrom1

return information (class, globalId, name) about the elements which are connected with this element through IfcRelConnectsEelement relationship

containedInStructure1

return the parent object(container) of this element

TODO: hasProjections,isConnectionRealization

IfcElementQuantity

to_details(str="")
method:

property_names_values_hash
method:

property_details
method:

property_details_xml
method:

to_details_xml(str="")
method:

attach_to_obj(obj)
method:

names_values_hash(str="")

IfcEllipseProfileDef

area

perimeter

IfcExternalReference

externalReferenceForResources

IfcExternalSpatialElement

boundedBy

IfcExtrudedAreaSolid

area

perimeter

diameter

area_side

volume

height

to_dae(objectPlacement=nil,*args)
method:

xyz_min_max(location=[0,0,0])
method:

to_dae_geometry(mesh_id = "")
method:

to_dae_node(ifclocalplacement=nil)
method:

svg(scale=1,transformation="")
method:

to_svg

IfcFace

to_mesh

get_normal
method:

to_dae(objectPlacement=nil,*args)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(ifclocalplacemenet=nil)
method:

area

IfcFaceBound

get_normal
method:

to_mesh

to_dae(objectPlacement=nil,*args)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(localplacement=nil)
method:

area

IfcFaceOuterBound

to_dae(objectPlacement=nil)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(local=nil)
method:

to_mesh

area

IfcFacetedBrep

to_dae(objectPlacement=nil,*args)
method:

to_mesh

to_dae_geometry(mesh_id="")
method:

to_dae_node(local=nil)
method:

area

IfcFillAreaStyle

validate_rules
method:

fillStyles_colour

IfcGeometricCurveSet

to_dae(objectPlacement=nil,*args)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(local=nil)
method:

svg(scale=1,transformation="")

IfcGrid

IfcGridAxis

to_dae

svg(scale=1,transformation="")

IfcIShapeProfileDef

area

perimeter

xyz_array *
method:

xy_array *
method:

to_svg

svg(scale=1,transformation="")

IfcIndexedPolyCurve

find_circle_center(s, t, e)
method:

random_hex_color(obejct_type="")
method:

to_svg()

IfcLShapeProfileDef

IfcLibraryReference

IfcLine

xyz_array(value=1)
method:

xyz_min_max(value=1)

IfcLocalPlacement

location

IfcMappedItem

area

volume

area_side

height

to_dae(objectPlacement=nil)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(local=nil)
method:

check_transformation

IfcMaterial

attach_to_obj(obj)

ext_material_name

IfcMaterialLayerSet

materials_list
method:

materials_thickness_list
method:

materials_layers_html

This method shows the details of material layers (material name , layer thickness) in a table

IfcMaterialLayerSetUsage

attach_to_obj(obj)

This method links the names, count and total thickness of the material layers (IfcMaterialLayerSetUsage) which are associated to objects through the relation IfcRelAssociatesMaterial as a new attributes .
The new attributes to be used in reports or filters called:

ext_MaterialLayerSetUsage_material_name
ext_MaterialLayerSetUsage_layer_count
ext_MaterialLayerSetUsage_total_thickness
ext_MaterialLayerSetUsage_layerSetName
ext_MaterialLayerSetUsage_OffsetFromReferenceLine

IfcMaterialList

getMaterials
method:

attach_to_obj(obj)

This method links the names and count of the material objects which are associated to objects through the relation IfcRelAssociatesMaterial as a new attributes .
The new attributes to be used in reports or filters called:

ext_materiallist_name
ext_materiallist_count

IfcMeasureWithUnit

IfcMirroredProfileDef

IfcObject

isDefinedBy
method:

db_pset

return a table with all object properties saved in the BIM-DB

db_select_pset(propertyname, psetName= "")

return a table with one or more object proeprties saved in the BIM-DB. The user can add filter by PSetName

db_get_property(propertyname, psetName= "")

return the value of object property.

IfcObjectDefinition

hasAssignments
method:

isNestedBy #
method:

hasContext
method:

decomposes
method:

hasAssociations

IfcOpenShell

to_dae(objectPlacement=nil,*args)

convert the geometry data of this BoundingBox object to COLLADA format

IfcOpeningElement

area

IfcOwnerHistory

creationDate

IfcPhysicalQuantity

IfcPlanarExtent

IfcPolyLoop

get_normal_default
method:

get_normal
method:

to_xml(obj=self)
method:

to_svg

to_xy_xml

perimeter

to_mesh

to_dae(objectPlacement=nil)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(placement=nil)
method:

area

dx_dy_dz

xyz_min

xyz_max

is_circle?(precision=0.01)
method:

inXY?

IfcPolyline

to_a

xyz_array

xy_array

xy_min_max
method:

to_xml1(obj=self)
method:

to_xml(obj=self)
method:

to_svg(scale=1)
method:

svg(scale=1,transformation="")
method:

area

perimeter

contains_point?(point)
method:

outside_bounding_box?(point)
method:

to_dae(placement=nil, *args)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(placement=nil)
method:

add_point(id)
method:

self.new_from_points_array(xy_array=[])

IfcProduct

referencedBy
method:

area

to_dae(placement=nil,*args)
method:

volume

area_side

location

IfcProductDefinitionShape

to_dae(objectPlacement=nil,*args)
method:

to_dae_geometry(mesh_id="")
method:

to_dae_node(local=nil)
method:

volume

IfcProductRepresentation

to_dae(objectPlacement=nil,*args)

IfcProfileDef

hasExternalReference *
method:

hasProperties *

IfcProject

report

IfcPropertyBoundedValue

IfcPropertyDefinition

to_details(str="")
method:

to_details_xml(str="")
method:

property_names_values
method:

valid_name(obj=self)
method:

names_values(str="")
method:

names_values_hash(str="")

IfcPropertyEnumeratedValue

to_row

to_xml(obj)
method:

attach_to_obj(obj)

IfcPropertyEnumeration

IfcPropertySet

property_details
method:

properties

Return an alphabetic sorted array of property names defined inside the PropertySet object

hasProperty?(property)

Check if the PropertySet has a single Property with the name 'property', returns false or true

hasPropertyWithValue?(property,val)

Check if the PropertySet has a single Property with the name 'property' and the value 'value', returns false or true

property_value(name="")
method:

property_details_xml
method:

to_xml(obj=self)
method:

property_names_values
method:

property_names_values_hash
method:

attach_to_obj(obj)

IfcPropertySetTemplate

propertyTemplates_html
method:

propertyTemplates

IfcPropertySingleValue

to_row

valid_name(obj=self)
method:

valid_value(obj=self)
method:

to_xml(obj=self)
method:

to_xml_full(obj=self)
method:

#to_csv(obj=self)
method:

attach_to_obj(obj)

IfcPropertyTableValue

to_row *

IfcQuantityArea

to_row

to_xml(obj)
method:

attach_to_obj(obj)

IfcQuantityCount

to_row

to_xml(obj)
method:

attach_to_obj(obj)

IfcQuantityLength

to_row

to_xml(obj)
method:

attach_to_obj(obj)

IfcQuantityTime

to_row

to_xml(obj)
method:

attach_to_obj(obj)

IfcQuantityVolume

to_row

to_xml(obj)
method:

attach_to_obj(obj)

IfcQuantityWeight

to_row

to_xml(obj)
method:

attach_to_obj(obj)

IfcRectangleHollowProfileDef

#area *

perimeter

IfcRectangleProfileDef

area

xyz_array

perimeter

svg(scale=1,transformation="")

IfcRelAggregates

relatingobjectInfo
method:

relatedObjectsInfo

IfcRelAssigns

IfcRelAssignsTasks

saveTimeForTask

IfcRelAssociatesClassification

attach_to_obj

IfcRelAssociatesMaterial

attach_to_obj

This method will be called automatically if this extension is loaded (the class IfcRelAssociatesMaterial is selected and the caching is disabled)
It links the material properties with the associated objects as new attributes to be used in reports and quires as fellow:

IfcMaterial

ext_material_name

IfcMaterialList

ext_materiallist_name
ext_materiallist_count

IfcMaterialLayer
IfcMaterialLayerSet
IfcMaterialLayerSetUsage

ext_MaterialLayerSetUsage_material_name
ext_MaterialLayerSetUsage_layer_count
ext_MaterialLayerSetUsage_total_thickness
ext_MaterialLayerSetUsage_layerSetName
ext_MaterialLayerSetUsage_OffsetFromReferenceLine

qto

This method can be used to create a QuantityTakeOff report.

Beside selecting IfcRelAssociatesMaterial class we have to select the IfcRelDefinedByProperties,IfcRelDefinesByType classes as well.
The following attributes will be used for calculations:

Width
Height
Length
Perimeter
Volume,NetVolume, GrossVolume
Area, GrossArea ,GrossSideArea, NetSideArea, GrossFootprintArea,NetFootprintArea, NetWallArea, GrossWallArea

IfcRelConnectsPortToElement

count()

add(instance_id)
method:

count_by_class

IfcRelConnectsPorts

count()

add(instance_id)
method:

count_by_class

IfcRelContainedInSpatialStructure

attach_to_obj
method:

count()

add(instance_id)
method:

count_by_class

IfcRelDecomposes

attach_to_obj

IfcRelDefinesByProperties

to_xml(obj=self)
method:

cache *

attach

IfcRelDefinesByType

attach_to_obj

IfcRelFillsElement

count()

add(instance_id)
method:

count_by_class

IfcRelSequence

count()

add(instance_id)
method:

count_by_class

IfcRelVoidsElement

count()

add(instance_id)
method:

count_by_class

IfcRelationship

count()

add(instance_id)
method:

count_by_class

IfcRepresentation

ofProductRepresentation
method:

layerAssignments
method:

representationMap
method:

area

area_side

volume

height

to_svg

to_dae(objectPlacement=nil,*args)

IfcRepresentationItem

layerAssignment
method:

styledByItem *

IfcRepresentationMap

to_dae

to_dae_geometry(mesh_id=nil)
method:

to_dae_node(local=nil)

IfcResource

resourceOf *

IfcRoundedRectangleProfileDef

area

perimeter

IfcScheduleTimeControl

detail

IfcShapeRepresentation

preview

to_dae_geometry(mesh_id="")
method:

to_dae_node(local=nil)
method:

to_dae(objectPlacement=nil,*args)
method:

volume

IfcSimplePropertyTemplate

IfcSite

to_PSF21

IfcSlab

IfcSpace

getBoundedBy *
method:

getElementQuantities *
method:

getHeight *

IfcSpatialStructureElement

containsElements
method:

containsElements_count

IfcStyledItem

IfcSurfaceStyle

to_dae_material

IfcSurfaceStyleRendering

surfaceColour_html
method:

effect

material

IfcTShapeProfileDef

IfcTask

IfcTopologyRepresentation

to_dae(objectPlacement=nil,*args)
method:

to_dae_geometry(mesh_id="") *
method:

to_dae_node(ifclocalplacemenet=nil)

IfcTrapeziumProfileDef

IfcTrimmedCurve

xyz_array

IfcTypeProduct

attach_to_obj(obj)

This method links the "Type" properties with the associated objects(through IfcRelDefinesByType) as new attributes to be used in reports and quires as fellow:

IfcTypeProduct

ext_Type_Name
ext_Type_Description
ext_Type_ApplicableOccurrence
ext_Type_HasPropertySets
ext_Type_RepresentationMaps
ext_Type_Tag

ext_Type_ElementType

ext_Type_PredefinedType

ext_Type_OperationType
ext_Type_ConstructionType
ext_Type_ParameterTakesPrecedence
ext_Type_Sizeable

IfcUShapeProfileDef

IfcVertexPoint

to_dae

to_dae_geometry(mesh_id="")
method:

to_dae_node(ifclocalplacemenet=nil)

IfcWindow

area

IfcWindowLiningProperties

property_details

IfcWindowPanelProperties

property_details

IfcWindowStyle

property_details

IfcZShapeProfileDef

property_window_extension

format_property(obj,att)
method:

property_table(obj=self)

GitHub: https://github.com/ifcwebserver| Blog