CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x2_final::IfcSpaceProgram Class Reference

#include <IfcSpaceProgramAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcSpaceProgram:
OdIfc2x2_final::IfcControl OdIfc2x2_final::IfcObject OdIfc2x2_final::IfcRoot OdIfc2x2_final::OdIfc2x2_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getSpaceProgramIdentifier () const
 
void setSpaceProgramIdentifier (const OdAnsiString &SpaceProgramIdentifier)
 
double getMaxRequiredArea () const
 
void setMaxRequiredArea (double MaxRequiredArea)
 
double getMinRequiredArea () const
 
void setMinRequiredArea (double MinRequiredArea)
 
const OdDAIObjectId & getRequestedLocation () const
 
void setRequestedLocation (const OdDAIObjectId &RequestedLocation)
 
double getStandardRequiredArea () const
 
void setStandardRequiredArea (double StandardRequiredArea)
 
void getInvHasInteractionReqsFrom (OdDAIObjectIds &HasInteractionReqsFrom) const
 
void getInvHasInteractionReqsTo (OdDAIObjectIds &HasInteractionReqsTo) const
 
 IfcSpaceProgram ()
 
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 OdIfc2x2_final::IfcControl
void getInvControls (OdDAIObjectIds &Controls) const
 
- Public Member Functions inherited from OdIfc2x2_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x2_final::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 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdAnsiString m_SpaceProgramIdentifier
 
double m_MaxRequiredArea
 
double m_MinRequiredArea
 
OdDAIObjectId m_RequestedLocation
 
double m_StandardRequiredArea
 
- Protected Attributes inherited from OdIfc2x2_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x2_final::IfcRoot
OdDAI::CompressedGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcRelInteractionRequirements
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

Architectural program for a space in the building or facility is designed, essentially the requirements definition for such a building space. The assignment of a person or an organization to a space program, e.g. is handled through using the objectified relationship IfcRelAssignsToActor referring to IfcActor. Space programs can be nested, i.e. an IfcSpaceProgram can specify a program group up to any desired level. This is handled through using the objectified relationship IfcRelNests.

Definition at line 45 of file Ifc2x2_Final/IfcSpaceProgramAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSpaceProgram()

OdIfc2x2_final::IfcSpaceProgram::IfcSpaceProgram ( )

Default constructor for the IfcSpaceProgram class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ getInvHasInteractionReqsFrom()

void OdIfc2x2_final::IfcSpaceProgram::getInvHasInteractionReqsFrom ( OdDAIObjectIds & HasInteractionReqsFrom) const

Returns the value of HasInteractionReqsFrom attribute. This attribute represents the set of inverse relationships to space or work interaction requirement objects.

Returns
Returns the value of HasInteractionReqsFrom attribute.

◆ getInvHasInteractionReqsTo()

void OdIfc2x2_final::IfcSpaceProgram::getInvHasInteractionReqsTo ( OdDAIObjectIds & HasInteractionReqsTo) const

Returns the value of HasInteractionReqsTo attribute. This attribute represents the set of inverse relationships to space or work interaction requirements.

Returns
Returns the value of HasInteractionReqsTo attribute.

◆ getMaxRequiredArea()

double OdIfc2x2_final::IfcSpaceProgram::getMaxRequiredArea ( ) const

Returns the value of MaxRequiredArea attribute. This attribute represents the the maximum floor area programmed for this space (according to client requirements).

Returns
Returns the value of MaxRequiredArea attribute.

◆ getMinRequiredArea()

double OdIfc2x2_final::IfcSpaceProgram::getMinRequiredArea ( ) const

Returns the value of MinRequiredArea attribute. This attribute represents the minimum floor area programmed for this space (according to client requirements).

Returns
Returns the value of MinRequiredArea attribute.

◆ getRequestedLocation()

const OdDAIObjectId & OdIfc2x2_final::IfcSpaceProgram::getRequestedLocation ( ) const

Returns the value of RequestedLocation attribute. This attribute represents the location within the building structure, requested for the space.

Returns
Returns the value of RequestedLocation attribute.

◆ getSpaceProgramIdentifier()

const OdAnsiString & OdIfc2x2_final::IfcSpaceProgram::getSpaceProgramIdentifier ( ) const

