#include <IfcPermitAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcPermit:

Public Member Functions
IfcPermitTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcPermitTypeEnum PredefinedType)

const OdAnsiString &	getStatus () const

void	setStatus (const OdAnsiString &Status)

const OdAnsiString &	getLongDescription () const

void	setLongDescription (const OdAnsiString &LongDescription)

	IfcPermit ()

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::IfcControl
const OdAnsiString &	getIdentification () const

void	setIdentification (const OdAnsiString &Identification)

void	getInvControls (OdDAIObjectIds &Controls) const

	IfcControl ()

Public Member Functions inherited from OdIfc4x2::IfcObject
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const

void	getInvDeclares (OdDAIObjectIds &Declares) const

void	getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

Public Member Functions inherited from OdIfc4x2::IfcObjectDefinition
void	getInvHasAssignments (OdDAIObjectIds &HasAssignments) const

void	getInvNests (OdDAIObjectIds &Nests) const

void	getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const

void	getInvHasContext (OdDAIObjectIds &HasContext) const

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc4x2::IfcRoot
OdDAI::CompressedGUID	getGlobalId () const

void	setGlobalId (OdDAI::CompressedGUID GlobalId)

const OdDAIObjectId &	getOwnerHistory () const

void	setOwnerHistory (const OdDAIObjectId &OwnerHistory)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

	IfcRoot ()

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
OdDAI::Enum	m_PredefinedType

OdAnsiString	m_Status

OdAnsiString	m_LongDescription

Protected Attributes inherited from OdIfc4x2::IfcControl
OdAnsiString	m_Identification

Protected Attributes inherited from OdIfc4x2::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4x2::IfcRoot
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

OdAnsiString	m_Name

OdAnsiString	m_Description

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

A permit is a permission to perform work in places and on artifacts where regulatory, security or other access restrictions apply.

Approval - Approvals can be associated to indicate the status of acceptance or rejection using the IfcRelAssociatesApproval relationship where RelatingApproval refers to an IfcApproval and RelatedObjects contains the IfcPermit. Approvals can be split into sub-approvals using IfcApprovalRelationship to track approval status separately for each party where RelatingApproval refers to the higher-level approval and RelatedApprovals contains one or more lower-level approvals. The hierarchy of approvals implies sequencing such that a higher-level approval is not executed until all of its lower-level approvals have been accepted.
Property Sets for Objects - The Property Sets for Objects concept template applies to this entity under Pset_Permit name as shown in table below:

Template

PropertyName Value Single Value EscortRequirement IfcBoolean Single Value StartDate IfcDateTime Single Value EndDate IfcDateTime Single Value SpecialRequirements IfcText

Nesting - The Object Nesting concept template applies to this entity as shown in the table below:

Type

Description IfcPermit A permit can be nested to indicate permit amendments, in order of issue

Control Assignment - The figure below illustrates assignment relationships as indicated: IfcActor (IfcRelAssignsToActor): Organization issuing the permit such as a local government agency or security organization. <IMAGE ifcpermit-assignment>

The IfcPermit can have assignments of its own using the IfcRelAssignsToControl relationship where RelatingControl refers to the IfcPermit and RelatedObjects contains one or more objects of the following types: IfcActor: Organization(s) bound to the permit, typically a single contractor.

\changes

IFC4 changes: Attribute PermitID renamed to Identification and promoted to supertype IfcControl.

Definition at line 79 of file Ifc4x2/IfcPermitAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPermit()

OdIfc4x2::IfcPermit::IfcPermit ( )

Default constructor for the IfcPermit class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcPermit::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::IfcControl.

◆ getLongDescription()

const OdAnsiString & OdIfc4x2::IfcPermit::getLongDescription ( ) const

Returns the value of LongDescription attribute. This attribute represents detailed description of the request.

Returns: Returns the value of LongDescription attribute.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ getPredefinedType()

IfcPermitTypeEnum OdIfc4x2::IfcPermit::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents the predefined types of permit that can be granted.

Returns: Returns the value of PredefinedType attribute.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ getStatus()

const OdAnsiString & OdIfc4x2::IfcPermit::getStatus ( ) const

Returns the value of Status attribute. This attribute represents the status currently assigned to the permit.

Returns: Returns the value of Status attribute.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ inFields()

virtual OdResult OdIfc4x2::IfcPermit::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::IfcControl.

◆ isKindOf()

virtual bool OdIfc4x2::IfcPermit::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::IfcControl.

◆ outFields()

virtual OdResult OdIfc4x2::IfcPermit::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::IfcControl.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcPermit::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 OdIfc4x2::IfcControl.

◆ putAttr() [2/2]

virtual bool OdIfc4x2::IfcPermit::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::IfcControl.

◆ setLongDescription()

void OdIfc4x2::IfcPermit::setLongDescription ( const OdAnsiString & LongDescription )

Sets the value of LongDescription attribute. This attribute represents detailed description of the request.

Parameters

LongDescription [in] Long description to set.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ setPredefinedType()

void OdIfc4x2::IfcPermit::setPredefinedType ( IfcPermitTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents the predefined types of permit that can be granted.

Parameters

PredefinedType [in] Predefined type to set.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ setStatus()

void OdIfc4x2::IfcPermit::setStatus ( const OdAnsiString & Status )

Sets the value of Status attribute. This attribute represents the status currently assigned to the permit.

Parameters

Status [in] Status to set.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcPermit::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::IfcControl.

◆ testAttr() [2/2]

virtual bool OdIfc4x2::IfcPermit::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::IfcControl.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x2::IfcPermit::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::IfcControl.

◆ unsetAttr() [1/2]

virtual void OdIfc4x2::IfcPermit::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::IfcControl.

◆ unsetAttr() [2/2]

virtual void OdIfc4x2::IfcPermit::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::IfcControl.

Member Data Documentation

◆ m_LongDescription

OdAnsiString OdIfc4x2::IfcPermit::m_LongDescription

protected

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

◆ m_PredefinedType

OdDAI::Enum OdIfc4x2::IfcPermit::m_PredefinedType

protected

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

◆ m_Status

OdAnsiString OdIfc4x2::IfcPermit::m_Status

protected

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

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

Ifc4x2/IfcPermitAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcPermit()

Member Function Documentation

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getLongDescription()

◆ getPredefinedType()

◆ getStatus()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setLongDescription()

◆ setPredefinedType()

◆ setStatus()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_LongDescription

◆ m_PredefinedType

◆ m_Status