#include <IfcBuildingElementProxyAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcBuildingElementProxy:

Public Member Functions
IfcElementCompositionEnum	getCompositionType () const

void	setCompositionType (IfcElementCompositionEnum CompositionType)

	IfcBuildingElementProxy ()

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 OdIfc2x3::IfcElement
const OdAnsiString &	getTag () const

void	setTag (const OdAnsiString &Tag)

void	getInvHasStructuralMember (OdDAIObjectIds &HasStructuralMember) const

void	getInvFillsVoids (OdDAIObjectIds &FillsVoids) const

void	getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const

void	getInvHasCoverings (OdDAIObjectIds &HasCoverings) const

void	getInvHasProjections (OdDAIObjectIds &HasProjections) const

void	getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const

void	getInvHasPorts (OdDAIObjectIds &HasPorts) const

void	getInvHasOpenings (OdDAIObjectIds &HasOpenings) const

void	getInvIsConnectionRealization (OdDAIObjectIds &IsConnectionRealization) const

void	getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const

void	getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const

void	getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const

	IfcElement ()

Public Member Functions inherited from OdIfc2x3::IfcProduct
const OdDAIObjectId &	getObjectPlacement () const

void	setObjectPlacement (const OdDAIObjectId &ObjectPlacement)

const OdDAIObjectId &	getRepresentation () const

void	setRepresentation (const OdDAIObjectId &Representation)

void	getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const

virtual void	setInverseCounterParts () override

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

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

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

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc2x3::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 OdIfc2x3::OdIfc2x3Instance
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_CompositionType

Protected Attributes inherited from OdIfc2x3::IfcElement
OdAnsiString	m_Tag

Protected Attributes inherited from OdIfc2x3::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc2x3::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc2x3::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

The IfcBuildingElementProxy is a proxy definition that provides the same functionality as subtypes of IfcBuildingElement, but without having a predefined meaning of the special type of building element, it represents. Proxies can also be used as spatial place holders or provisions, that are later replaced by special types of elements.

One use of the proxy object is a provision for voids, i.e. where a particular volume of space is requested by an engineering function that might later be accepted or rejected. If accepted it is transformed into a void within a building element, like a wall opening, or a slab opening. The provision for voids is exchanged as an IfcBuildingElementProxy with the PredefinedType = ProvisionForVoid. Such proxy has a swept solid geometry, where the profile of the swept solid lies on/near the surface of the referred building element and the extrusion depths is equal to or bigger then (in case of round or otherwise irregular element shape) the thickness of the building element. The appropriate property set should be attached.

In addition to the provision for voids, the building element proxy can also represent a provision for space, often the necessary space allocation for mechanical equipment that will be determined in a later design phase. The provision for space is exchanged as an IfcBuildingElementProxy with the PredefinedType = ProvisionForSpace.

Other usages of IfcBuildingElementProxy include: The IfcBuildingElementProxy can be used to exchange special types of building elements for which the current specification does not yet provide a semantic definition The IfcBuildingElementProxy can also be used to represent building elements for which the participating applications can not provide a semantic definition

Object Typing - The IfcBuildingElementProxyType can be used to share common information among many occurrences of the same proxy without establishing a particular semantic meaning of the type. If no IfcBuildingElementProxyType is attached (i.e. if only occurrence information is available) the PredefinedType should be provided. If set to .USERDEFINED. a user defined value has to be provided by the ObjectType attribute. This concept can be applied to the following resources: IfcBuildingElementProxyType
Property Sets for Objects - This concept can be applied to the following resources: Pset_ConcreteElementGeneral Pset_PrecastConcreteElementFabrication Pset_PrecastConcreteElementGeneral Pset_BuildingElementProxyCommon Pset_ProvisionForVoid (only applies to PROVISIONFORVOID)
Quantity Sets - This concept can be applied to the following resources: Qto_BuildingElementProxyQuantities
Spatial Containment - The IfcBuildingElementProxy, as any subtype of IfcBuildingElement, can participate alternatively in one of the two different containment relationships: the Spatial Containment (defined here) the Element Composition

Definition at line 84 of file Ifc2x3/IfcBuildingElementProxyAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcBuildingElementProxy()

OdIfc2x3::IfcBuildingElementProxy::IfcBuildingElementProxy ( )

Default constructor for the IfcBuildingElementProxy class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcBuildingElement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcElement.

◆ getCompositionType()

IfcElementCompositionEnum OdIfc2x3::IfcBuildingElementProxy::getCompositionType ( ) const

Returns the value of CompositionType attribute. This attribute indicates whether the proxy is intended to form an aggregation (COMPLEX), an integral element (ELEMENT), or a part in an aggregation (PARTIAL).

Returns: Returns the value of CompositionType attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcBuildingElement.

◆ inFields()

virtual OdResult OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcElement.

◆ isKindOf()

virtual bool OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcBuildingElement.

◆ outFields()

virtual OdResult OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcElement.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcElement.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcElement.

◆ setCompositionType()

void OdIfc2x3::IfcBuildingElementProxy::setCompositionType ( IfcElementCompositionEnum CompositionType )

Sets the value of CompositionType attribute. This attribute indicates whether the proxy is intended to form an aggregation (COMPLEX), an integral element (ELEMENT), or a part in an aggregation (PARTIAL).

Parameters

CompositionType [in] Composition type to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcElement.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcBuildingElement.

◆ unsetAttr() [1/2]

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

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc2x3::IfcElement.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcBuildingElementProxy::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 OdIfc2x3::IfcElement.

Member Data Documentation

◆ m_CompositionType

OdDAI::Enum OdIfc2x3::IfcBuildingElementProxy::m_CompositionType

protected

Definition at line 244 of file Ifc2x3/IfcBuildingElementProxyAutoImpl.h.

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

Ifc2x3/IfcBuildingElementProxyAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcBuildingElementProxy()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getCompositionType()

◆ getInstanceType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setCompositionType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_CompositionType