CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4::IfcGrid Class Reference

#include <IfcGridAutoImpl.h>

Inheritance diagram for OdIfc4::IfcGrid:
OdIfc4::IfcProduct OdIfc4::IfcObject OdIfc4::IfcObjectDefinition OdIfc4::IfcRoot OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance

Public Member Functions

void getUAxes (OdDAIObjectIds &UAxes) const
 
OdDAI::ListOfOdDAIObjectId & uAxes ()
 
void getVAxes (OdDAIObjectIds &VAxes) const
 
OdDAI::ListOfOdDAIObjectId & vAxes ()
 
void getWAxes (OdDAIObjectIds &WAxes) const
 
OdDAI::ListOfOdDAIObjectId & wAxes ()
 
IfcGridTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcGridTypeEnum PredefinedType)
 
void getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const
 
 IfcGrid ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual void setInverseCounterParts () 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::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
- Public Member Functions inherited from OdIfc4::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 OdIfc4::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 OdIfc4::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 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAI::ListOfOdDAIObjectId m_UAxes
 
OdDAI::ListOfOdDAIObjectId m_VAxes
 
OdDAI::ListOfOdDAIObjectId m_WAxes
 
OdDAI::Enum m_PredefinedType
 
- Protected Attributes inherited from OdIfc4::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc4::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4::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 IfcRelContainedInSpatialStructure
 

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

IfcGrid is a planar design grid defined in 3D space used as an aid in locating structural and design elements. The position of the grid (ObjectPlacement) is defined by a 3D coordinate system (and thereby the design grid can be used in plan, section or in any position relative to the world coordinate system). The position can be relative to the object placement of other products or grids. The XY plane of the 3D coordinate system is used to place the grid axes, which are 2D curves (for example, line, circle, arc, polyline).

  • Example of Grid Layouts - Grid rectangular layout:

<IMAGE ifcdesigngrid-type1>

Grid radial layout:

<IMAGE ifcdesigngrid-type2>

Grid triangular layout:

<IMAGE ifcdesigngrid-type3>

  • FootPrint Geometry - The 2D geometric representation of IfcGrid is defined using the 'GeometricCurveSet' geometry. The following attribute values should be inserted: IfcShapeRepresentation.RepresentationIdentifier = 'FootPrint' IfcShapeRepresentation.RepresentationType = 'GeometricCurveSet'

The following constraints apply to the 2D representation: The IfcGeometricCurveSet is an (and the only) item of the IfcShapeRepresentation. It should contain an IfcGeometricCurveSet containing subtypes of IfcCurve, each representing a grid axis. Applicable subtypes of IfcCurve are: IfcPolyline, IfcCircle, IfcTrimmedCurve (based on BaseCurve referencing IfcLine or IfcCircle), and IfcOffsetCurve2D. Each subtype of IfcCurve can have a curve style assigned, using IfcStyledItem referencing IfcCurveStyle. Optionally the grid axis labels can be added as IfcTextLiteral, and they can have text styles assigned, using IfcStyledItem referencing IfcTextStyle.

<IMAGE ifcdesigngrid-layout1>

Definition at line 71 of file Ifc4/IfcGridAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcGrid()

OdIfc4::IfcGrid::IfcGrid ( )

Default constructor for the IfcGrid class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ getInvContainedInStructure()

void OdIfc4::IfcGrid::getInvContainedInStructure ( OdDAIObjectIds & ContainedInStructure) const

Returns the value of ContainedInStructure attribute. This attribute represents relationship to a spatial structure element to which the positioning element is primarily associated.

Parameters
ContainedInStructure[out] Receives the value of ContainedInStructure attribute.

◆ getPredefinedType()

IfcGridTypeEnum OdIfc4::IfcGrid::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined types to define the particular type of the grid.

Returns
Returns the value of PredefinedType attribute.

◆ getUAxes()

void OdIfc4::IfcGrid::getUAxes ( OdDAIObjectIds & UAxes) const

Gets the value of UAxes attribute. This attribute represents list of grid axes defining the first row of grid lines.

Parameters
UAxes[out] Receives the UAxes attribute.

◆ getVAxes()

void OdIfc4::IfcGrid::getVAxes ( OdDAIObjectIds & VAxes) const

Gets the value of VAxes attribute. This attribute represents list of grid axes defining the second row of grid lines.

Parameters
VAxes[out] Receives the VAxes attribute.

◆ getWAxes()

void OdIfc4::IfcGrid::getWAxes ( OdDAIObjectIds & WAxes) const

Gets the value of WAxes attribute. This attribute represents list of grid axes defining the third row of grid lines. It can be specified in the case of a triangular grid.

Parameters
WAxes[out] Receives the WAxes attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ isKindOf()

virtual bool OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ outFields()

virtual OdResult OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ setInverseCounterParts()

virtual void OdIfc4::IfcGrid::setInverseCounterParts ( )
overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

Reimplemented from OdIfc4::IfcProduct.

◆ setPredefinedType()

void OdIfc4::IfcGrid::setPredefinedType ( IfcGridTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents predefined types to define the particular type of the grid.

Parameters
PredefinedType[in] Predefined type to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ uAxes()

OdDAI::ListOfOdDAIObjectId & OdIfc4::IfcGrid::uAxes ( )

Returns the value of UAxes attribute. This attribute represents list of grid axes defining the first row of grid lines.

Returns
Returns the value of UAxes attribute.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcGrid::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4::IfcProduct.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcGrid::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 OdIfc4::IfcProduct.

◆ vAxes()

OdDAI::ListOfOdDAIObjectId & OdIfc4::IfcGrid::vAxes ( )

Returns the value of VAxes attribute. This attribute represents list of grid axes defining the second row of grid lines.

Returns
Returns the value of VAxes attribute.

◆ wAxes()

OdDAI::ListOfOdDAIObjectId & OdIfc4::IfcGrid::wAxes ( )

Returns the value of WAxes attribute. This attribute represents list of grid axes defining the third row of grid lines. It can be specified in the case of a triangular grid.

Returns
Returns the value of WAxes attribute.

Friends And Related Symbol Documentation

◆ IfcRelContainedInSpatialStructure

friend class IfcRelContainedInSpatialStructure
friend

Definition at line 295 of file Ifc4/IfcGridAutoImpl.h.

Member Data Documentation

◆ m_PredefinedType

OdDAI::Enum OdIfc4::IfcGrid::m_PredefinedType
protected

Definition at line 292 of file Ifc4/IfcGridAutoImpl.h.

◆ m_UAxes

OdDAI::ListOfOdDAIObjectId OdIfc4::IfcGrid::m_UAxes
protected

Definition at line 288 of file Ifc4/IfcGridAutoImpl.h.

◆ m_VAxes

OdDAI::ListOfOdDAIObjectId OdIfc4::IfcGrid::m_VAxes
protected

Definition at line 289 of file Ifc4/IfcGridAutoImpl.h.

◆ m_WAxes

OdDAI::ListOfOdDAIObjectId OdIfc4::IfcGrid::m_WAxes
protected

Definition at line 290 of file Ifc4/IfcGridAutoImpl.h.


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