#include <IfcDistanceExpressionAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcDistanceExpression:

Public Member Functions
double	getDistanceAlong () const

void	setDistanceAlong (double DistanceAlong)

double	getOffsetLateral () const

void	setOffsetLateral (double OffsetLateral)

double	getOffsetVertical () const

void	setOffsetVertical (double OffsetVertical)

double	getOffsetLongitudinal () const

void	setOffsetLongitudinal (double OffsetLongitudinal)

OdDAI::Boolean	getAlongHorizontal () const

void	setAlongHorizontal (OdDAI::Boolean AlongHorizontal)

	IfcDistanceExpression ()

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 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 OdIfc4x2::IfcRepresentationItem
void	getInvLayerAssignment (OdDAIObjectIds &LayerAssignment) const

void	getInvStyledByItem (OdDAIObjectIds &StyledByItem) const

Public Member Functions inherited from OdIfc4x2::OdIfc4x2Instance
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
double	m_DistanceAlong

double	m_OffsetLateral

double	m_OffsetVertical

double	m_OffsetLongitudinal

OdDAI::Boolean	m_AlongHorizontal

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

An IfcDistanceExpression describes a point relative to a basis curve according to distance along the basis curve in 3D or as projected onto the horizontal plane, offset lateral to the basis curve according to the horizontal orientation at the specified distance, offset vertical to the basis curve, and an optional additional offset parallel to the basis curve that can be used to address locations otherwise unreachable where the basis curve is tangentially discontinuous.

Definition at line 43 of file Ifc4x2/IfcDistanceExpressionAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDistanceExpression()

OdIfc4x2::IfcDistanceExpression::IfcDistanceExpression ( )

Default constructor for the IfcDistanceExpression class.

Member Function Documentation

◆ getAlongHorizontal()

OdDAI::Boolean OdIfc4x2::IfcDistanceExpression::getAlongHorizontal ( ) const

Returns the value of AlongHorizontal attribute. This attribute indicates whether DistanceAlong is measured according to horizontal projection of distance (if True), or 3D distance (if False or unset).

Returns: Returns the value of AlongHorizontal attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::IfcDistanceExpression::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.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcRepresentationItem.

◆ getDistanceAlong()

double OdIfc4x2::IfcDistanceExpression::getDistanceAlong ( ) const

Returns the value of DistanceAlong attribute. This attribute represents the distance along the basis curve, measured according to projection in the horizontal plane if AlongHorizontal is True, or according to 3D distance otherwise. If the basis curve refers to IfcAlignmentCurve and AlongHorizontal is True, then this measurement directly corresponds to IfcAlignment2DHorizontal.

Returns: Returns the value of DistanceAlong attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcGeometricRepresentationItem.

◆ getOffsetLateral()

double OdIfc4x2::IfcDistanceExpression::getOffsetLateral ( ) const

Returns the value of OffsetLateral attribute. This attribute represents the offset that is horizontally perpendicular to the basis curve, where positive values indicate to the left of the basis curve as facing in the direction of the basis curve, and negative values indicate to the right. If DistanceAlong coincides with a point of tangential discontinuity (within precision limits), then the tangent of the previous segment governs.

Returns: Returns the value of OffsetLateral attribute.

◆ getOffsetLongitudinal()

double OdIfc4x2::IfcDistanceExpression::getOffsetLongitudinal ( ) const

Returns the value of OffsetLongitudinal attribute. This attribute represents the offset that is parallel to the basis curve after applying DistanceAlong, OffsetLateral, and OffsetVertical to reach locations for the case of a tangentially discontinuous basis curve.

Returns: Returns the value of OffsetLongitudinal attribute.

◆ getOffsetVertical()

double OdIfc4x2::IfcDistanceExpression::getOffsetVertical ( ) const

Returns the value of OffsetVertical attribute. This attribute represents the offset that is vertical to the basis curve, where positive values indicate vertically upwards in global coordinates at DistanceAlong, regardless of the slope of the basis curve at such point.

Returns: Returns the value of OffsetVertical attribute.

◆ inFields()

virtual OdResult OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcRepresentationItem.

◆ isKindOf()

virtual bool OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcGeometricRepresentationItem.

◆ outFields()

virtual OdResult OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcRepresentationItem.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcDistanceExpression::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 OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcRepresentationItem.

◆ setAlongHorizontal()

void OdIfc4x2::IfcDistanceExpression::setAlongHorizontal ( OdDAI::Boolean AlongHorizontal )

