CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Friends | List of all members
OdIfc2x3::IfcConstraint Class Reference

#include <IfcConstraintAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcConstraint:
OdIfc::OdIfcEntity OdIfc2x3::IfcMetric OdIfc2x3::IfcObjective

Public Member Functions

const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
IfcConstraintEnum getConstraintGrade () const
 
void setConstraintGrade (IfcConstraintEnum ConstraintGrade)
 
const OdAnsiString & getConstraintSource () const
 
void setConstraintSource (const OdAnsiString &ConstraintSource)
 
IfcActorSelect creatingActor ()
 
IfcDateTimeSelect creationTime ()
 
const OdAnsiString & getUserDefinedGrade () const
 
void setUserDefinedGrade (const OdAnsiString &UserDefinedGrade)
 
void getInvClassifiedAs (OdDAIObjectIds &ClassifiedAs) const
 
void getInvRelatesConstraints (OdDAIObjectIds &RelatesConstraints) const
 
void getInvIsRelatedWith (OdDAIObjectIds &IsRelatedWith) const
 
void getInvPropertiesForConstraint (OdDAIObjectIds &PropertiesForConstraint) const
 
void getInvAggregates (OdDAIObjectIds &Aggregates) const
 
void getInvIsAggregatedIn (OdDAIObjectIds &IsAggregatedIn) const
 
 IfcConstraint ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc::OdIfcEntity
 ODRX_DECLARE_MEMBERS (OdIfcEntity)
 
 OdIfcEntity ()
 
 ~OdIfcEntity ()
 
virtual bool isKindOf (OdIfcEntityType entityType) const
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
virtual OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfcAttribute attrDef) const
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool testAttr (const OdIfcAttribute explicitAttrDef) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual void unsetAttr (const OdIfcAttribute explicitAttrDef)
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
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
 

Protected Attributes

OdAnsiString m_Name
 
OdAnsiString m_Description
 
OdDAI::Enum m_ConstraintGrade
 
OdAnsiString m_ConstraintSource
 
OdDAI::Select m_CreatingActor
 
OdDAI::Select m_CreationTime
 
OdAnsiString m_UserDefinedGrade
 
- Protected Attributes inherited from OdIfc::OdIfcEntity
void * m_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcConstraintClassificationRelationship
 
class IfcConstraintRelationship
 
class IfcPropertyConstraintRelationship
 
class IfcConstraintAggregationRelationship
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcEntity
static const OdGePoint3d * asPoint3d (const OdIfcEntity *pEnt)
 
static const OdGePoint2d * asPoint2d (const OdIfcEntity *pEnt)
 
static const OdGeVector3d * asVector3d (const OdIfcEntity *pEnt)
 
static const OdGeVector2d * asVector2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix2d * asMatrix2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix3d * asMatrix3d (const OdIfcEntity *pEnt)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcEntity > pEnt)
 
static const OdCmEntityColor * asRgbColor (const OdIfcEntity *pEnt)
 

Detailed Description

Definition at line 42 of file Ifc2x3/IfcConstraintAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcConstraint()

OdIfc2x3::IfcConstraint::IfcConstraint ( )

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcConstraint::comparedToEarlyImpl ( const OdDAI::ApplicationInstance *  pOther,
OdRx::Ordering &  ordering 
) const
virtual

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 OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ creatingActor()

IfcActorSelect OdIfc2x3::IfcConstraint::creatingActor ( )

◆ creationTime()

IfcDateTimeSelect OdIfc2x3::IfcConstraint::creationTime ( )

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcConstraint::getAttr ( const char *  attrName) const
virtual

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 OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcConstraint::getAttr ( const OdIfc::OdIfcAttribute  attrDef) const
virtual

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::OdIfcEntity.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ getConstraintGrade()

IfcConstraintEnum OdIfc2x3::IfcConstraint::getConstraintGrade ( ) const

◆ getConstraintSource()

const OdAnsiString & OdIfc2x3::IfcConstraint::getConstraintSource ( ) const

◆ getDescription()

const OdAnsiString & OdIfc2x3::IfcConstraint::getDescription ( ) const

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcConstraint::getInstanceType ( ) const
virtual

Returns a type of a class instance.

Returns
Pointer to the <link OdDAI__Entity, OdDAI::Entity> type that determines an entity definition within a schema.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ getInvAggregates()

void OdIfc2x3::IfcConstraint::getInvAggregates ( OdDAIObjectIds &  Aggregates) const

◆ getInvClassifiedAs()

void OdIfc2x3::IfcConstraint::getInvClassifiedAs ( OdDAIObjectIds &  ClassifiedAs) const

◆ getInvIsAggregatedIn()

void OdIfc2x3::IfcConstraint::getInvIsAggregatedIn ( OdDAIObjectIds &  IsAggregatedIn) const

◆ getInvIsRelatedWith()

void OdIfc2x3::IfcConstraint::getInvIsRelatedWith ( OdDAIObjectIds &  IsRelatedWith) const

