#include <IfcConstraintAutoImpl.h>

Inheritance diagram for OdIfc4::IfcConstraint:

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 ()

const OdAnsiString &	getCreationTime () const

void	setCreationTime (const OdAnsiString &CreationTime)

const OdAnsiString &	getUserDefinedGrade () const

void	setUserDefinedGrade (const OdAnsiString &UserDefinedGrade)

void	getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) const

void	getInvPropertiesForConstraint (OdDAIObjectIds &PropertiesForConstraint) const

	IfcConstraint ()

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 OdIfc4::OdIfc4Instance
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
OdAnsiString	m_Name

OdAnsiString	m_Description

OdDAI::Enum	m_ConstraintGrade

OdAnsiString	m_ConstraintSource

OdDAI::Select	m_CreatingActor

OdAnsiString	m_CreationTime

OdAnsiString	m_UserDefinedGrade

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcExternalReferenceRelationship

class	IfcResourceConstraintRelationship

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 IfcConstraint is used to define a constraint or limiting value or boundary condition that can be applied to an object or to the value of a property.

Constraints can be subdivided into user-defined constraints and system-defined constraints. User-defined constraints are applied by a user and are restricted to high-level definitions such as object properties. System-defined constraints can apply to any object attribute, are typically defined by an application to enforce data validation or parametric behavior, and are intended to be enforced by applications but not to be directly editable by an end-user.

Remarks: This definition may not be instantiated.

\changes

IFC4 changes: Type of the CreationTime attribute changed from "IfcDateTimeSelect" to "IfcDateTime" Inverse attribute ClassifiedAs renamed to HasExternalReferences Type of the ClassifiedAs inverse attribute changed from "SET OF [0:?] IfcConstraintClassificationRelationship FOR ClassifiedConstraint" to "SET OF [0:?] IfcExternalReferenceRelationship FOR RelatedResourceObjects" Inverse attribute RelatesConstraints to PropertiesForConstraint Type of the inverse attribute RelatesConstraints changed from "SET OF [0:?] IfcConstraintRelationship FOR RelatingConstraint" to "SET OF [0:?] IfcResourceConstraintRelationship FOR RelatingConstraint"

Definition at line 63 of file Ifc4/IfcConstraintAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcConstraint()

OdIfc4::IfcConstraint::IfcConstraint ( )

Default constructor for the IfcConstraint class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ creatingActor()

IfcActorSelect OdIfc4::IfcConstraint::creatingActor ( )

Returns the value of CreatingActor attribute. This attribute represents person and/or organization that has created the constraint.

Returns: Returns the value of CreatingActor attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ getConstraintGrade()

IfcConstraintEnum OdIfc4::IfcConstraint::getConstraintGrade ( ) const

Returns the value of ConstraintGrade attribute. This attribute represents enumeration that qualifies the type of constraint.

Returns: Returns the value of ConstraintGrade attribute.

◆ getConstraintSource()

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

Returns the value of ConstraintSource attribute. This attribute represents any source material, such as a code or standard, from which the constraint originated.

Returns: Returns the value of ConstraintSource attribute.

◆ getCreationTime()

const OdAnsiString & OdIfc4::IfcConstraint::getCreationTime ( ) const

Returns the value of CreationTime attribute. This attribute represents time when information specifying the constraint instance was created.

Returns: Returns the value of CreationTime attribute.

◆ getDescription()

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

Returns the value of Description attribute. This attribute represents a human-readable description that can apply additional information about a constraint.

Returns: Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ getInvHasExternalReferences()

void OdIfc4::IfcConstraint::getInvHasExternalReferences ( OdDAIObjectIds & HasExternalReferences ) const

Returns the value of HasExternalReferences attribute. This attribute represents reference to an external references, e.g. library, classification, or document information, that are associated to the constraint.

Parameters

HasExternalReferences [out] Receives the value of HasExternalReferences attribute.

◆ getInvPropertiesForConstraint()

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

Returns the value of PropertiesForConstraint attribute. This attribute represents reference to the properties to which the constraint is applied.

Parameters

PropertiesForConstraint [out] Receives the value of PropertiesForConstraint attribute.

◆ getName()

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

Returns the value of Name attribute. This attribute represents a human-readable name that is used for the constraint.

Returns: Returns the value of Name attribute.

◆ getUserDefinedGrade()

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

Returns the value of UserDefinedGrade attribute. This attribute allows specification of user-defined grade of the constraint beyond the enumeration values provided by ConstraintGrade attribute of type IfcConstraintEnum. When a value is provided for attribute UserDefinedGrade in parallel the attribute ConstraintGrade has enumeration value USERDEFINED.

Returns: Returns the value of UserDefinedGrade attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ isKindOf()

virtual bool OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ outFields()

virtual OdResult OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ setConstraintGrade()

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

Sets the value of ConstraintGrade attribute. This attribute represents enumeration that qualifies the type of constraint.

Parameters

ConstraintGrade [in] Constraint grade to set.

◆ setConstraintSource()

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

Sets the value of ConstraintSource attribute. This attribute represents any source material, such as a code or standard, from which the constraint originated.

Parameters

ConstraintSource [in] Constraint source to set.

◆ setCreationTime()

void OdIfc4::IfcConstraint::setCreationTime ( const OdAnsiString & CreationTime )

Sets the value of CreationTime attribute. This attribute represents time when information specifying the constraint instance was created.

Parameters

CreationTime [in] Creation time to set.

◆ setDescription()

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

Sets the value of Description attribute. This attribute represents a human-readable description that can apply additional information about a constraint.

Parameters

Description [in] Description to set.

◆ setName()

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

Sets the value of Name attribute. This attribute represents a human-readable name that is used for the constraint.

Parameters

Name	[in] Name to set.

◆ setUserDefinedGrade()

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

Sets the value of UserDefinedGrade attribute. This attribute allows specification of user-defined grade of the constraint beyond the enumeration values provided by ConstraintGrade attribute of type IfcConstraintEnum. When a value is provided for attribute UserDefinedGrade in parallel the attribute ConstraintGrade has enumeration value USERDEFINED.

Parameters

UserDefinedGrade [in] User-defined grade to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcConstraint::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 OdIfc4::IfcMetric, and OdIfc4::IfcObjective.