CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcReferencesValueDocument Class Reference

#include <IfcReferencesValueDocumentAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcReferencesValueDocument:
OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

IfcDocumentSelect referencedDocument ()
 
void getReferencingValues (OdDAIObjectIds &ReferencingValues) const
 
OdDAI::SetOfOdDAIObjectId & referencingValues ()
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
 IfcReferencesValueDocument ()
 
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 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAI::Select m_ReferencedDocument
 
OdDAI::SetOfOdDAIObjectId m_ReferencingValues
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

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

IfcReferencesValueDocument instance references many instances of IfcAppliedValue to a single document where the document is a price list, quotation, list of environmental impact values or other source of information. The purpose of this class is to be able to identify a reference source from which applied values are obtained.

Definition at line 46 of file Ifc2x3/IfcReferencesValueDocumentAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcReferencesValueDocument()

OdIfc2x3::IfcReferencesValueDocument::IfcReferencesValueDocument ( )

Default constructor for the IfcReferencesValueDocument class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcReferencesValueDocument::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 OdIfc::OdIfcInstance.

◆ getDescription()

const OdAnsiString & OdIfc2x3::IfcReferencesValueDocument::getDescription ( ) const

Returns the value of Description attribute. This attribute represents the description of the relationship to the document from which values can be referenced.

Returns
Returns the value of Description attribute.

◆ getInstanceType()

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

◆ getName()

const OdAnsiString & OdIfc2x3::IfcReferencesValueDocument::getName ( ) const

Returns the value of Name attribute. This attribute represents the name used to identify or qualify the relationship to the document from which values can be referenced.

Returns
Returns the value of Name attribute.

◆ getReferencingValues()

void OdIfc2x3::IfcReferencesValueDocument::getReferencingValues ( OdDAIObjectIds & ReferencingValues) const

Gets the value of ReferencingValues attribute. This attribute represents the costs obtained from a single document such as a price list or quotation.

Parameters
ReferencingValues[out] Receives the ReferencingValues attribute.

◆ inFields()

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

◆ isKindOf()

virtual bool OdIfc2x3::IfcReferencesValueDocument::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 OdIfc::OdIfcInstance.

◆ outFields()

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

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcReferencesValueDocument::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 OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcReferencesValueDocument::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 OdIfc::OdIfcInstance.

◆ referencedDocument()

IfcDocumentSelect OdIfc2x3::IfcReferencesValueDocument::referencedDocument ( )

Returns the value of ReferencedDocument attribute. This attribute represents the document such as a price list or quotation from which costs are obtained.

Returns
Returns the value of ReferencedDocument attribute.

◆ referencingValues()

OdDAI::SetOfOdDAIObjectId & OdIfc2x3::IfcReferencesValueDocument::referencingValues ( )

Returns the value of ReferencingValues attribute. This attribute represents the costs obtained from a single document such as a price list or quotation.

Returns
Returns the value of ReferencingValues attribute.

◆ setDescription()

void OdIfc2x3::IfcReferencesValueDocument::setDescription ( const OdAnsiString & Description)

Sets the value of Description attribute. This attribute represents the description of the relationship to the document from which values can be referenced.

Parameters
Description[in] Description attribute to set.

◆ setInverseCounterParts()

virtual void OdIfc2x3::IfcReferencesValueDocument::setInverseCounterParts ( )
overridevirtual

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

◆ setName()

void OdIfc2x3::IfcReferencesValueDocument::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. This attribute represents the name used to identify or qualify the relationship to the document from which values can be referenced.

Parameters
Name[in] Name attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcReferencesValueDocument::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 OdIfc::OdIfcInstance.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcReferencesValueDocument::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 OdIfc::OdIfcInstance.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcReferencesValueDocument::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 OdIfc::OdIfcInstance.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcReferencesValueDocument::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcReferencesValueDocument::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 OdIfc::OdIfcInstance.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc2x3::IfcReferencesValueDocument::m_Description
protected

Definition at line 250 of file Ifc2x3/IfcReferencesValueDocumentAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc2x3::IfcReferencesValueDocument::m_Name
protected

Definition at line 249 of file Ifc2x3/IfcReferencesValueDocumentAutoImpl.h.

◆ m_ReferencedDocument

OdDAI::Select OdIfc2x3::IfcReferencesValueDocument::m_ReferencedDocument
protected

Definition at line 247 of file Ifc2x3/IfcReferencesValueDocumentAutoImpl.h.

◆ m_ReferencingValues

OdDAI::SetOfOdDAIObjectId OdIfc2x3::IfcReferencesValueDocument::m_ReferencingValues
protected

Definition at line 248 of file Ifc2x3/IfcReferencesValueDocumentAutoImpl.h.


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