◆ getInvPropertiesForConstraint()

void OdIfc2x3::IfcConstraint::getInvPropertiesForConstraint ( OdDAIObjectIds &  PropertiesForConstraint) const

◆ getInvRelatesConstraints()

void OdIfc2x3::IfcConstraint::getInvRelatesConstraints ( OdDAIObjectIds &  RelatesConstraints) const

◆ getName()

const OdAnsiString & OdIfc2x3::IfcConstraint::getName ( ) const

◆ getUserDefinedGrade()

const OdAnsiString & OdIfc2x3::IfcConstraint::getUserDefinedGrade ( ) const

◆ inFields()

virtual OdResult OdIfc2x3::IfcConstraint::inFields ( OdDAI::OdSpfFilerBase *  rdFiler)
virtual

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 OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ isKindOf()

virtual bool OdIfc2x3::IfcConstraint::isKindOf ( OdIfc::OdIfcEntityType  entityType) const
virtual

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::OdIfcEntity.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ outFields()

virtual OdResult OdIfc2x3::IfcConstraint::outFields ( OdDAI::OdSpfFilerBase *  wrFiler)
virtual

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 OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcConstraint::putAttr ( const char *  explicitAttrName,
const OdRxValue &  val 
)
virtual

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::OdIfcEntity.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcConstraint::putAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef,
const OdRxValue &  val 
)
virtual

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::OdIfcEntity.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ setConstraintGrade()

void OdIfc2x3::IfcConstraint::setConstraintGrade ( IfcConstraintEnum  ConstraintGrade)

◆ setConstraintSource()

void OdIfc2x3::IfcConstraint::setConstraintSource ( const OdAnsiString &  ConstraintSource)

◆ setDescription()

void OdIfc2x3::IfcConstraint::setDescription ( const OdAnsiString &  Description)

◆ setName()

void OdIfc2x3::IfcConstraint::setName ( const OdAnsiString &  Name)

◆ setUserDefinedGrade()

void OdIfc2x3::IfcConstraint::setUserDefinedGrade ( const OdAnsiString &  UserDefinedGrade)

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcConstraint::testAttr ( const char *  explicitAttrName) const
virtual

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::OdIfcEntity.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcConstraint::testAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef) const
virtual

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::OdIfcEntity.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcConstraint::type ( ) const
virtual

Returns the type of this entity.

Returns
A value of the <link OdIfc__OdIfcEntityType, OdIfc::OdIfcEntityType> type that represents type of this entity.

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ unsetAttr() [1/2]

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

Resets a value for the specified attribute.

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

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcConstraint::unsetAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef)
virtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x3::IfcMetric, and OdIfc2x3::IfcObjective.

Friends And Related Function Documentation

◆ IfcConstraintAggregationRelationship

IfcConstraintAggregationRelationship
friend

Definition at line 212 of file Ifc2x3/IfcConstraintAutoImpl.h.

◆ IfcConstraintClassificationRelationship

friend class IfcConstraintClassificationRelationship
friend

Definition at line 208 of file Ifc2x3/IfcConstraintAutoImpl.h.

◆ IfcConstraintRelationship

IfcConstraintRelationship
friend

Definition at line 209 of file Ifc2x3/IfcConstraintAutoImpl.h.

◆ IfcPropertyConstraintRelationship

friend class IfcPropertyConstraintRelationship
friend

Definition at line 211 of file Ifc2x3/IfcConstraintAutoImpl.h.

Member Data Documentation

◆ m_ConstraintGrade

OdDAI::Enum OdIfc2x3::IfcConstraint::m_ConstraintGrade
protected

Definition at line 201 of file Ifc2x3/IfcConstraintAutoImpl.h.

◆ m_ConstraintSource

OdAnsiString OdIfc2x3::IfcConstraint::m_ConstraintSource
protected

Definition at line 202 of file Ifc2x3/IfcConstraintAutoImpl.h.

◆ m_CreatingActor

OdDAI::Select OdIfc2x3::IfcConstraint::m_CreatingActor
protected

Definition at line 203 of file Ifc2x3/IfcConstraintAutoImpl.h.

◆ m_CreationTime

OdDAI::Select OdIfc2x3::IfcConstraint::m_CreationTime
protected

Definition at line 204 of file Ifc2x3/IfcConstraintAutoImpl.h.

◆ m_Description

OdAnsiString OdIfc2x3::IfcConstraint::m_Description
protected

Definition at line 200 of file Ifc2x3/IfcConstraintAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc2x3::IfcConstraint::m_Name
protected

Definition at line 199 of file Ifc2x3/IfcConstraintAutoImpl.h.

◆ m_UserDefinedGrade

OdAnsiString OdIfc2x3::IfcConstraint::m_UserDefinedGrade
protected

Definition at line 205 of file Ifc2x3/IfcConstraintAutoImpl.h.

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:35:51