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

#include <IfcAlignmentParameterSegmentAutoImpl.h>

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

Public Member Functions

const OdAnsiString & getStartTag () const
 
void setStartTag (const OdAnsiString &StartTag)
 
const OdAnsiString & getEndTag () const
 
void setEndTag (const OdAnsiString &EndTag)
 
 IfcAlignmentParameterSegment ()
 
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::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

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

An abstract entity defining common information about horizontal, vertical and cant alignment segments.

Remarks
The start and end tag are defined as annotations, not as referents along the alignment. Only absolute distance expressions are in scope, not distances ahead or behind a referent, such as a station. However such information can be exchanged as tags.

Definition at line 49 of file IFC4X4/IfcAlignmentParameterSegmentAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcAlignmentParameterSegment()

OdIfc4x4::IfcAlignmentParameterSegment::IfcAlignmentParameterSegment ( )

Default constructor for the IfcAlignmentParameterSegment class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcAlignmentParameterSegment::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 in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcAlignmentParameterSegment::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 in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ getAttr() [2/2]

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

Reimplemented in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ getEndTag()

const OdAnsiString & OdIfc4x4::IfcAlignmentParameterSegment::getEndTag ( ) const

Returns the value of EndTag attribute. End tag is tag to annotate the end point of the alignment segment.

Returns
Returns the value of EndTag attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcAlignmentParameterSegment::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 in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ getStartTag()

const OdAnsiString & OdIfc4x4::IfcAlignmentParameterSegment::getStartTag ( ) const

Returns the value of StartTag attribute. Start tag is tag to annotate the start point of the alignment segment.

Returns
Returns the value of StartTag attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcAlignmentParameterSegment::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 in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ isKindOf()

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

Reimplemented in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ outFields()

virtual OdResult OdIfc4x4::IfcAlignmentParameterSegment::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 in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ putAttr() [1/2]

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

Reimplemented in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ putAttr() [2/2]

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

Reimplemented in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ setEndTag()

void OdIfc4x4::IfcAlignmentParameterSegment::setEndTag ( const OdAnsiString & EndTag)

Sets the value of EndTag attribute. End tag is tag to annotate the end point of the alignment segment.

Parameters
EndTag[in] End tag to set.

◆ setStartTag()

void OdIfc4x4::IfcAlignmentParameterSegment::setStartTag ( const OdAnsiString & StartTag)

Sets the value of StartTag attribute. Start tag is tag to annotate the start point of the alignment segment.

Parameters
StartTag[in] Start tag to set.

◆ testAttr() [1/2]

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

Reimplemented in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ testAttr() [2/2]

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

Reimplemented in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ type()

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

Reimplemented in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcAlignmentParameterSegment::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

◆ unsetAttr() [2/2]

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

Reimplemented in OdIfc4x4::IfcAlignmentCantSegment, OdIfc4x4::IfcAlignmentHorizontalSegment, and OdIfc4x4::IfcAlignmentVerticalSegment.

Member Data Documentation

◆ m_EndTag

OdAnsiString OdIfc4x4::IfcAlignmentParameterSegment::m_EndTag
protected

◆ m_StartTag

OdAnsiString OdIfc4x4::IfcAlignmentParameterSegment::m_StartTag
protected

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