#include <IfcStairFlightAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcStairFlight:

Public Member Functions
int	getNumberOfRisers () const

void	setNumberOfRisers (int NumberOfRisers)

int	getNumberOfTreads () const

void	setNumberOfTreads (int NumberOfTreads)

double	getRiserHeight () const

void	setRiserHeight (double RiserHeight)

double	getTreadLength () const

void	setTreadLength (double TreadLength)

IfcStairFlightTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcStairFlightTypeEnum PredefinedType)

	IfcStairFlight ()

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 OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::OdIFC4X4Instance
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
int	m_NumberOfRisers

int	m_NumberOfTreads

IfcPositiveLengthMeasure	m_RiserHeight

IfcPositiveLengthMeasure	m_TreadLength

OdDAI::Enum	m_PredefinedType

Protected Attributes inherited from OdIfc4x4::IfcElement
OdAnsiString	m_Tag

Protected Attributes inherited from OdIfc4x4::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc4x4::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4x4::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 flight is an assembly of building components in a single "run" of stair steps (not interrupted by a landing). The stair steps and any stringers are included in the stair flight. A winder is also regarded a part of a stair flight.

An IfcStairFlight is normally aggregated by an IfcStair through the IfcRelAggregates relationship, the stair flight is then included in the set of IfcRelAggregates.RelatedObjects. An IfcStairFlight normally connects the floor slab of zero to two different storeys (or partial storeys, or landings) within a building. The connection relationship between the IfcStairFlight and the IfcSlab can be expressed using the IfcRelConnectsElements relationship.

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). The image below illustrates the axis representation which has the following constraints: In case of straight flights the curve is a single item of type IfcPolyline In case of winding flights the curve is a single item of type IfcCompositeCurve In case of a curved flight or a spiral flight the curve is a single item of type IfcTrimmedCurve

Body SweptSolid Geometry - The image below illustrates the 'Body' geometric representation using a 'SweptSolid' representation type.

FootPrint Geometry - The flight foot print, including the flight boundary is represented by a two-dimensional geometric curve set. The image below illustrates the footprint representation which has the following constraints: In case of straight flights the curve set consists of a single item of type IfcPolyline In case of winding flights or curved flights the curve set consists of a single item of type IfcCompositeCurve In case of a spiral flight the curve set consists of a single item of type IfcConic or IfcPolyline

\changes

IFC4 changes: Name of the NumberOfRiser attribute changed to NumberOfRisers Type of the NumberOfRiser attribute changed from "integer" to "IfcInteger" Type of the NumberOfTreads attribute changed from "integer" to "IfcInteger" IFC4X3_RC1 changes: Supertype changed from "IfcBuildingElement" to "IfcBuiltElement"

Definition at line 80 of file IFC4X4/IfcStairFlightAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcStairFlight()

OdIfc4x4::IfcStairFlight::IfcStairFlight ( )

Default constructor for the IfcStairFlight class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcBuiltElement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcBuiltElement.

◆ getNumberOfRisers()

int OdIfc4x4::IfcStairFlight::getNumberOfRisers ( ) const

Returns the value of NumberOfRisers attribute. This attribute represents number of the risers included in the stair flight.

Returns: Returns the value of NumberOfRisers attribute.

Remarks: IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfRisers instead.

◆ getNumberOfTreads()

int OdIfc4x4::IfcStairFlight::getNumberOfTreads ( ) const

Returns the value of NumberOfTreads attribute. This attribute represents number of treads included in the stair flight.

Returns: Returns the value of NumberOfTreads attribute.

Remarks: IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfTreads instead.

◆ getPredefinedType()

IfcStairFlightTypeEnum OdIfc4x4::IfcStairFlight::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined generic type for a stair flight 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 IfcStairFlightType is assigned, providing its own IfcStairFlightType.PredefinedType.

◆ getRiserHeight()

double OdIfc4x4::IfcStairFlight::getRiserHeight ( ) const

Returns the value of RiserHeight attribute. This attribute represents vertical distance from tread to tread. The riser height is supposed to be equal for all stairs in a stair flight.

Returns: Returns the value of RiserHeight attribute.

