#include <IfcAnnotationAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcAnnotation:

Public Member Functions
void	getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const

virtual OdResult	inFields (OdDAI::OdSpfFilerBase *rdFiler) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override

virtual OdDAI::Entity *	getInstanceType () 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	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::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 Member Functions
virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

Friends
class	IfcRelContainedInSpatialStructure

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)

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

Detailed Description

An annotation is an information element within the geometric (and spatial) context of a project, that adds a note or meaning to the objects which constitutes the project model. Annotations include additional points, curves, text, dimensioning, hatching and other forms of graphical notes. It also includes virtual or symbolic representations of additional model components, not representing products or spatial structures, such as event elements, survey points, contour lines or similar.

If available, the annotation should be related to the spatial context of the project, by containing the annotation within the appropriate level of the building structure (site, facility, facility part or building, storey, or space). This is handled by the IfcRelContainedInSpatialStructure relationship.

'Annotation point' is an annotation provided by a point that has additional semantic. The inherited attribute ObjectType should be used to capture the type of point annotation, some suggested values are: 'SurveyPoint': A single survey point represented by a Cartesian point. A property set can add the conditions (method, accuracy, etc. to the survey point). 'SurveyArea': A set of survey points represented by Cartesian point. These coordinates are determined relative to the coordinates of a reference point, which acts as the datum for the survey. Properties attached apply equally to all points. The difference in elevation of the survey points enables terrain to be determined. 'Annotation curve' is an annotation provided by a curve that has additional semantic. The inherited attribute ObjectType should be used to capture the type of curve annotation, some suggested values are: 'ContourLine': A line of constant elevation typically used on geographic maps where the spacing of lines at constant intervals of elevation can be used as an indication of slope. 'IsoBar': A line of constant pressure typically used on weather maps or to show pressure gradient in spaces, chambers or externally. 'IsoLux': A line of constant illumination typically used to show the distribution of illumination levels and/or day lighting in a space or externally. 'IsoTherm': A line of constant temperature typically used to show the distribution and effect of heating or cooling within a space or to show temperature distribution on a geographic map. 'Annotation surface': is an annotation provided by a surface that has additional semantic. The inherited attribute ObjectType should be used to capture the type of surface annotation, some suggested values are: 'SurveyArea': A surface patch based on survey points.

Definition at line 63 of file Ifc2x3/IfcAnnotationAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcProduct::getAttr ( const char * attrName ) const

overrideprotectedvirtual

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::IfcProduct.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ getInvContainedInStructure()

void OdIfc2x3::IfcAnnotation::getInvContainedInStructure ( OdDAIObjectIds & ContainedInStructure ) const

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

Parameters

ContainedInStructure [out] Receives the value of ContainedInStructure attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ isKindOf()

virtual bool OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ outFields()

virtual OdResult OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcProduct::putAttr	(	const char *	explicitAttrName,
		const OdRxValue &	val )

overrideprotectedvirtual

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::IfcProduct.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcAnnotation::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::IfcProduct.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcAnnotation::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::IfcProduct.

Friends And Related Symbol Documentation

◆ IfcRelContainedInSpatialStructure

friend class IfcRelContainedInSpatialStructure

friend

Definition at line 197 of file Ifc2x3/IfcAnnotationAutoImpl.h.

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

Ifc2x3/IfcAnnotationAutoImpl.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getInvContainedInStructure()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcRelContainedInSpatialStructure