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

#include <IfcSoundPropertiesAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcSoundProperties:
OdIfc2x2_final::IfcPropertySetDefinition OdIfc2x2_final::IfcPropertyDefinition OdIfc2x2_final::IfcRoot OdIfc2x2_final::OdIfc2x2_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

OdDAI::Boolean getIsAttenuating () const
 
void setIsAttenuating (OdDAI::Boolean IsAttenuating)
 
IfcSoundScaleEnum getSoundScale () const
 
void setSoundScale (IfcSoundScaleEnum SoundScale)
 
const OdDAIObjectId & getPointOfMeasurement () const
 
void setPointOfMeasurement (const OdDAIObjectId &PointOfMeasurement)
 
void getSoundValues (OdDAIObjectIds &SoundValues) const
 
OdDAI::ListOfOdDAIObjectId & soundValues ()
 
 IfcSoundProperties ()
 
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::IfcPropertySetDefinition
void getInvPropertyDefinitionOf (OdDAIObjectIds &PropertyDefinitionOf) const
 
void getInvDefinesType (OdDAIObjectIds &DefinesType) const
 
- Public Member Functions inherited from OdIfc2x2_final::IfcPropertyDefinition
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- 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

OdDAI::Boolean m_IsAttenuating
 
OdDAI::Enum m_SoundScale
 
OdDAIObjectId m_PointOfMeasurement
 
OdDAI::ListOfOdDAIObjectId m_SoundValues
 
- 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
 

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

Common definition to capture the properties of sound typically used within the context of building services and flow distribution systems. Sound properties are sound power or pressure levels across eight octave bands specifying the amount of sound generation or sound attenuation.

Definition at line 42 of file Ifc2x2_Final/IfcSoundPropertiesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSoundProperties()

OdIfc2x2_final::IfcSoundProperties::IfcSoundProperties ( )

Default constructor for the IfcSoundProperties class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ getIsAttenuating()

OdDAI::Boolean OdIfc2x2_final::IfcSoundProperties::getIsAttenuating ( ) const

Returns the value of IsAttenuating attribute. This attribute indicates whether the values represents sound attenuation (if TRUE) or represents sound generation (if FALSE).

Returns
Returns the value of IsAttenuating attribute.

◆ getPointOfMeasurement()

const OdDAIObjectId & OdIfc2x2_final::IfcSoundProperties::getPointOfMeasurement ( ) const

Returns the value of PointOfMeasurement attribute. This attribute represents the point at which the sound measurement is taken. This value is used relative to the related element's local placement.

Returns
Returns the value of PointOfMeasurement attribute.

◆ getSoundScale()

IfcSoundScaleEnum OdIfc2x2_final::IfcSoundProperties::getSoundScale ( ) const

Returns the value of SoundScale attribute. This attribute represents the sound scale.

Returns
Returns the value of SoundScale attribute.

◆ getSoundValues()

void OdIfc2x2_final::IfcSoundProperties::getSoundValues ( OdDAIObjectIds & SoundValues) const

Gets the value of SoundValues attribute. This attribute represents the sound values at a specific frequency. There can be cases where less than eight values are specified.

Parameters
SoundValues[out] Receives the SoundValues attribute.

◆ inFields()

virtual OdResult OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ isKindOf()

virtual bool OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ outFields()

virtual OdResult OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ putAttr() [1/2]

virtual bool OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ putAttr() [2/2]

virtual bool OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ setIsAttenuating()

void OdIfc2x2_final::IfcSoundProperties::setIsAttenuating ( OdDAI::Boolean IsAttenuating)

Sets the value of IsAttenuating attribute. This attribute indicates whether the values represents sound attenuation (if TRUE) or represents sound generation (if FALSE).

Parameters
IsAttenuating[in] IsAttenuating attribute to set.

◆ setPointOfMeasurement()

void OdIfc2x2_final::IfcSoundProperties::setPointOfMeasurement ( const OdDAIObjectId & PointOfMeasurement)

Sets the value of PointOfMeasurement attribute. This attribute represents the point at which the sound measurement is taken. This value is used relative to the related element's local placement.

Parameters
PointOfMeasurement[in] PointOfMeasurement attribute to set.

◆ setSoundScale()

void OdIfc2x2_final::IfcSoundProperties::setSoundScale ( IfcSoundScaleEnum SoundScale)

Sets the value of SoundScale attribute. This attribute represents the sound scale.

Parameters
SoundScale[in] SoundScale attribute to set.

◆ soundValues()

OdDAI::ListOfOdDAIObjectId & OdIfc2x2_final::IfcSoundProperties::soundValues ( )

Returns the value of SoundValues attribute. This attribute represents the sound values at a specific frequency. There can be cases where less than eight values are specified.

Returns
Returns the value of SoundValues attribute.

◆ testAttr() [1/2]

virtual bool OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ testAttr() [2/2]

virtual bool OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ unsetAttr() [1/2]

virtual void OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

◆ unsetAttr() [2/2]

virtual void OdIfc2x2_final::IfcSoundProperties::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::IfcPropertySetDefinition.

Member Data Documentation

◆ m_IsAttenuating

OdDAI::Boolean OdIfc2x2_final::IfcSoundProperties::m_IsAttenuating
protected

Definition at line 232 of file Ifc2x2_Final/IfcSoundPropertiesAutoImpl.h.

◆ m_PointOfMeasurement

OdDAIObjectId OdIfc2x2_final::IfcSoundProperties::m_PointOfMeasurement
protected

Definition at line 234 of file Ifc2x2_Final/IfcSoundPropertiesAutoImpl.h.

◆ m_SoundScale

OdDAI::Enum OdIfc2x2_final::IfcSoundProperties::m_SoundScale
protected

Definition at line 233 of file Ifc2x2_Final/IfcSoundPropertiesAutoImpl.h.

◆ m_SoundValues

OdDAI::ListOfOdDAIObjectId OdIfc2x2_final::IfcSoundProperties::m_SoundValues
protected

Definition at line 235 of file Ifc2x2_Final/IfcSoundPropertiesAutoImpl.h.


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