Remarks: IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.RiserHeight instead.

◆ getTreadLength()

double OdIfc4x4::IfcStairFlight::getTreadLength ( ) const

Returns the value of TreadLength attribute. This attribute represents horizontal distance from the front to the back of the tread. The tread length is supposed to be equal for all steps of the stair flight.

Returns: Returns the value of TreadLength attribute.

Remarks: IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.TreadLength instead.

◆ inFields()

virtual OdResult OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcElement.

◆ isKindOf()

virtual bool OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcBuiltElement.

◆ outFields()

virtual OdResult OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcElement.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcElement.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcElement.

◆ setNumberOfRisers()

void OdIfc4x4::IfcStairFlight::setNumberOfRisers ( int NumberOfRisers )

Sets the value of NumberOfRisers attribute. This attribute represents number of the risers included in the stair flight.

Parameters

NumberOfRisers [in] Number of risers to set.

Remarks: IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfRisers instead.

◆ setNumberOfTreads()

void OdIfc4x4::IfcStairFlight::setNumberOfTreads ( int NumberOfTreads )

Sets the value of NumberOfTreads attribute. This attribute represents number of treads included in the stair flight.

Parameters

NumberOfTreads [in] Number of treads to set.

Remarks: IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.NumberOfTreads instead.

◆ setPredefinedType()

void OdIfc4x4::IfcStairFlight::setPredefinedType ( IfcStairFlightTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents predefined generic type for a stair flight 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 IfcStairFlightType is assigned, providing its own IfcStairFlightType.PredefinedType.

◆ setRiserHeight()

void OdIfc4x4::IfcStairFlight::setRiserHeight ( double RiserHeight )

Sets the value of RiserHeight attribute. This attribute represents vertical distance from tread to tread. The riser height is supposed to be equal for all stairs in a stair flight.

Parameters

RiserHeight [in] Riser height to set.

Remarks: IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.RiserHeight instead.

◆ setTreadLength()

void OdIfc4x4::IfcStairFlight::setTreadLength ( double TreadLength )

Sets the value of TreadLength attribute. This attribute represents horizontal distance from the front to the back of the tread. The tread length is supposed to be equal for all steps of the stair flight.

Parameters

TreadLength [in] Tread length to set.

Remarks: IFC4 CHANGE: The attribute has been deprecated it is only exposed with a NIL value. Use Pset_StairFlightCommon.TreadLength instead.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcElement.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcBuiltElement.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcStairFlight::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x4::IfcElement.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcStairFlight::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 OdIfc4x4::IfcElement.

Member Data Documentation

◆ m_NumberOfRisers

int OdIfc4x4::IfcStairFlight::m_NumberOfRisers

protected

Definition at line 324 of file IFC4X4/IfcStairFlightAutoImpl.h.

◆ m_NumberOfTreads

int OdIfc4x4::IfcStairFlight::m_NumberOfTreads

protected

Definition at line 325 of file IFC4X4/IfcStairFlightAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4x4::IfcStairFlight::m_PredefinedType

protected

Definition at line 328 of file IFC4X4/IfcStairFlightAutoImpl.h.

◆ m_RiserHeight

IfcPositiveLengthMeasure OdIfc4x4::IfcStairFlight::m_RiserHeight

protected

Definition at line 326 of file IFC4X4/IfcStairFlightAutoImpl.h.

◆ m_TreadLength

IfcPositiveLengthMeasure OdIfc4x4::IfcStairFlight::m_TreadLength

protected

Definition at line 327 of file IFC4X4/IfcStairFlightAutoImpl.h.

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

IFC4X4/IfcStairFlightAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcStairFlight()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getNumberOfRisers()

◆ getNumberOfTreads()

◆ getPredefinedType()

◆ getRiserHeight()

◆ getTreadLength()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setNumberOfRisers()

◆ setNumberOfTreads()

◆ setPredefinedType()

◆ setRiserHeight()

◆ setTreadLength()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_NumberOfRisers

◆ m_NumberOfTreads

◆ m_PredefinedType

◆ m_RiserHeight

◆ m_TreadLength