Returns the value of SpaceProgramIdentifier attribute. This attribute represents the identifier for this space program. It often refers to a number (or code) assigned to the space program. Example: R-001.

Returns
Returns the value of SpaceProgramIdentifier attribute.

◆ getStandardRequiredArea()

double OdIfc2x2_final::IfcSpaceProgram::getStandardRequiredArea ( ) const

Returns the value of StandardRequiredArea attribute. This attribute represents the floor area programmed for this space (according to client requirements).

Returns
Returns the value of StandardRequiredArea attribute.

◆ inFields()

virtual OdResult OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ isKindOf()

virtual bool OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ outFields()

virtual OdResult OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ putAttr() [1/2]

virtual bool OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ putAttr() [2/2]

virtual bool OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ setMaxRequiredArea()

void OdIfc2x2_final::IfcSpaceProgram::setMaxRequiredArea ( double MaxRequiredArea)

Sets the value of MaxRequiredArea attribute. This attribute represents the the maximum floor area programmed for this space (according to client requirements).

Parameters
MaxRequiredArea[in] MaxRequiredArea attribute to set.

◆ setMinRequiredArea()

void OdIfc2x2_final::IfcSpaceProgram::setMinRequiredArea ( double MinRequiredArea)

Sets the value of MinRequiredArea attribute. This attribute represents the minimum floor area programmed for this space (according to client requirements).

Parameters
MinRequiredArea[in] MinRequiredArea attribute to set.

◆ setRequestedLocation()

void OdIfc2x2_final::IfcSpaceProgram::setRequestedLocation ( const OdDAIObjectId & RequestedLocation)

Sets the value of RequestedLocation attribute. This attribute represents the location within the building structure, requested for the space.

Parameters
RequestedLocation[in] RequestedLocation attribute to set.

◆ setSpaceProgramIdentifier()

void OdIfc2x2_final::IfcSpaceProgram::setSpaceProgramIdentifier ( const OdAnsiString & SpaceProgramIdentifier)

Sets the value of SpaceProgramIdentifier attribute. This attribute represents the identifier for this space program. It often refers to a number (or code) assigned to the space program. Example: R-001.

Parameters
SpaceProgramIdentifier[in] SpaceProgramIdentifier attribute to set.

◆ setStandardRequiredArea()

void OdIfc2x2_final::IfcSpaceProgram::setStandardRequiredArea ( double StandardRequiredArea)

Sets the value of StandardRequiredArea attribute. This attribute represents the floor area programmed for this space (according to client requirements).

Parameters
StandardRequiredArea[in] StandardRequiredArea attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ testAttr() [2/2]

virtual bool OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

◆ unsetAttr() [1/2]

virtual void OdIfc2x2_final::IfcSpaceProgram::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x2_final::IfcControl.

◆ unsetAttr() [2/2]

virtual void OdIfc2x2_final::IfcSpaceProgram::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 OdIfc2x2_final::IfcControl.

Friends And Related Symbol Documentation

◆ IfcRelInteractionRequirements

Member Data Documentation

◆ m_MaxRequiredArea

double OdIfc2x2_final::IfcSpaceProgram::m_MaxRequiredArea
protected

Definition at line 263 of file Ifc2x2_Final/IfcSpaceProgramAutoImpl.h.

◆ m_MinRequiredArea

double OdIfc2x2_final::IfcSpaceProgram::m_MinRequiredArea
protected

Definition at line 264 of file Ifc2x2_Final/IfcSpaceProgramAutoImpl.h.

◆ m_RequestedLocation

OdDAIObjectId OdIfc2x2_final::IfcSpaceProgram::m_RequestedLocation
protected

Definition at line 265 of file Ifc2x2_Final/IfcSpaceProgramAutoImpl.h.

◆ m_SpaceProgramIdentifier

OdAnsiString OdIfc2x2_final::IfcSpaceProgram::m_SpaceProgramIdentifier
protected

Definition at line 262 of file Ifc2x2_Final/IfcSpaceProgramAutoImpl.h.

◆ m_StandardRequiredArea

double OdIfc2x2_final::IfcSpaceProgram::m_StandardRequiredArea
protected

Definition at line 266 of file Ifc2x2_Final/IfcSpaceProgramAutoImpl.h.


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