Profiles (Profiles) Schema
Alias: prf
Version: 1.0.2
EC Schema for Profiles
Profiles schema defines classes that represent two dimensional cross sections, used to define geometric shapes. Profiles may be used to extrude structural components like beams and columns.
Most often used Profiles are standard and defined by a specific Standards Organization. Standard Profiles are always shared. Standard profiles should only be deleted in case a mistake was made when creating standard Profile.
Standard Profiles
Most often used Profiles are standard and defined in a catalog. This is defined by a Profile and Code hierarchy representing four components:
StandardsOrganization
- Name of the standards organization that defines the Profile, e.g. "AISC"Manufacturer
- Name of the manufacturer for the Profile. This is usually a country code e.g. "US"Revision
- Name of the edition or version of the standards organization, e.g. "14"Name
- Name of the Profile (also called designation) e.g. "W16x40"
Applications will be able to use this information to query detailed properties and geometry of catalog (database) profile.
Applications that don't have access to catalogs will still be able to render the Profiles as they contain their own geometry constructed from available properties - this geometry may not match the detailed geometry from a catalog.
Structural Components Hierarchy
The following instance-diagram presents a simple example of the Structural Components Hierarchy explained next.
Profiles Definition Catalog
The top level Element to store Profiles definitions is defined as DefinitionContainer
. This Element is expected to be stored in DictionaryModel
. The Code value should be set to "prf:DomainDefinitions", scope is set to Repository
Model id, spec set to "bis:DefinitionContainer". The Container is expected to store "Standard Organizations" and "Structural Components Catalog" DefinitionContainers
which are defined in subsequent sections of this document.
Standard Organizations and Structural Components Catalog
Standard Organizations primary function is developing and maintaining manuals that specify technical standards for various structural components - Beam/Column Sections, Steel Decks, Joists, etc. Examples of standard organizations are - "AISC", "CEN", "VERCO". BIS repositories are not expected to contain Elements that represent Standard Organizations, only specific manuals are defined.
Standard Organizations Definition Container
The top level Element of StandardOrganization structure is defined as a single sub-modeled instance of DefinitionContainer
. This Element is expected to have a Code with value set to "Standard Organizations", scope set to Model
Model id, spec set to "bis:DefinitionContainer". "Standard Organizations" Element is expected to be stored in the "prf:DomainDefinitions" sub-model.
Classification Systems
"Standard Organizations" DefinitionContainer
is broken down to a model that stores Elements that represents manuals. Manuals are defined as ClassificationSystem
Elements where each Element represents only a single revision/edition of a catalog released, maintained by Standard Organization. Code
value of the Manual element is expected to be concatination of StandardOrganization name and the manual name itself, e.g. ClassificationSystem
that represents Standard Organization "CEN"'s "EU 19-53" Profile catalog edition would have a Code with value "CEN EU 19-53". CodeScope
is expected to be set to DictionaryModel
id, CodeSpec
to clsf:ClassificationSystem
.
Classification Table
The Manuals are expected to have child Elements (ClassificationTable
) that divide the manual into groups by use case. e.g. Same manual might define both Beam Profiles and Steel Decks. The CodeScope of each ClassificationTable
should be set to ParentElement
. CodeSpec to "bis:ClassificationTable". Code values depend on the ClassificationTable
's use case:
- Structural Profile Classifaction Table should have CodeValue set to "Structural Profiles"
- Steel Decks to "Structural Steel Decks"
- Joists to "Structural Joists"
Each ClassificationTable
is then broken down by a model that stores separate Classification
s that belong to that table.
Classifications
Classification
Elements define the actual entries of any Standard Catalog, e.g. AISC 7th Edition Structural Profile Catalog entires would be defined as separate Classification
containing all entries from that specific catalog edition.
Each Classification
CodeScope would be set to Model
, each CodeSpec to clsf:Classification
. The value would be set as Designation of that entry. (e.g. "W44X335"). Classification
Elements would not define any properties that are defined by the actual real world catalog entries. Instead, such properties would be defined by separate Elements that reference classification using ElementHasClassifications
relationship.
Structural Components Catalog Definition Container
The Structural Components Catalog Hierarchy defines actual structural components - Profiles, Steel Decks, Joists, etc. The top level Element of the hierarchy is a DefinitionContainer
that is stored in the "prf:DomainDefinitions" sub-model. The Code assigned to it consists of "Structural Components Catalog" value, Model
scope, "bis:DefinitionContainer" spec. This container is broken down into case specific DefinitionContainer
Elements - Profiles, Joists, Steel Decks, etc. Each container has a CodeScope set to "Structural Components Catalog" id, CodeSpec set to bis:DefinitionContainer
. CodeValue depends on the container's use case:
- "Structural Profiles" code is used for Profiles
- "Structural Steel Joists" for Joists
- "Structural Steel Decks" for Steel Decks
Each container is then broken down further. Where each sub-model contains the actual definitions of Structural Components - Profiles, SteelDecks, etc. These Elements are expected to refer to at least one Classification that the component fulfills. ElementHasClassifications
relationship is used to relate Component with its classification.
Table of contents
- Entity Classes
- ArbitraryCenterlineProfile
- ArbitraryCompositeProfile
- ArbitraryCompositeProfileComponentAspect
- ArbitraryShapeProfile
- AsymmetricIShapeProfile
- BentPlateProfile
- CShapeProfile
- CapsuleProfile
- CenterlineCShapeProfile
- CenterlineLShapeProfile
- CenterlineZShapeProfile
- CircleProfile
- CompositeProfile
- CorrugatedDeckProfile
- DeepDeckProfile
- DerivedProfile
- DoubleCShapeProfile
- DoubleLShapeProfile
- EllipseProfile
- HollowCircleProfile
- HollowRectangleProfile
- IShapeProfile
- LShapeProfile
- Manufacturer
- ParametricDeckProfile
- ParametricProfile
- Profile
- RectangleProfile
- RegularPolygonProfile
- Revision
- RoundedRectangleProfile
- SchifflerizedLShapeProfile
- SineWaveDeckProfile
- SinglePerimeterProfile
- StandardDeckProfile
- StandardsOrganization
- TShapeProfile
- TTShapeProfile
- TrapezoidProfile
- ZShapeProfile
- Mixins
- Struct Classes
- Relationship Classes
- Enumerations
- Property Categories
Entity Classes
ArbitraryCenterlineProfile (Arbitrary Centerline Profile) Sealed EntityClass
Profile whose geometry is defined by user provided centerline and thickness that is uniformly applied to that centerline.
Base Class: Profiles:ArbitraryShapeProfile
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
ArcAngle | Minimum angle for creating an arc. If angle is greater than ArcAngle then arc will be created, otherwise ChamferAngle will be used. | double | |
ChamferAngle | Angle for constructing arcs from tangent lines. If angle is greater than ChamferAngle then curve will be constructed using multiple tangent lines, otherwise lines will be extended until they meet. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Centerline | Non self intersecting centerline defining the geometry of the Profile. | Bentley.Geometry.Common.IGeometry | |
WallThickness | Constant thickness that is applied evenly along the Centerline. | double |
ArbitraryCompositeProfile (Arbitrary Composite Profile) Sealed EntityClass
A Profile comprised of multiple SinglePerimeterProfiles.
Base Class: Profiles:CompositeProfile
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
Instantiable CompositeProfile that is used to define an arbitrary Profile with multiple areas.
This Profile is constructed by inserting ArbitraryCompositeProfileAspects that reference and transform SinglePerimeterProfiles. ArbitraryCompositeProfile can reference the same SinglePerimeterProfile multiple times, but apply different transformations.
Examples:
- An ArbitraryCompositeProfile that is made up of 2 Profiles:
- IShapeProfile - referenced once with no transformation.
- RectangleProfile - referenced twice with different
Offset
.
ArbitraryCompositeProfileComponentAspect (Arbitrary Composite Profile Component) Sealed EntityClass
Aspect used by ArbitraryCompositeProfile to reference SinglePerimeterProfile and store geometry transformations for it.
Base Class: BisCore:ElementMultiAspect
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Profile | Single Profile referenced by ArbitraryCompositeProfile. | navigation | |
Offset | 2D vector specifying how the profiles geometry will be offset from it's original coordinates. | point2d | |
Rotation | Angle by which the profiles geometry will be rotated. | double | |
MirrorAboutYAxis | Flag indicating whether the profiles geometry should be mirrored around the Y axis. | boolean | |
MemberPriority | Index used to strictly order components. This property is a duplicate from bis:ElementGroupsMembers. | int |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Element | The bis:Element that owns this bis:ElementMultiAspect. | navigation |
ArbitraryShapeProfile (Arbitrary Shape Profile) EntityClass
Custom, user defined Profile that can have any shape.
Base Class: Profiles:SinglePerimeterProfile
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
A SinglePerimeterProfile whose geometry is defined by an arbitrary single perimeter. Geometry of ArbitraryShapeProfile can have voids i.e. it can be formed using a ParityRegion (see example of a Profile with a void).
Constraints:
Shape
(instance of CurveCollection or CurvePrimitive- must be closed
- must be of a single perimeter
- must not self intersect
- must be planar and lie on the XY plane
Examples:
ArbitraryShapeProfile whose
Shape
is a closed LineString.ArbitraryShapeProfile whose
Shape
is a ParityRegion of a rectangle (LineString) and theShape
of an IShapeProfile.
AsymmetricIShapeProfile Sealed EntityClass
An asymmetric (about x-axis) I shaped Profile similar to rolled steel I-shapes.
Base Class: Profiles:ParametricProfile
Derivative properties:
WebEdgeLength
=Depth
-TopFlangeThickness
-BottomFlangeThickness
TopFlangeInnerEdgeLength
= (TopFlangeWidth
-WebThickness
) / 2BottomFlangeInnerEdgeLength
= (BottomFlangeWidth
-WebThickness
) / 2TopFlangeSlopeHeight
=TopFlangeInnerEdgeLength
* Tan(TopFlangeSlope
)BottomFlangeSlopeHeight
=BottomFlangeInnerEdgeLength
* Tan(BottomFlangeSlope
)
Constraints:
TopFlangeWidth
must be greater than zeroBottomFlangeWidth
must be greater than zeroDepth
must be greater than zeroTopFlangeThickness
- must be greater than zero
TopFlangeThickness
plusBottomFlangeThickness
must be less thanDepth
BottomFlangeThickness
- must be greater than zero
TopFlangeThickness
plusBottomFlangeThickness
must be less thanDepth
WebThickness
- must be greater than zero
- must be less than
TopFlangeWidth
- must be less than
BottomFlangeWidth
TopFlangeFilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
WebEdgeLength
minusTopFlangeSlopeHeight
- must be less or equal to half
TopFlangeInnerEdgeLength
TopFlangeEdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to
TopFlangeThickness
- must be less or equal to half
TopFlangeInnerEdgeLength
TopFlangeSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
TopFlangeSlopeHeight
must be less or equal to halfWebEdgeLength
BottomFlangeFilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
WebEdgeLength
minusBottomFlangeSlopeHeight
- must be less or equal to half
BottomFlangeInnerEdgeLength
BottomFlangeEdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to
BottomFlangeThickness
- must be less or equal to half
BottomFlangeInnerEdgeLength
BottomFlangeSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
BottomFlangeSlopeHeight
must be less or equal to halfWebEdgeLength
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
TopFlangeWidth | Extent of the top flange, defined parallel to the x axis of the position coordinate system. | double | |
BottomFlangeWidth | Extent of the bottom flange, defined parallel to the x axis of the position coordinate system. | double | |
Depth | Extent of the depth (web length), defined parallel to the y axis of the position coordinate system. | double | |
TopFlangeThickness | Flange thickness of the top flange. | double | |
BottomFlangeThickness | Flange thickness of the bottom flange. | double | |
WebThickness | Web thickness of the I-shape. The web is centred on the x-axis and the y-axis of the position coordinate system. | double | |
TopFlangeFilletRadius | The fillet radius between the web and the top flange. 0 if sharp-edged, default 0 if not specified. | double | |
TopFlangeEdgeRadius | Radius of the lower edges of the top flange. 0 if sharp-edged, default 0 if not specified. | double | |
TopFlangeSlope | Slope of the lower faces of the top flange. Non-zero in case of of tapered top flange, 0 in case of parallel top flange, default 0 if not specified. | double | |
BottomFlangeFilletRadius | The fillet radius between the web and the bottom flange. 0 if sharp-edged, default 0 if not specified. | double | |
BottomFlangeEdgeRadius | Radius of the upper edges of the bottom flange. 0 if sharp-edged, default 0 if not specified. | double | |
BottomFlangeSlope | Slope of the upper faces of the bottom flange. Non-zero in case of of tapered bottom flange, 0 in case of parallel bottom flange, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
BentPlateProfile (Bent Plate Profile) Sealed EntityClass
Profile of a plate that has been bent at a given point with a given angle.
Base Class: Profiles:ParametricProfile
Derivative properties:
MaximumWallThickness
= Min(Width
-BendOffset
,BendOffset
) * Tan(BendAngle
/ 2) * 2
Constraints:
Width
must be greater than zeroWallThickness
- must be greater than zero
- must be less than
MaximumWallThickness
BendAngle
- must be greater than zero
- must be less than one hundred eighty degrees
BendOffset
- must be greater than zero
- must be less than
Width
FilletRadius
- must be greater than zero
- must be less or equal to half
MaximumWallThickness
minus halfWallThickness
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Width | Extent of the plate length, defined parallel to the x axis of the position coordinate system. | double | |
BendAngle | Inner angle of the bend point. Value is valid in range (0..180) degrees. Values near 180 degrees meaning an almost unbent plate and values near 0 are almost fully bent in half plate. | double | |
BendOffset | Offset from the left edge of the plate defining at what point the plate is bent. | double | |
FilletRadius | Inner fillet radius of the bend point. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Centerline | Non self intersecting centerline defining the geometry of the Profile. | Bentley.Geometry.Common.IGeometry | |
WallThickness | Constant thickness that is applied evenly along the Centerline. | double |
CShapeProfile (C-Shape Profile) Sealed EntityClass
A C shaped Profile similar to rolled steel C-shapes.
Base Class: Profiles:ParametricProfile
Derivative properties:
FlangeInnerEdgeLength
=FlangeWidth
-WebThickness
FlangeSlopeHeight
=FlangeInnerEdgeLength
* Tan(FlangeSlope
)WebInnerEdgeLength
=Depth
-FlangeThickness
* 2
Constraints:
FlangeWidth
must be greater than zeroDepth
must be greater than zeroFlangeThickness
:- must be greater than zero
- must be less than half
Depth
WebThickness
:- must be greater than zero
- must be less than
FlangeWidth
FilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half of
FlangeInnerEdgeLength
- must be less or equal to half of
WebInnerEdgeLength
minusFlangeSlopeHeight
FlangeEdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to half of
FlangeInnerEdgeLength
- must be less or equal to
FlangeThickness
FlangeSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
FlangeSlopeHeight
must be less or equal to half ofWebInnerEdgeLength
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
FlangeWidth | Extent of the flange, defined parallel to the x axis of the position coordinate system. | double | |
Depth | Extent of the web, defined parallel to the y axis of the position coordinate system. | double | |
FlangeThickness | Constant wall thickness of flanges. | double | |
WebThickness | Constant wall thickness of the web. | double | |
FilletRadius | The fillet radius between the web and the flange. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeEdgeRadius | Radius of the lower edges of the top flange and the upper edges of the bottom flange. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeSlope | Slope of the lower face of the top flange and of the upper face of the bottom flange. Non-zero in case of tapered flanges, 0 in case of parallel flanges, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
CapsuleProfile (Capsule Profile) Sealed EntityClass
Capsule shape Profile - cylinder with hemispherical ends. Also referred as stadium shape.
Base Class: Profiles:ParametricProfile
Constraints:
Width
must be greater than zeroDepth
must be greater than zero
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Width | Extent of the capsule in the direction of the x-axis. | double | |
Depth | Extent of the capsule in the direction of the y-axis. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
CenterlineCShapeProfile (Centerline C-Shape Profile) Sealed EntityClass
A C shaped Profile with rounded corners, similar to cold-formed steel C-shapes.
Base Class: Profiles:ParametricProfile
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
FlangeWidth | Extent of the flange, defined parallel to the x axis of the position coordinate system. | double | |
Depth | Extent of the web, defined parallel to the y axis of the position coordinate system. | double | |
FilletRadius | Inner fillet radius. | double | |
Girth | Length of lips. 0 if profile doesn't have lips, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Centerline | Non self intersecting centerline defining the geometry of the Profile. | Bentley.Geometry.Common.IGeometry | |
WallThickness | Constant thickness that is applied evenly along the Centerline. | double |
CenterlineLShapeProfile (Centerline L-Shape Profile) Sealed EntityClass
An L-shaped Profile with rounded corners, similar to cold-formed steel L-shapes.
Base Class: Profiles:ParametricProfile
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Width | Horizontal leg length, defined parallel to the x axis of the position coordinate system. | double | |
Depth | Vertical leg length, defined parallel to the y axis of the position coordinate system. | double | |
FilletRadius | Inner fillet radius. | double | |
Girth | Length of lips. 0 if profile doesn't have lips, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Centerline | Non self intersecting centerline defining the geometry of the Profile. | Bentley.Geometry.Common.IGeometry | |
WallThickness | Constant thickness that is applied evenly along the Centerline. | double |
CenterlineZShapeProfile (Centerline Z-Shape Profile) Sealed EntityClass
A Z-shaped Profile with rounded corners, similar to cold-formed steel Z-shapes
Base Class: Profiles:ParametricProfile
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
FlangeWidth | Extent of single flange, defined parallel to the x axis of the position coordinate system. | double | |
Depth | Extent of the depth (web length), defined parallel to the y axis of the position coordinate system. | double | |
FilletRadius | Inner fillet radius. | double | |
Girth | Length of lips. 0 if profile doesn't have lips, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Centerline | Non self intersecting centerline defining the geometry of the Profile. | Bentley.Geometry.Common.IGeometry | |
WallThickness | Constant thickness that is applied evenly along the Centerline. | double |
CircleProfile (Circle Profile) Sealed EntityClass
Solid circle shape Profile.
Base Class: Profiles:ParametricProfile
Constraints:
Radius
must be greater tan zero
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Radius | The radius of the circle. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
CompositeProfile (Composite Profile) Abstract EntityClass
A Profile comprised of multiple SinglePerimeterProfiles.
Base Class: Profiles:Profile
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
Abstract Profile class that is comprised of multiple SinglePerimeterProfiles. See ArbitraryCompositeProfile, DoubleLShapeProfile and DoubleCShapeProfile for instantiable composite Profiles.
CorrugatedDeckProfile (Corrugated Deck Profile) Sealed EntityClass
Corrugated Deck Profile.
Base Class: Profiles:ParametricDeckProfile
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Depth | Depth. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Thickness | Profile Thickness. | double | |
CelluralPlateThickness | Additional plate under the rest of the profile (optional). | double |
DeepDeckProfile (Deep Deck Profile) Sealed EntityClass
Deep Deck Profile.
Base Class: Profiles:ParametricDeckProfile
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Depth | Depth. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Thickness | Profile Thickness. | double | |
CelluralPlateThickness | Additional plate under the rest of the profile (optional). | double |
DerivedProfile (Derived Profile) Sealed EntityClass
This class represents a SinglePerimeterProfile that has been converted into a different shape via a matrix transform. Usage outside of IFC compatibility is not recommended
Base Class: Profiles:SinglePerimeterProfile
SinglePerimeterProfile that is based on another SinglePerimeterProfile with applied standard transformations (scale, rotation, translation, mirror). This Profile is defined for compatibility reasons with IFC and its usage is not recommended.
Note that deletion of the referenced SinglePerimeterProfile is prohibited if there are DerivedProfiles that reference it.
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Offset | 2D vector specifying how the profiles geometry will be offset from it's original coordinates. | point2d | |
Scale | A non-uniform scale factor. | point2d | |
Rotation | Angle by which the profiles geometry will be rotated. | double | |
MirrorAboutYAxis | Flag indicating whether the profiles geometry should be mirrored around the Y axis. | boolean |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
DoubleCShapeProfile (Double C-Shape Profile) Sealed EntityClass
A CompositeProfile comprised of back-to-back Cs.
Base Class: Profiles:CompositeProfile
Instantiable CompositeProfile that models a Double C shape profile where the single CShapeProfiles are placed back to back with specified gap between them. This Profile references and requires a CShapeProfile to exist in the BIS repository.
Note that deletion of the referenced CShapeProfile is prohibited if there are DoubleCShapeProfiles that reference it.
Constraints:
Spacing
must be equal or greater than zero
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Spacing | Distance separating the individual back to back CShapeProfiles. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
DoubleLShapeProfile (Double L-Shape Profile) Sealed EntityClass
A CompositeProfile comprised of back-to-back Ls with the horizontal legs at the top of the Profile.
Base Class: Profiles:CompositeProfile
Instantiable CompositeProfile that models a Double L shape profile where the single LShapeProfiles are placed back to back with specified gap between them. This Profile references and requires a LShapeProfile to exist in the BIS repository.
Note that deletion of the referenced LShapeProfile is prohibited if there are DoubleLShapeProfiles that reference it.
Constraints:
Spacing
must be equal or greater than zero
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Spacing | Distance separating the individual back to back LShapeProfiles. | double | |
Type | Enumeration defining which legs are to be placed back to back. | DoubleLShapeProfileType |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
EllipseProfile (Ellipse Profile) Sealed EntityClass
Solid ellipse shape Profile.
Base Class: Profiles:ParametricProfile
Constraints:
XRadius
must be greater tan zeroYRadius
must be greater tan zero
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
XRadius | The first radius of the ellipse. It is measured along the direction of x axis of the position coordinate system. | double | |
YRadius | The second radius of the ellipse. It is measured along the direction of y axis of the position coordinate system. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
HollowCircleProfile (Hollow Circle Profile) Sealed EntityClass
Hollow circle shape Profile.
Base Class: Profiles:ParametricProfile
Constraints:
Radius
must be greater than zeroWallThickness
- must be greater than zero
- must be less than
Radius
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Radius | The radius of the circle. | double | |
WallThickness | Constant thickness of profile walls. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
HollowRectangleProfile (Hollow Rectangle Profile) Sealed EntityClass
Hollow rectangle shape Profile.
Base Class: Profiles:ParametricProfile
Constraints:
Width
must be greater than zeroDepth
must be greater than zeroWallThickness
- must be greater than zero
- must be less than half
Width
- must be less than half
Depth
InnerFilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
Width
minusWallThickness
- must be less or equal to half
Depth
minusWallThickness
OuterFilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
Width
- must be less or equal to half
Depth
- must be greater than
InnerFilletRadius
plusWallThickness
multiplied by2 * Sqrt(2)
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Width | Extent of the rectangle in the direction of the x-axis. | double | |
Depth | Extent of the rectangle in the direction of the y-axis. | double | |
WallThickness | Constant thickness of profile walls. | double | |
InnerFilletRadius | Radius of the circular arcs, by which all four corners of the inner contour of rectangle are equally rounded. Default 0 (= no rounding arcs) if not specified. | double | |
OuterFilletRadius | Radius of the circular arcs, by which all four corners of the outer contour of rectangle are equally rounded. Default 0 (= no rounding arcs) if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Centerline | Non self intersecting centerline defining the geometry of the Profile. | Bentley.Geometry.Common.IGeometry |
IShapeProfile (I-Shape Profile) Sealed EntityClass
An I shaped Profile similar to rolled steel I-shapes.
Base Class: Profiles:ParametricProfile
Derivative properties:
FlangeInnerEdgeLength
= (FlangeWidth
-WebThickness
) / 2FlangeSlopeHeight
=FlangeInnerEdgeLength
* Tan(FlangeSlope
)WebEdgeLength
=Depth
-FlangeThickness
* 2
Constraints:
FlangeWidth
must be greater than zeroDepth
must be greater than zeroFlangeThickness
:- must be greater than zero
- must be less than half
Depth
WebThickness
:- must be greater than zero
- must be less than
FlangeWidth
FilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
FlangeInnerEdgeLength
- must be less or equal to half
WebEdgeLength
minusFlangeSlopeHeight
FlangeEdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
FlangeInnerEdgeLength
- must be less or equal
FlangeSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
FlangeSlopeHeight
must be less or equal to halfWebEdgeLength
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
FlangeWidth | Extent of the width (flange length), defined parallel to the x axis of the position coordinate system. | double | |
Depth | Extent of the depth (web length), defined parallel to the y axis of the position coordinate system. | double | |
FlangeThickness | Flange thickness of the I-shape. Both, the upper and the lower flanges have the same thickness and they are centred on the y-axis of the position coordinate system. | double | |
WebThickness | Web thickness of the I-shape. The web is centred on the x-axis and the y-axis of the position coordinate system. | double | |
FilletRadius | The fillet radius between the web and the flange. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeEdgeRadius | Radius of the lower edges of the top flange and the upper edges of the bottom flange. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeSlope | Slope of the lower faces of the top flange and of the upper faces of the bottom flange. Non-zero in case of tapered flanges, 0 in case of parallel flanges, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
LShapeProfile (L-Shape Profile) Sealed EntityClass
An L-shaped Profile (also referred as Angle) similar to rolled steel L-shapes.
Base Class: Profiles:ParametricProfile
Derivative properties:
HorizontalLegInnerEdgeLength
=Width
-Thickness
HorizontalLegSlopeHeight
=HorizontalLegInnerEdgeLength
* Tan(LegSlope
)VerticalLegInnerEdgeLength
=Depth
-Thickness
VerticalLegSlopeHeight
=VerticalLegInnerEdgeLength
* Tan(LegSlope
)
Constraints:
Width
must be greater than zeroDepth
must be greater than zeroThickness
- must be greater than zero
- must be less than
Depth
- must be less than
Width
FilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
HorizontalLegInnerEdgeLength
minusVerticalLegSlopeHeight
- must be less or equal to half
VerticalLegInnerEdgeLength
minusHorizontalLegSlopeHeight
EdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to
Thickness
- must be less or equal to half
HorizontalLegInnerEdgeLength
minusVerticalLegSlopeHeight
- must be less or equal to half
VerticalLegInnerEdgeLength
minusHorizontalLegSlopeHeight
LegSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
HorizontalLegSlopeHeight
must be less or equal to halfVerticalLegInnerEdgeLength
VerticalLegSlopeHeight
must be less or equal to halfHorizontalLegInnerEdgeLength
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Width | Horizontal leg length, defined parallel to the x axis of the position coordinate system. | double | |
Depth | Vertical leg length, defined parallel to the y axis of the position coordinate system. | double | |
Thickness | Constant wall thickness of profile. | double | |
FilletRadius | Fillet radius between legs. 0 if sharp-edged, default 0 if not specified. | double | |
EdgeRadius | Radius of flange edges. 0 if sharp-edged, default 0 if not specified. | double | |
LegSlope | Slope of the inner faces of the legs. Non-zero in case of tapered legs, 0 in case of perpendicular legs, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
Manufacturer (Manufacturer) Sealed EntityClass
Produces structural members defined by Standard Profiles.
Base Class: BisCore:DefinitionContainer
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean |
Produces structural members defined by a standard [Profile]. Manufacturer is always stored in a model that models standards organization whichs' rules are used to define profiles. Manufacturer is always sub-modeled and it's model contains revisions for profiles.
ParametricDeckProfile (Parametric Deck Profile) Abstract EntityClass
An open Profile of constant thickness
Base Class: Profiles:ParametricProfile
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Thickness | Profile Thickness. | double | |
CelluralPlateThickness | Additional plate under the rest of the profile (optional). | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
ParametricProfile (Parametric Profile) Abstract EntityClass
A SinglePerimeterProfile that is guaranteed to have the center of the bounding box at (0, 0).
Base Class: Profiles:SinglePerimeterProfile
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
Profile whose geometry is defined by a set of properties such as Width
, Depth
, Thickness
etc.
In addition, such Profiles have a bounding box which is centered at the center of the coordinate system i.e. (x: 0, y: 0).
Profile Abstract EntityClass
A resource defining one or more 2D areas that may have voids.
Base Class: BisCore:DefinitionElement
Base class of all profile definitions. Profile may be a SinglePerimeterProfile or CompositeProfile.
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean |
RectangleProfile (Rectangle Profile) Sealed EntityClass
Solid rectangle shape Profile.
Base Class: Profiles:ParametricProfile
Constraints:
Width
must be greater than zeroDepth
must be greater than zero
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Width | Extent of the rectangle in the direction of the x-axis. | double | |
Depth | Extent of the rectangle in the direction of the y-axis. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
RegularPolygonProfile (Regular Polygon Profile) Sealed EntityClass
Polygon shape Profile, where all angles and sides of the polygon are equal.
Base Class: Profiles:ParametricProfile
Constraints:
SideCount
must be greater or equal to3
and less or equal to32
SideLength
must be greater than zero
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
SideCount | Count of sides (edges) the polygon is made of. Value cannot be less than 3 or greater than 32. | int | |
SideLength | Constant length of each polygon side (edge). | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
Revision (Revision) Sealed EntityClass
Revision for a set of Profiles produced by a specific Manufacturer.
Base Class: BisCore:DefinitionContainer
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean |
Stores standard profiles that are used to produce structural members by some specific manufacturer.
RoundedRectangleProfile (Rounded Rectangle Profile) Sealed EntityClass
Solid rectangle shape Profile with rounded corners.
Base Class: Profiles:ParametricProfile
Constraints:
Width
must be greater than zeroDepth
must be greater than zeroRoundingRadius
- must be greater than zero
- must be less than half
Width
- must be less than half
Depth
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Width | Extent of the rectangle in the direction of the x-axis. | double | |
Depth | Extent of the rectangle in the direction of the y-axis. | double | |
RoundingRadius | Radius of the circular arcs by which all four corners of the rectangle are equally rounded. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
SchifflerizedLShapeProfile (Schifflerized L-Shape Profile) Sealed EntityClass
An L-shaped Profile (also referred as Angle) with legs bent at 15 degree angle, making the angle between the legs equal to 60 degrees.
Base Class: Profiles:ParametricProfile
Constraints:
LegLength
must be greater than zeroThickness
- must be greater than zero
- must be less than
LegLength
divided by square root of three
LegBendOffset
(if set):- must be greater or equal to
Thickness
- must be less than
LegLength
minusThickness
- must be greater or equal to
FilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to
LegBendOffset
minusThickness
EdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to
Thickness
- must be less or equal to
LegLength
minusLegBendOffset
minusThickness
multiplied by the tangent of fifteen degrees
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
LegLength | Leg length. Both vertical and horizontal legs are defined with equal length. | double | |
Thickness | Constant wall thickness of profile. | double | |
LegBendOffset | Offset defining where legs are bent. Offset is measured from start of the angle (leg joint) to the outer bending point of the leg. LegBendOffset default value is equal to Thickness plus required offset from the leg joint. | double | |
FilletRadius | Fillet radius between legs. 0 if sharp-edged, default 0 if not specified. | double | |
EdgeRadius | Radius of flange edges. 0 if sharp-edged, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
SineWaveDeckProfile (Sine Wave Deck Profile) Sealed EntityClass
Sine Wave Deck Profile.
Base Class: Profiles:ParametricDeckProfile
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Depth | Depth. | double | |
WaveLength | Wave Length. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Thickness | Profile Thickness. | double | |
CelluralPlateThickness | Additional plate under the rest of the profile (optional). | double |
SinglePerimeterProfile (Single Perimeter Profile) Abstract EntityClass
A Profile with a single outer perimeter.
Base Class: Profiles:Profile
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
This profile subclass is used to denote a Profile that is composed out of a single perimeter (area). SinglePerimeterProfiles can be referenced by CompositeProfile to form a Profile with multiple disjoint areas.
StandardDeckProfile (Standard Deck Profile) Sealed EntityClass
Standard Deck Shape Profile.
Base Class: Profiles:ParametricDeckProfile
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
Depth | Depth. | double | |
TopFlatWidth | Width of top flat. | double | |
BottomRibWidth | Width of bottom rib. | double | |
CoverageWidth | Distance between top flat and bottom width. | double | |
DiagonalWidth | Horizontal width of (a single) web diagonal. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array | |
Thickness | Profile Thickness. | double | |
CelluralPlateThickness | Additional plate under the rest of the profile (optional). | double |
StandardsOrganization (Standards Organization) Sealed EntityClass
Defines rules for Standard Profiles.
Base Class: BisCore:DefinitionContainer
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean |
Defines standard Profiles. This should always be sub-modeled by a model which stores all manufacturers that produce the actual structural members defined by profile rules of standard organization.
TShapeProfile (T-Shape Profile) Sealed EntityClass
A T-shaped Profile similar to rolled steel T-shapes.
Base Class: Profiles:ParametricProfile
Derivative properties:
FlangeInnerEdgeLength
= (FlangeWidth
-WebThickness
) / 2FlangeSlopeHeight
=FlangeInnerEdgeLength
* Tan(FlangeSlope
)WebEdgeLength
=Depth
-FlangeThickness
WebSlopeHeight
=WebEdgeLength
* Tan(WebSlope
)
Constraints:
FlangeWidth
must be greater than zeroDepth
must be greater than zeroFlangeThickness
- must be greater than zero
- must be less than
Depth
WebThickness
- must be greater than zero
- must be less than
FlangeWidth
FilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
FlangeInnerEdgeLength
minusWebSlopeHeight
- must be less or equal to half
WebEdgeLength
minusFlangeSlopeHeight
FlangeEdgeRadius
- must be greater or equal to zero
- must be less or equal to half
FlangeInnerEdgeLength
- must be less or equal to
FlangeThickness
FlangeSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
FlangeSlopeHeight
must be less or equal to halfWebEdgeLength
WebEdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
WebEdgeLength
- must be less or equal to half
WebThickness
WebSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
WebSlopeHeight
must be less or equal to halfFlangeInnerEdgeLength
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
FlangeWidth | Extent of the width (top flange), defined parallel to the x axis of the position coordinate system. | double | |
Depth | Extent of the depth (web length), defined parallel to the y axis of the position coordinate system. | double | |
FlangeThickness | Constant wall thickness of the flange. | double | |
WebThickness | Constant wall thickness of the web. | double | |
FilletRadius | The fillet radius between the web and the flange. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeEdgeRadius | Radius of flange edges. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeSlope | Slope of the lower face of the flange. Non-zero in case of tapered flange, 0 in case of non-tapered flange, default 0 if not specified. | double | |
WebEdgeRadius | Radius of web edges. 0 if sharp-edged, default 0 if not specified. | double | |
WebSlope | Slope of the web. Non-zero in case of tapered web, 0 in case of non-tapered web, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
TTShapeProfile (TT-Shape Profile) Sealed EntityClass
A TT-shaped Profile similar to double-tee concrete shapes.
Base Class: Profiles:ParametricProfile
Derivative properties:
FlangeInnerFaceLength
= (FlangeWidth
- 2 *WebThickness
-WebSpacing
) / 2FlangeSlopeHeight
=FlangeInnerFaceLength
* Tan(FlangeSlope
)WebOuterFaceLength
=Depth
-FlangeThickness
WebInnerFaceLength
=WebOuterFaceLength
-FlangeSlopeHeight
WebOuterSlopeHeight
=WebOuterFaceLength
* Tan(WebSlope
)WebInnerSlopeHeight
=WebInnerFaceLength
* Tan(WebSlope
)
Constraints:
FlangeWidth
must be greater than zeroDepth
must be greater than zeroFlangeThickness
- must be greater than zero
- must be less than
Depth
WebThickness
- must be greater than zero
- two times
WebThickness
plusWebSpacing
must be less thanFlangeWidth
WebSpacing
- must be greater than zero
- must be less than
FlangeWidth
minus two timesWebThickness
FilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
FlangeInnerFaceLength
minusWebOuterSlopeHeight
- must be less or equal to half
OuterFaceLength
minusFlangeSlopeHeight
FlangeEdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to
FlangeThickness
- must be less or equal to half
FlangeInnerFaceLength
FlangeSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
FlangeSlopeHeight
must be less or equal to halfWebOuterFaceLength
WebEdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
WebThickness
- must be less or equal to half
WebOuterFaceLength
WebSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
WebOuterSlopeHeight
must be less or equal to halfFlangeInnerFaceLength
WebInnerSlopeHeight
must be less or equal to halfWebSpacing
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
FlangeWidth | Extent of the width (top flange), defined parallel to the x axis of the position coordinate system. | double | |
Depth | Extent of the depth (web length), defined parallel to the y axis of the position coordinate system. | double | |
FlangeThickness | Constant wall thickness of the flange. | double | |
WebThickness | Constant wall thickness of the web. | double | |
WebSpacing | Spacing between the two webs. | double | |
FilletRadius | The fillet radius between the web and the flange. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeEdgeRadius | Radius of flange edges. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeSlope | Slope of the lower face of the flange. Non-zero in case of tapered flange, 0 in case of non-tapered flange, default 0 if not specified. | double | |
WebEdgeRadius | Radius of web edges. 0 if sharp-edged, default 0 if not specified. | double | |
WebSlope | Slope of the web. Non-zero in case of tapered web, 0 in case of non-tapered web, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
TrapezoidProfile (Trapezoid Profile) Sealed EntityClass
Trapezoid shape Profile.
Base Class: Profiles:ParametricProfile
Constraints:
TopWidth
must be greater than zeroBottomWidth
must be greater than zeroDepth
must be greater than zero
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
TopWidth | Extent of the top line measured along the implicit x-axis. | double | |
BottomWidth | Extent of the bottom line measured along the implicit x-axis. | double | |
Depth | Extent of the distance between the parallel bottom and top lines measured along the implicit y-axis. | double | |
TopOffset | Offset from the beginning of the top line to the bottom line, measured along the implicit x-axis. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
ZShapeProfile (Z-Shape Profile) Sealed EntityClass
A Z-shaped Profile similar to rolled steel Z-shapes.
Base Class: Profiles:ParametricProfile
Derivative properties:
FlangeInnerEdgeLength
= (FlangeWidth
-WebThickness
) / 2FlangeSlopeHeight
=FlangeInnerEdgeLength
* Tan(FlangeSlope
)WebEdgeLength
=Depth
-FlangeThickness
* 2
Constraints:
FlangeWidth
must be greater than zeroDepth
must be greater than zeroFlangeThickness
- must be greater than zero
- must be less than half
Depth
WebThickness
- must be greater than zero
- must be less than
FlangeWith
FilletRadius
(if set):- must be greater or equal to zero
- must be less or equal to half
FlangeInnerEdgeLength
- must be less or equal to half
WebEdgeLength
minusFlangeSlopeHeight
FlangeEdgeRadius
(if set):- must be greater or equal to zero
- must be less or equal to
FlangeThickness
- must be less or equal to half
FlangeInnerEdgeLength
FlangeSlope
(if set):- must be greater or equal to zero
- must be less than ninety degrees
FlangeSlopeHeight
must be less or equal to halfWebEdgeLength
Properties
Name | Description | Type | Extended Type |
---|---|---|---|
FlangeWidth | Extent of single flange, defined parallel to the x axis of the position coordinate system. | double | |
Depth | Extent of the depth (web length), defined parallel to the y axis of the position coordinate system. | double | |
FlangeThickness | Constant wall thickness of flanges. | double | |
WebThickness | Constant wall thickness of the web. | double | |
FilletRadius | The fillet radius between the web and the flanges. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeEdgeRadius | Radius of flange edges. 0 if sharp-edged, default 0 if not specified. | double | |
FlangeSlope | Slope of the lower face of the top flange and of the upper face of the bottom flange. Non-zero in case of tapered flanges, 0 in case of parallel flanges, default 0 if not specified. | double |
Inherited properties
Name | Description | Type | Extended Type |
---|---|---|---|
Model | The bis:Model that contains this bis:Element. | navigation | |
LastMod | The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. | dateTime | |
CodeSpec | The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeScope | The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | navigation | |
CodeValue | The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. | string | |
UserLabel | An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). | string | |
Parent | The parent bis:Element that owns this bis:Element. | navigation | |
FederationGuid | The GUID used to federate this bis:Element across repositories. | binary | BeGuid |
JsonProperties | A string property that users and/or applications can use to persist ad hoc JSON values. | string | Json |
IsPrivate | If true, this bis:DefinitionElement should not be displayed in the GUI. | boolean | |
Name | Name of the profile. This property is also used as designation when referencing a profile from standard catalog. | string | |
Shape | 2D geometry of the profile. | Bentley.Geometry.Common.IGeometry | |
CardinalPoints | Array of published and custom (user defined) cardinal points of the profile. | struct array |
Mixins
ICenterlineProfile (Centerline Profile) Abstract Mixin
Applies To: Profile
Properties
Name | Description | Label | Category | Read Only | Priority |
---|---|---|---|---|---|
Centerline | Non self intersecting centerline defining the geometry of the Profile. | [object Promise] | false | 0 | |
WallThickness | Constant thickness that is applied evenly along the Centerline. | Wall Thickness | [object Promise] | false | 0 |
CardinalPoint (Cardinal Point) StructClass
2D location on the profile used to place and offset profiles when extruding them on curve members.
All Profiles have an array of CardinalPoints containing 19 predefined standard cardinal points. In addition, users may define their own custom cardinal points and append them to the end of the array - in such case the name of the custom CardinalPoint must not clash with names of standard cardinal points.
Standard Cardinal points are:
- BottomLeft - Bottom left corner of the profiles bounding box
- BottomCenter - Middle point of bottom line of the profiles bounding box
- BottomRight - Bottom right corner of the profiles bounding box
- MidDepthLeft - Middle point of left line of the profiles bounding box
- MidDepthCenter - Center point of the profiles bounding box
- MidDepthRight - Middle point of right line of the profiles bounding box
- TopLeft - Top left corner of the profiles bounding box
- TopCenter - Middle point of top line of the profiles bounding box
- TopRight - Top right corner of the profiles bounding box
- GeometricCentroid - Geometric centroid of the profiles geometry
- BottomInLineWithGeometricCentroid - Most bottom point of the profiles geometry thats in-line with GeometricCentroid
- LeftInLineWithGeometricCentroid - Most left point of the profiles geometry thats in-line with GeometricCentroid
- RightInLineWithGeometricCentroid - Most right point of the profiles geometry thats in-line with GeometricCentroid
- TopInLineWithGeometricCentroid - Most top point of the profiles geometry thats in-line with GeometricCentroid
- ShearCenter - Shear center of the profiles geometry
- BottomInLineWithShearCenter - Most bottom point of the profiles geometry thats in-line with ShearCenter
- LeftInLineWithShearCenter - Most left point of the profiles geometry thats in-line with ShearCenter
- RightInLineWithShearCenter - Most right point of the profiles geometry thats in-line with ShearCenter
- TopInLineWithShearCenter - Most top point of the profiles geometry thats in-line with ShearCenter
Properties
Name | Description | Label | Category | Read Only | Priority |
---|---|---|---|---|---|
Name | Name of the cardinal point, used to reference and distinguish cardinal points. Unique in the scope of a profile. | [object Promise] | false | 0 | |
Location | 2D offset from the start of profiles coordinate system (0, 0) defining the location for the cardinal point. | [object Promise] | false | 0 |
Relationship Classes
ArbitraryCompositeProfileComponentAspectRefersToSinglePerimeterProfile Sealed RelationshipClass
Strength: Referencing
Strength Direction: Forward
Source
Target
ArbitraryCompositeProfileOwnsArbitraryCompositeProfileComponentAspect Sealed RelationshipClass
Base Class: BisCore:ElementOwnsMultiAspects
Strength: Embedding
Strength Direction: Forward
Source
Target
CShapeProfileOwnsDoubleCShapeProfile Sealed RelationshipClass
Base Class: BisCore:ElementOwnsChildElements
Strength: Embedding
Strength Direction: Forward
Source
Target
LShapeProfileOwnsDoubleLShapeProfile Sealed RelationshipClass
Base Class: BisCore:ElementOwnsChildElements
Strength: Embedding
Strength Direction: Forward
Source
Target
SinglePerimeterProfileOwnsDerivedProfile Sealed RelationshipClass
Base Class: BisCore:ElementOwnsChildElements
Strength: Embedding
Strength Direction: Forward
Source
Target
Enumerations
DoubleLShapeProfileType (Double L-Shape Profile Type) Enumeration
Backing Type: int
Strict: true
Label | Value | Description |
---|---|---|
LLBB | 0 | |
SLBB | 1 |
Enumeration used to specify how DoubleLShapeProfiles geometry is created - which "legs" of the LShapeProfile are placed back to back.
ProfileProperties (Profile Properties) PropertyCategory
Properties of a Structural Profile.
Priority: 1
Last Updated: 13 May, 2024