#include <IfcVirtualElementAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcVirtualElement:

Public Member Functions
IfcVirtualElementTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcVirtualElementTypeEnum PredefinedType)

	IfcVirtualElement ()

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

void	setTag (const OdAnsiString &Tag)

void	getInvFillsVoids (OdDAIObjectIds &FillsVoids) const

void	getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const

void	getInvIsInterferedByElements (OdDAIObjectIds &IsInterferedByElements) const

void	getInvInterferesElements (OdDAIObjectIds &InterferesElements) const

void	getInvHasProjections (OdDAIObjectIds &HasProjections) 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

void	getInvHasCoverings (OdDAIObjectIds &HasCoverings) const

void	getInvHasSurfaceFeatures (OdDAIObjectIds &HasSurfaceFeatures) const

	IfcElement ()

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

void	setObjectPlacement (const OdDAIObjectId &ObjectPlacement)

const OdDAIObjectId &	getRepresentation () const

void	setRepresentation (const OdDAIObjectId &Representation)

void	getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const

void	getInvPositionedRelativeTo (OdDAIObjectIds &PositionedRelativeTo) const

void	getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const

virtual void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::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 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 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

Protected Attributes inherited from OdIfc4x4::IfcElement
OdAnsiString	m_Tag

Protected Attributes inherited from OdIfc4x4::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc4x4::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4x4::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 virtual element is a special element used to provide imaginary boundaries, such as between two adjacent, but not separated, spaces.

Details - Virtual elements are usually not displayed and does not have quantities and other measures. Therefore IfcVirtualElement does not have material information and quantities attached.

Uses of IfcVirtualElement include: An imaginary boundary such as between two adjacent, but not separated, spaces. The IfcVirtualElement can provide the 2D curve or 3D surface representation of the virtual space connection and is referenced by two instances of IfcRelSpaceBoundary, each pointing to one of the two adjacent IfcSpaces. The boundary is exchanged using PredefinedType = BOUNDARY. A provision for voids. Such as 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 using the PredefinedType = PROVISIONFORVOID. Typically, it uses 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 than (in case of round or otherwise irregular element shape) the thickness of the building element. The appropriate Pset_ProvisionForVoid property set should be attached. A clearance space. Typically, a placeholder for the necessary space allocation for future designed elements, such as mechanical equipment that will be determined in a later design phase. The clearance is exchanged using the PredefinedType = CLEARANCE.

The image below describes how to use IfcRelSpaceBoundary in conjunction with IfcVirtualElement to define space boundaries.

\changes

IFC4X3 changes: Virtual elements can now be used for void provisions and clearance to replace existing functionality on IfcBuildingElementProxy.

Definition at line 69 of file IFC4X4/IfcVirtualElementAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcVirtualElement()

OdIfc4x4::IfcVirtualElement::IfcVirtualElement ( )

Default constructor for the IfcVirtualElement class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcVirtualElement::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 OdIfc4x4::IfcElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcVirtualElement::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 OdIfc4x4::IfcElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcVirtualElement::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 OdIfc4x4::IfcElement.

◆ getPredefinedType()

IfcVirtualElementTypeEnum OdIfc4x4::IfcVirtualElement::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents a list of types to further identify the object. Some property sets can be specifically applicable to one of these types.

Returns: Returns the value of PredefinedType attribute.

Remarks: If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not used.

◆ inFields()

virtual OdResult OdIfc4x4::IfcVirtualElement::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 OdIfc4x4::IfcElement.

◆ isKindOf()

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

◆ outFields()

virtual OdResult OdIfc4x4::IfcVirtualElement::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 OdIfc4x4::IfcElement.

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setPredefinedType()

void OdIfc4x4::IfcVirtualElement::setPredefinedType ( IfcVirtualElementTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents a list of types to further identify the object. Some property sets can be specifically applicable to one of these types.

Parameters

PredefinedType [in] Predefined type to set.

Remarks: If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not used.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcVirtualElement::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 OdIfc4x4::IfcElement.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcVirtualElement::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x4::IfcElement.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcVirtualElement::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 OdIfc4x4::IfcElement.

Member Data Documentation

◆ m_PredefinedType

OdDAI::Enum OdIfc4x4::IfcVirtualElement::m_PredefinedType

protected

Definition at line 233 of file IFC4X4/IfcVirtualElementAutoImpl.h.

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

IFC4X4/IfcVirtualElementAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcVirtualElement()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getPredefinedType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setPredefinedType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_PredefinedType