Sets the value of AlongHorizontal attribute. This attribute indicates whether DistanceAlong is measured according to horizontal projection of distance (if True), or 3D distance (if False or unset).

Parameters

AlongHorizontal [in] AlongHorizontal attribute to set.

◆ setDistanceAlong()

void OdIfc4x2::IfcDistanceExpression::setDistanceAlong ( double DistanceAlong )

Sets the value of DistanceAlong attribute. This attribute represents the distance along the basis curve, measured according to projection in the horizontal plane if AlongHorizontal is True, or according to 3D distance otherwise. If the basis curve refers to IfcAlignmentCurve and AlongHorizontal is True, then this measurement directly corresponds to IfcAlignment2DHorizontal.

Parameters

DistanceAlong [in] DistanceAlong attribute to set.

◆ setOffsetLateral()

void OdIfc4x2::IfcDistanceExpression::setOffsetLateral ( double OffsetLateral )

Sets the value of OffsetLateral attribute. This attribute represents the offset that is horizontally perpendicular to the basis curve, where positive values indicate to the left of the basis curve as facing in the direction of the basis curve, and negative values indicate to the right. If DistanceAlong coincides with a point of tangential discontinuity (within precision limits), then the tangent of the previous segment governs.

Parameters

OffsetLateral [in] OffsetLateral attribute to set.

◆ setOffsetLongitudinal()

void OdIfc4x2::IfcDistanceExpression::setOffsetLongitudinal ( double OffsetLongitudinal )

Sets the value of OffsetLongitudinal attribute. This attribute represents the offset that is parallel to the basis curve after applying DistanceAlong, OffsetLateral, and OffsetVertical to reach locations for the case of a tangentially discontinuous basis curve.

Parameters

OffsetLongitudinal [in] OffsetLongitudinal attribute to set.

◆ setOffsetVertical()

void OdIfc4x2::IfcDistanceExpression::setOffsetVertical ( double OffsetVertical )

Sets the value of OffsetVertical attribute. This attribute represents the offset that is vertical to the basis curve, where positive values indicate vertically upwards in global coordinates at DistanceAlong, regardless of the slope of the basis curve at such point.

Parameters

OffsetVertical [in] OffsetVertical attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcRepresentationItem.

◆ testAttr() [2/2]

virtual bool OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcRepresentationItem.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcGeometricRepresentationItem.

◆ unsetAttr() [1/2]

virtual void OdIfc4x2::IfcDistanceExpression::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x2::IfcRepresentationItem.

◆ unsetAttr() [2/2]

virtual void OdIfc4x2::IfcDistanceExpression::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 OdIfc4x2::IfcRepresentationItem.

Member Data Documentation

◆ m_AlongHorizontal

OdDAI::Boolean OdIfc4x2::IfcDistanceExpression::m_AlongHorizontal

protected

Definition at line 262 of file Ifc4x2/IfcDistanceExpressionAutoImpl.h.

◆ m_DistanceAlong

double OdIfc4x2::IfcDistanceExpression::m_DistanceAlong

protected

Definition at line 258 of file Ifc4x2/IfcDistanceExpressionAutoImpl.h.

◆ m_OffsetLateral

double OdIfc4x2::IfcDistanceExpression::m_OffsetLateral

protected

Definition at line 259 of file Ifc4x2/IfcDistanceExpressionAutoImpl.h.

◆ m_OffsetLongitudinal

double OdIfc4x2::IfcDistanceExpression::m_OffsetLongitudinal

protected

Definition at line 261 of file Ifc4x2/IfcDistanceExpressionAutoImpl.h.

◆ m_OffsetVertical

double OdIfc4x2::IfcDistanceExpression::m_OffsetVertical

protected

Definition at line 260 of file Ifc4x2/IfcDistanceExpressionAutoImpl.h.

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

Ifc4x2/IfcDistanceExpressionAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcDistanceExpression()

Member Function Documentation

◆ getAlongHorizontal()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getDistanceAlong()

◆ getInstanceType()

◆ getOffsetLateral()

◆ getOffsetLongitudinal()

◆ getOffsetVertical()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setAlongHorizontal()

◆ setDistanceAlong()

◆ setOffsetLateral()

◆ setOffsetLongitudinal()

◆ setOffsetVertical()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_AlongHorizontal

◆ m_DistanceAlong

◆ m_OffsetLateral

◆ m_OffsetLongitudinal

◆ m_OffsetVertical