CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcAlignmentCantSegment Class Reference

#include <IfcAlignmentCantSegmentAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcAlignmentCantSegment:
OdIfc4x4::IfcAlignmentParameterSegment OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

double getStartDistAlong () const
 
void setStartDistAlong (double StartDistAlong)
 
double getHorizontalLength () const
 
void setHorizontalLength (double HorizontalLength)
 
double getStartCantLeft () const
 
void setStartCantLeft (double StartCantLeft)
 
double getEndCantLeft () const
 
void setEndCantLeft (double EndCantLeft)
 
double getStartCantRight () const
 
void setStartCantRight (double StartCantRight)
 
double getEndCantRight () const
 
void setEndCantRight (double EndCantRight)
 
IfcAlignmentCantSegmentTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcAlignmentCantSegmentTypeEnum PredefinedType)
 
 IfcAlignmentCantSegment ()
 
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::IfcAlignmentParameterSegment
const OdAnsiString & getStartTag () const
 
void setStartTag (const OdAnsiString &StartTag)
 
const OdAnsiString & getEndTag () const
 
void setEndTag (const OdAnsiString &EndTag)
 
 IfcAlignmentParameterSegment ()
 
- 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

double m_StartDistAlong
 
IfcNonNegativeLengthMeasure m_HorizontalLength
 
double m_StartCantLeft
 
double m_EndCantLeft
 
double m_StartCantRight
 
double m_EndCantRight
 
OdDAI::Enum m_PredefinedType
 
- Protected Attributes inherited from OdIfc4x4::IfcAlignmentParameterSegment
OdAnsiString m_StartTag
 
OdAnsiString m_EndTag
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

This class represents an individual segment (or sequence) that defines whole cant alignment. The cant alignment is defined by ordered segments that connect end-to-start. The points defined in a cant alignment segment are defined in a plane with x = distance along horizontal alignment and y = height relative to projected points in vertical alignment. The following cant segment types are defined in the IfcAlignmentCantSegmentTypeEnum enumeration: Bloss transition - kIfcAlignmentCantSegmentTypeEnum_BLOSSCURVE. Constant cant - kIfcAlignmentCantSegmentTypeEnum_CONSTANTCANT. Cosine transition - kIfcAlignmentCantSegmentTypeEnum_COSINECURVE. Helmert transition - kIfcAlignmentCantSegmentTypeEnum_HELMERTCURVE. Linear transition - kIfcAlignmentCantSegmentTypeEnum_LINEARTRANSITION. Sine transition - kIfcAlignmentCantSegmentTypeEnum_SINECURVE. Viennese Bend (R) transition - kIfcAlignmentCantSegmentTypeEnum_VIENNESEBEND.

For each cant segment, the following information is provided: The start point, defined by distance along the horizontal alignment. The length (as horizontal length along the distance along (not the curve segment length)). The start cant, given by the values of left cant and right cant, measured relatively to vertical alignment. The end cant, given by the values of left cant and right cant, measured from vertical alignment. The information of tangential continuity that can be used to check continuity of segments (e.g. invalid sudden change of cant or missing cant information if end point and starting point differ over a threshold).

Definition at line 58 of file IFC4X4/IfcAlignmentCantSegmentAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcAlignmentCantSegment()

OdIfc4x4::IfcAlignmentCantSegment::IfcAlignmentCantSegment ( )

Default constructor for the IfcAlignmentCantSegment class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ getEndCantLeft()

double OdIfc4x4::IfcAlignmentCantSegment::getEndCantLeft ( ) const

Returns the value of EndCantLeft attribute. EndCantLeft is length measured for the left cant at the end of the segment.

Returns
Returns the value of EndCantLeft attribute.

◆ getEndCantRight()

double OdIfc4x4::IfcAlignmentCantSegment::getEndCantRight ( ) const

Returns the value of EndCantRight attribute. EndCantRight is length measured for the right cant at the end of the segment.

Returns
Returns the value of EndCantRight attribute.

◆ getHorizontalLength()

double OdIfc4x4::IfcAlignmentCantSegment::getHorizontalLength ( ) const

Returns the value of HorizontalLength attribute. Horizontal length is length measured as distance along the horizontal alignment of the segment.

Returns
Returns the value of HorizontalLength attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ getPredefinedType()

IfcAlignmentCantSegmentTypeEnum OdIfc4x4::IfcAlignmentCantSegment::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. Predefined type identifies the predefined type of a segment of a cant alignment segment.

Returns
Returns the value from the IfcAlignmentCantSegmentTypeEnum enumeration that represents a cant alignment segment.

◆ getStartCantLeft()

double OdIfc4x4::IfcAlignmentCantSegment::getStartCantLeft ( ) const

