Class TIfcPostalAddress

Description

Hierarchy

Methods

Properties

Unit

CastleIfc

Declaration

type TIfcPostalAddress = class(TIfcAddress)

Description

Address for delivery of paper based mail and other postal deliveries.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 3393).

Hierarchy

TObject
TPersistent
TComponent
TIfcPersistent
TIfcAddress
TIfcPostalAddress

Show Additional Members: Inherited Protected

Overview

Methods

Protected	`function WantsGlobalId: Boolean; virtual;`
Protected	`class function IfcClassName: String; virtual;`
Public	`constructor Create(AOwner: TComponent); override;`
Public	`destructor Destroy; override;`

Properties

Published	`property GlobalId: String read FGlobalId write FGlobalId;`
Published	`property Purpose: TIfcAddressTypeEnum read FPurpose write FPurpose;`
Published	`property Description: TIfcText read FDescription write FDescription;`
Published	`property UserDefinedPurpose: TIfcLabel read FUserDefinedPurpose write FUserDefinedPurpose;`
Published	`property OfPerson: TIfcPersonList read FOfPerson;`
Published	`property OfOrganization: TIfcOrganizationList read FOfOrganization;`
Published	`property InternalLocation: TIfcLabel read FInternalLocation write FInternalLocation;`
Published	`property AddressLines: TCastleStringList read FAddressLines;`
Published	`property PostalBox: TIfcLabel read FPostalBox write FPostalBox;`
Published	`property Town: TIfcLabel read FTown write FTown;`
Published	`property Region: TIfcLabel read FRegion write FRegion;`
Published	`property PostalCode: TIfcLabel read FPostalCode write FPostalCode;`
Published	`property Country: TIfcLabel read FCountry write FCountry;`

Description

Methods

Protected function WantsGlobalId: Boolean; virtual;

This item is declared in ancestor TIfcPersistent.

If True, instances of this class will have GlobalId auto-assigned at saving, and they will be saved as part of the "data" list in IFC JSON files.

Strictly following the spec, this should be only defined for TIfcRoot, because only IfcRoot has GlobalId. In reality, we need GlobalId at TIfcPersistent to load some files, and we sometimes need WantsGlobalId = True to save some files.

Source: scene/load/ifc/castleifc_ifc_types.inc (line 52).

Protected class function IfcClassName: String; virtual;

This item is declared in ancestor TIfcPersistent.

Name for the IFC standard, used in IFC files. By default, this is just ClassName with prefix 'T' removed.

Source: scene/load/ifc/castleifc_ifc_types.inc (line 56).

Public constructor Create(AOwner: TComponent); override;

This item has no description.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 3403).

Public destructor Destroy; override;

This item has no description.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 3404).

Properties

Published property GlobalId: String read FGlobalId write FGlobalId;

This item is declared in ancestor TIfcPersistent.

Globally unique identifier for the object instance.

Note: Not declared as TGUID, because TGUID cannot be published, but also we don't really need it: for our purposes, this identifier is just an arbitrary string.

Note: IFC 4.3 specification puts this only at IfcRoot, not at every IFC class. But testcase https://github.com/buildingsmart-community/Community-Sample-Test-Files/blob/main/IFC%204.0.2.1%20(IFC%204)/ISO%20Spec%20archive/wall-with-opening-and-window.json (from IFC 4.0) shows this can be present at any IFC class, in particular TIfcGeometricRepresentationContext.

In fact, TIfcGeometricRepresentationContext needs to have GlobalId to be successfully saved (avoid recursively trying to serialize it) in some cases. We indicate such classes with WantsGlobalId.

IFC JSON documentation says this, which seems to (unfortunately it is not unambiguous enough...) allow this at any IFC class: "Whereas the globalId attribute is only available to those elements that are descendent of the IfcRoot entity in the EXPRESS schema, we encourage a broader use of this globalId, to enable referencing between objects in a JSON file when useful.".

Source: scene/load/ifc/castleifc_ifc_types.inc (line 79).

Published property Purpose: TIfcAddressTypeEnum read FPurpose write FPurpose;

This item is declared in ancestor TIfcAddress.

Logical location of the address.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 1506).

Published property Description: TIfcText read FDescription write FDescription;

This item is declared in ancestor TIfcAddress.

The nature of the address.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 1509).

Published property UserDefinedPurpose: TIfcLabel read FUserDefinedPurpose write FUserDefinedPurpose;

This item is declared in ancestor TIfcAddress.

Yser specific purpose of the address beyond the enumeration values provided by Purpose.