#include <IfcStairAutoImpl.h>

Inheritance diagram for OdIfc4x3_add2::IfcStair:

Public Member Functions
IfcStairTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcStairTypeEnum PredefinedType)

	IfcStair ()

virtual OdResult	inFields (OdDAI::OdSpfFilerBase *rdFiler) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override

virtual OdDAI::Entity *	getInstanceType () const override

virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override

virtual void	unsetAttr (const char *explicitAttrName) override

virtual bool	testAttr (const char *explicitAttrName) const override

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

virtual bool	isKindOf (OdIfc::OdIfcEntityType entityType) const override

virtual OdIfc::OdIfcEntityType	type () const override

virtual OdRxValue	getAttr (const OdIfc::OdIfcAttribute attrDef) const override

virtual void	unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override

virtual bool	testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override

virtual bool	putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override

Public Member Functions inherited from OdIfc4x3_add2::IfcElement
const OdAnsiString &	getTag () const

void	setTag (const OdAnsiString &Tag)

void	getInvFillsVoids (OdDAIObjectIds &FillsVoids) const

void	getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const

void	getInvIsInterferedByElements (OdDAIObjectIds &IsInterferedByElements) const

void	getInvInterferesElements (OdDAIObjectIds &InterferesElements) const

void	getInvHasProjections (OdDAIObjectIds &HasProjections) const

void	getInvHasOpenings (OdDAIObjectIds &HasOpenings) const

void	getInvIsConnectionRealization (OdDAIObjectIds &IsConnectionRealization) const

void	getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const

void	getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const

void	getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const

void	getInvHasCoverings (OdDAIObjectIds &HasCoverings) const

void	getInvHasSurfaceFeatures (OdDAIObjectIds &HasSurfaceFeatures) const

	IfcElement ()

Public Member Functions inherited from OdIfc4x3_add2::IfcProduct
const OdDAIObjectId &	getObjectPlacement () const

void	setObjectPlacement (const OdDAIObjectId &ObjectPlacement)

const OdDAIObjectId &	getRepresentation () const

void	setRepresentation (const OdDAIObjectId &Representation)

void	getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const

void	getInvPositionedRelativeTo (OdDAIObjectIds &PositionedRelativeTo) const

void	getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const

virtual void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc4x3_add2::IfcObject
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const

void	getInvDeclares (OdDAIObjectIds &Declares) const

void	getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

Public Member Functions inherited from OdIfc4x3_add2::IfcObjectDefinition
void	getInvHasAssignments (OdDAIObjectIds &HasAssignments) const

void	getInvNests (OdDAIObjectIds &Nests) const

void	getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const

void	getInvHasContext (OdDAIObjectIds &HasContext) const

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc4x3_add2::IfcRoot
OdDAI::CompressedGUID	getGlobalId () const

void	setGlobalId (OdDAI::CompressedGUID GlobalId)

const OdDAIObjectId &	getOwnerHistory () const

void	setOwnerHistory (const OdDAIObjectId &OwnerHistory)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

	IfcRoot ()

Public Member Functions inherited from OdIfc4x3_add2::OdIfc4x3Instance
void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc::OdIfcInstance
	ODRX_DECLARE_MEMBERS (OdIfcInstance)

	OdIfcInstance ()

	~OdIfcInstance ()

bool	isInstanceOf (OdIfcEntityType entityType) const

IfcOpResult	resolved ()

void	resolve (IfcOpResult resolved, void *resPtr)

void	unresolve ()

virtual void	setGsNode (OdGsCache *pGsNode)

virtual OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdDAI::Enum	m_PredefinedType

Protected Attributes inherited from OdIfc4x3_add2::IfcElement
OdAnsiString	m_Tag

Protected Attributes inherited from OdIfc4x3_add2::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc4x3_add2::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4x3_add2::IfcRoot
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

OdAnsiString	m_Name

OdAnsiString	m_Description

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Detailed Description

A stair is a vertical passageway allowing occupants to walk (step) from one floor level to another floor level at a different elevation. It can include a landing as an intermediate floor slab. The IfcStair can either be represented: as a stair assembly entity that aggregates all parts (stair flight, landing, etc. with own representations) as a single stair entity without decomposition including all representation directly at the stair entity