Returns the value of StartCantLeft attribute. StartCantLeft is length measured for the left cant at the beginning of the segment.

Returns
Returns the value of StartCantLeft attribute.

◆ getStartCantRight()

double OdIfc4x4::IfcAlignmentCantSegment::getStartCantRight ( ) const

Returns the value of StartCantRight attribute. StartCantRight is length measured for the right cant at the beginning of the segment.

Returns
Returns the value of StartCantRight attribute.

◆ getStartDistAlong()

double OdIfc4x4::IfcAlignmentCantSegment::getStartDistAlong ( ) const

Returns the value of StartDistAlong attribute. StartDistAlong is distance along the horizontal alignment, measured along the IfcAlignment2DHorizontal given in the length unit of the global IfcUnitAssignment.

Returns
Returns the value of StartDistAlong attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ isKindOf()

virtual bool OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ outFields()

virtual OdResult OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ setEndCantLeft()

void OdIfc4x4::IfcAlignmentCantSegment::setEndCantLeft ( double EndCantLeft)

Sets the value of EndCantLeft attribute. EndCantLeft is length measured for the left cant at the end of the segment.

Parameters
EndCantLeft[in] EndCantLeft to set.

◆ setEndCantRight()

void OdIfc4x4::IfcAlignmentCantSegment::setEndCantRight ( double EndCantRight)

Sets the value of EndCantRight attribute. EndCantRight is length measured for the right cant at the end of the segment.

Parameters
EndCantRight[in] EndCantRight to set.

◆ setHorizontalLength()

void OdIfc4x4::IfcAlignmentCantSegment::setHorizontalLength ( double HorizontalLength)

Sets the value of HorizontalLength attribute. Horizontal length is length measured as distance along the horizontal alignment of the segment.

Parameters
HorizontalLength[in] Horizontal length to set.

◆ setPredefinedType()

void OdIfc4x4::IfcAlignmentCantSegment::setPredefinedType ( IfcAlignmentCantSegmentTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. Predefined type identifies the predefined type of a segment of a cant alignment segment.

Parameters
PredefinedType[in] PredefinedType to set.

◆ setStartCantLeft()

void OdIfc4x4::IfcAlignmentCantSegment::setStartCantLeft ( double StartCantLeft)

Sets the value of StartCantLeft attribute. StartCantLeft is length measured for the left cant at the beginning of the segment.

Parameters
StartCantLeft[in] StartCantLeft to set.

◆ setStartCantRight()

void OdIfc4x4::IfcAlignmentCantSegment::setStartCantRight ( double StartCantRight)

Sets the value of StartCantRight attribute. StartCantRight is length measured for the right cant at the beginning of the segment.

Parameters
StartCantRight[in] StartCantRight to set.

◆ setStartDistAlong()

void OdIfc4x4::IfcAlignmentCantSegment::setStartDistAlong ( double StartDistAlong)

Sets the value of StartDistAlong attribute. StartDistAlong is distance along the horizontal alignment, measured along the IfcAlignment2DHorizontal given in the length unit of the global IfcUnitAssignment.

Parameters
StartDistAlong[in] StartDistAlong to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcAlignmentCantSegment::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::IfcAlignmentParameterSegment.

Member Data Documentation

◆ m_EndCantLeft

double OdIfc4x4::IfcAlignmentCantSegment::m_EndCantLeft
protected

Definition at line 297 of file IFC4X4/IfcAlignmentCantSegmentAutoImpl.h.

◆ m_EndCantRight

double OdIfc4x4::IfcAlignmentCantSegment::m_EndCantRight
protected

Definition at line 299 of file IFC4X4/IfcAlignmentCantSegmentAutoImpl.h.

◆ m_HorizontalLength

IfcNonNegativeLengthMeasure OdIfc4x4::IfcAlignmentCantSegment::m_HorizontalLength
protected

Definition at line 295 of file IFC4X4/IfcAlignmentCantSegmentAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4x4::IfcAlignmentCantSegment::m_PredefinedType
protected

Definition at line 300 of file IFC4X4/IfcAlignmentCantSegmentAutoImpl.h.

◆ m_StartCantLeft

double OdIfc4x4::IfcAlignmentCantSegment::m_StartCantLeft
protected

Definition at line 296 of file IFC4X4/IfcAlignmentCantSegmentAutoImpl.h.

◆ m_StartCantRight

double OdIfc4x4::IfcAlignmentCantSegment::m_StartCantRight
protected

Definition at line 298 of file IFC4X4/IfcAlignmentCantSegmentAutoImpl.h.

◆ m_StartDistAlong

double OdIfc4x4::IfcAlignmentCantSegment::m_StartDistAlong
protected

Definition at line 294 of file IFC4X4/IfcAlignmentCantSegmentAutoImpl.h.


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