#include <IfcRampAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcRamp:

Public Member Functions
IfcRampTypeEnum	getShapeType () const

void	setShapeType (IfcRampTypeEnum ShapeType)

	IfcRamp ()

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 OdIfc2x3::IfcElement
const OdAnsiString &	getTag () const

void	setTag (const OdAnsiString &Tag)

void	getInvHasStructuralMember (OdDAIObjectIds &HasStructuralMember) const

void	getInvFillsVoids (OdDAIObjectIds &FillsVoids) const

void	getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const

void	getInvHasCoverings (OdDAIObjectIds &HasCoverings) const

void	getInvHasProjections (OdDAIObjectIds &HasProjections) const

void	getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const

void	getInvHasPorts (OdDAIObjectIds &HasPorts) 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

	IfcElement ()

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

void	setObjectPlacement (const OdDAIObjectId &ObjectPlacement)

const OdDAIObjectId &	getRepresentation () const

void	setRepresentation (const OdDAIObjectId &Representation)

void	getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const

virtual void	setInverseCounterParts () override

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

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

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

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc2x3::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 OdIfc2x3::OdIfc2x3Instance
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_ShapeType

Protected Attributes inherited from OdIfc2x3::IfcElement
OdAnsiString	m_Tag

Protected Attributes inherited from OdIfc2x3::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc2x3::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc2x3::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 ramp is a vertical passageway which provides a human or vehicle circulation link between one floor level and another floor level at a different elevation. It can include a landing as an intermediate floor slab. A ramp normally does not include steps.

The IfcRamp can either be represented: as a ramp assembly that aggregates all parts(ramp flight, landing, etc.) with own shape representations as a single ramp without decomposition including all shape representations directly at the ramp entity

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).
Body SweptSolid Geometry - If the IfcRamp has no components defined (empty set of SELF\IfcProduct.IsDecomposedBy) then the IfcRamp 'Body' geometry can be represented by an own IfcShapeRepresentation.
Element Decomposition - If the IfcRamp has components (referenced by SELF\IfcProduct.IsDecomposedBy) then no independent 'Body' geometric representation is defined for the IfcRamp. The IfcRamp is then geometrically represented by the geometric representation of its components. The image below illustrates IfcRamp defining the local placement for all components.

This concept can be applied to the following resources: IfcRampFlight - Ramps can be decomposed into ramp flights IfcSlab - Ramps can be decomposed into ramp landing, represented by IfcSlab.PredefinedType=LANDING IfcRailing - Ramps can be decomposed into railings

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

Definition at line 95 of file Ifc2x3/IfcRampAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRamp()

OdIfc2x3::IfcRamp::IfcRamp ( )

Default constructor for the IfcRamp class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcBuildingElement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcBuildingElement.

◆ getShapeType()

IfcRampTypeEnum OdIfc2x3::IfcRamp::getShapeType ( ) const

Returns the value of ShapeType attribute. This attribute represents predefined shape types for a ramp that are specified in an enumeration.

Returns: Returns the value of ShapeType attribute.

Remarks: IFC4 CHANGE: The attribute has been renamed to PredefinedType and changed to be OPTIONAL with upward compatibility for file-based exchange.

◆ inFields()

virtual OdResult OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcElement.

◆ isKindOf()

virtual bool OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcBuildingElement.

◆ outFields()

virtual OdResult OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcElement.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcElement.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcElement.

◆ setShapeType()

void OdIfc2x3::IfcRamp::setShapeType ( IfcRampTypeEnum ShapeType )

Sets the value of ShapeType attribute. This attribute represents predefined shape types for a ramp that are specified in an enumeration.

Parameters

ShapeType [in] Shape type to set.

Remarks: IFC4 CHANGE: The attribute has been renamed to PredefinedType and changed to be OPTIONAL with upward compatibility for file-based exchange.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcElement.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcBuildingElement.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcRamp::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc2x3::IfcElement.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcRamp::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 OdIfc2x3::IfcElement.

Member Data Documentation

◆ m_ShapeType

OdDAI::Enum OdIfc2x3::IfcRamp::m_ShapeType

protected

Definition at line 257 of file Ifc2x3/IfcRampAutoImpl.h.

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

Ifc2x3/IfcRampAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcRamp()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getShapeType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setShapeType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_ShapeType