#include <IfcSoundPropertiesAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcSoundProperties:

Public Member Functions
OdDAI::Boolean	getIsAttenuating () const

void	setIsAttenuating (OdDAI::Boolean IsAttenuating)

IfcSoundScaleEnum	getSoundScale () const

void	setSoundScale (IfcSoundScaleEnum SoundScale)

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 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::IfcPropertySetDefinition
void	getInvPropertyDefinitionOf (OdDAIObjectIds &PropertyDefinitionOf) const

void	getInvDefinesType (OdDAIObjectIds &DefinesType) const

Public Member Functions inherited from OdIfc2x3::IfcPropertyDefinition
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 Attributes
OdDAI::Boolean	m_IsAttenuating

OdDAI::Enum	m_SoundScale

OdDAI::ListOfOdDAIObjectId	m_SoundValues

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

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)

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 41 of file Ifc2x3/IfcSoundPropertiesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSoundProperties()

OdIfc2x3::IfcSoundProperties::IfcSoundProperties ( )

Default constructor for the IfcSoundProperties class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getInstanceType()

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

◆ getIsAttenuating()

OdDAI::Boolean OdIfc2x3::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.

◆ getSoundScale()

IfcSoundScaleEnum OdIfc2x3::IfcSoundProperties::getSoundScale ( ) const

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

Returns: Returns the value of SoundScale attribute.

◆ getSoundValues()

void OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::IfcPropertySetDefinition.

◆ isKindOf()

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

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setIsAttenuating()

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

◆ setSoundScale()

void OdIfc2x3::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 & OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::IfcPropertySetDefinition.

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

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

◆ unsetAttr() [2/2]

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

Member Data Documentation

◆ m_IsAttenuating

OdDAI::Boolean OdIfc2x3::IfcSoundProperties::m_IsAttenuating

protected

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

◆ m_SoundScale

OdDAI::Enum OdIfc2x3::IfcSoundProperties::m_SoundScale

protected

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

◆ m_SoundValues

OdDAI::ListOfOdDAIObjectId OdIfc2x3::IfcSoundProperties::m_SoundValues

protected

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

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

Ifc2x3/IfcSoundPropertiesAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcSoundProperties()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getIsAttenuating()

◆ getSoundScale()

◆ getSoundValues()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setIsAttenuating()

◆ setSoundScale()

◆ soundValues()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_IsAttenuating

◆ m_SoundScale

◆ m_SoundValues