NOTE: In case of an IfcStair being the aggregate of all parts of the stair the aggregation is handled by the IfcRelAggregates relationship, relating an IfcStair with the related IfcStairFlight and landings, IfcSlab with PredefinedType=LANDING. IfcRailing's belonging to the stair can also be included into the aggregation.

Axis 2D Geometry - The walking line is represented by a two-dimensional open curve as the axis. The curve is directed into the upward direction (direction has to be interpreted as specified at the subtypes of IfcCurve).
Element Decomposition - The image below illustrates stair placement, where the IfcStair defines the local placement for all components and the common 'Axis' representation, and each component has its own 'Body' representation.

This concept can be applied to the following resources: IfcStairFlight - Stairs can be decomposed into stair flights IfcSlab - Stairs can be decomposed into stair landing, represented by IfcSlab.PredefinedType=LANDING IfcRailing - Stairs can be decomposed into railings for zero, one, or both sides

Material Single - The material of the IfcStair is defined by the IfcMaterial and attached by the IfcRelAssociatesMaterial.RelatingMaterial. It is accessible by the inverse HasAssociations relationship. Material information can also be specified at the IfcStairType, defining the common attribute data for all occurrences of the same type. It is then accessible by the inverse IsDefinedBy relationship pointing to IfcStair.HasAssociations and via IfcRelAssociatesMaterial.RelatingMaterial to IfcMaterial. If both are specified, then the material directly assigned to IfcStair overrides the material assigned to IfcStairType.
Object Typing - This concept can be applied to the following resources: IfcStairType
Product Local Placement - The following restriction can be imposed by view definitions or implementer agreements: If the IfcStair establishes an aggregate, then all contained elements are placed relative to the IfcStair.ObjectPlacement.
Property Sets for Objects - This concept can be applied to the following resources: Pset_ConcreteElementGeneral Pset_PrecastConcreteElementFabrication Pset_PrecastConcreteElementGeneral Pset_StairCommon
Spatial Containment - The IfcStair, as any subtype of IfcBuildingElement, can participate alternatively in one of the two different containment relationships: the Spatial Containment (defined here) the Element Composition

\changes

IFC4 changes: Name of the ShapeType attribute changed to PredefinedType Attribute ShapeType made optional, changed from "False" to "True" IFC4X3_RC1 changes: Supertype, changed from "IfcBuildingElement" to "IfcBuiltElement"

Definition at line 99 of file Ifc4x3/IfcStairAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcStair()

OdIfc4x3_add2::IfcStair::IfcStair ( )

Default constructor for the IfcStair class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x3_add2::IfcStair::comparedToEarlyImpl	(	const OdDAI::ApplicationInstance *	pOther,
		OdRx::Ordering &	ordering ) const

overridevirtual

Early-bound version of instances comparison.

Parameters

pOther	[in] Other application instance.
ordering	[out] Receives the ordering (comparison) status.

Returns: true if comparison was performed, false if method has no implementation, so late-bound version could be applied.

Remarks

If the method returns true, the ordering parameter can receive one of the following statuses:

Value Description kLessThan -1 This object < Other Object. kEqual 0 This object = Other Object. kGreaterThan 1 This object > Other Object. kNotOrderable 2 This class is not orderable.

Reimplemented from OdIfc4x3_add2::IfcBuiltElement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x3_add2::IfcStair::getAttr ( const char * attrName ) const

overridevirtual

Returns an attribute value for the specified attribute name.

Parameters

attrName [in] Name of an attribute to query.

Returns: OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc4x3_add2::IfcElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x3_add2::IfcStair::getAttr ( const OdIfc::OdIfcAttribute attrDef ) const

overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters

attrDef [in] Attribute definition to query.

Returns: OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc4x3_add2::IfcElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x3_add2::IfcStair::getInstanceType ( ) const

overridevirtual

Returns a type of a class instance.

Returns: Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

Reimplemented from OdIfc4x3_add2::IfcBuiltElement.

◆ getPredefinedType()

IfcStairTypeEnum OdIfc4x3_add2::IfcStair::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined generic type for a stair that is specified in an enumeration. There can be a property set specified specifically for the predefined types.

Returns: Returns the value of PredefinedType attribute.

Remarks: The PredefinedType is only used if no IfcStairType is assigned, providing its own IfcStairType.PredefinedType IFC4 CHANGE: The attribute has been renamed from ShapeType and changed to be OPTIONAL with upward compatibility for file-based exchange

◆ inFields()

virtual OdResult OdIfc4x3_add2::IfcStair::inFields ( OdDAI::OdSpfFilerBase * rdFiler )

overridevirtual

Reads object's data from the specified filer.

Parameters

rdFiler [in] Pointer to a filer from which to read the data.

Returns: A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc4x3_add2::IfcElement.

◆ isKindOf()

virtual bool OdIfc4x3_add2::IfcStair::isKindOf ( OdIfc::OdIfcEntityType entityType ) const

overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters

entityType [in] Entity to check.

Returns: true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc4x3_add2::IfcBuiltElement.

◆ outFields()

virtual OdResult OdIfc4x3_add2::IfcStair::outFields ( OdDAI::OdSpfFilerBase * wrFiler )

overridevirtual

Writes object's data the the specified filer.

Parameters

wrFiler [in] Pointer to a filer to which to write the data.

Returns: A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc4x3_add2::IfcElement.

◆ putAttr() [1/2]

virtual bool OdIfc4x3_add2::IfcStair::putAttr	(	const char *	explicitAttrName,
		const OdRxValue &	val )

overridevirtual

Sets the specified attribute with a given value.

Parameters

explicitAttrName	[in] Explicit name of the attribute to set.
val	[in] Value to set.

Returns: true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc4x3_add2::IfcElement.

◆ putAttr() [2/2]

virtual bool OdIfc4x3_add2::IfcStair::putAttr	(	const OdIfc::OdIfcAttribute	explicitAttrDef,
		const OdRxValue &	val )

overridevirtual

Sets the specified attribute with a given value.

Parameters

explicitAttrDef	[in] Explicit attribute definition to set.
val	[in] Value to set.

Returns: true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc4x3_add2::IfcElement.

◆ setPredefinedType()

void OdIfc4x3_add2::IfcStair::setPredefinedType ( IfcStairTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents predefined generic type for a stair that is specified in an enumeration. There can be a property set specified specifically for the predefined types.

Parameters

PredefinedType [in] Predefined type to set.

Remarks: The PredefinedType is only used if no IfcStairType is assigned, providing its own IfcStairType.PredefinedType IFC4 CHANGE: The attribute has been renamed from ShapeType and changed to be OPTIONAL with upward compatibility for file-based exchange

◆ testAttr() [1/2]

virtual bool OdIfc4x3_add2::IfcStair::testAttr ( const char * explicitAttrName ) const

overridevirtual

Checks whether the specified attribute is set.

Parameters

explicitAttrName [in] Explicit name of the attribute to test.

Returns: true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4x3_add2::IfcElement.

◆ testAttr() [2/2]

virtual bool OdIfc4x3_add2::IfcStair::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef ) const

overridevirtual

Checks whether the specified attribute is set.

Parameters

explicitAttrDef [in] Attribute definition to test.

Returns: true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4x3_add2::IfcElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x3_add2::IfcStair::type ( ) const

overridevirtual

Returns the type of this entity.

Returns: A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc4x3_add2::IfcBuiltElement.

◆ unsetAttr() [1/2]

virtual void OdIfc4x3_add2::IfcStair::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrName [in] Explicit name of the attribute to reset.

Reimplemented from OdIfc4x3_add2::IfcElement.

◆ unsetAttr() [2/2]

virtual void OdIfc4x3_add2::IfcStair::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrDef [in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc4x3_add2::IfcElement.

Member Data Documentation

◆ m_PredefinedType

OdDAI::Enum OdIfc4x3_add2::IfcStair::m_PredefinedType

protected

Definition at line 265 of file Ifc4x3/IfcStairAutoImpl.h.

The documentation for this class was generated from the following file:

Ifc4x3/IfcStairAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcStair()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getPredefinedType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setPredefinedType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_PredefinedType