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

#include <IfcOpticalMaterialPropertiesAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcOpticalMaterialProperties:
OdIfc2x3::IfcMaterialProperties OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

double getVisibleTransmittance () const
 
void setVisibleTransmittance (double VisibleTransmittance)
 
double getSolarTransmittance () const
 
void setSolarTransmittance (double SolarTransmittance)
 
double getThermalIrTransmittance () const
 
void setThermalIrTransmittance (double ThermalIrTransmittance)
 
double getThermalIrEmissivityBack () const
 
void setThermalIrEmissivityBack (double ThermalIrEmissivityBack)
 
double getThermalIrEmissivityFront () const
 
void setThermalIrEmissivityFront (double ThermalIrEmissivityFront)
 
double getVisibleReflectanceBack () const
 
void setVisibleReflectanceBack (double VisibleReflectanceBack)
 
double getVisibleReflectanceFront () const
 
void setVisibleReflectanceFront (double VisibleReflectanceFront)
 
double getSolarReflectanceFront () const
 
void setSolarReflectanceFront (double SolarReflectanceFront)
 
double getSolarReflectanceBack () const
 
void setSolarReflectanceBack (double SolarReflectanceBack)
 
 IfcOpticalMaterialProperties ()
 
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::IfcMaterialProperties
const OdDAIObjectId & getMaterial () const
 
void setMaterial (const OdDAIObjectId &Material)
 
- 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

IfcPositiveRatioMeasure m_VisibleTransmittance
 
IfcPositiveRatioMeasure m_SolarTransmittance
 
IfcPositiveRatioMeasure m_ThermalIrTransmittance
 
IfcPositiveRatioMeasure m_ThermalIrEmissivityBack
 
IfcPositiveRatioMeasure m_ThermalIrEmissivityFront
 
IfcPositiveRatioMeasure m_VisibleReflectanceBack
 
IfcPositiveRatioMeasure m_VisibleReflectanceFront
 
IfcPositiveRatioMeasure m_SolarReflectanceFront
 
IfcPositiveRatioMeasure m_SolarReflectanceBack
 
- Protected Attributes inherited from OdIfc2x3::IfcMaterialProperties
OdDAIObjectId m_Material
 
- 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

A container class with material optical properties defined in IFC specification.

Definition at line 40 of file Ifc2x3/IfcOpticalMaterialPropertiesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcOpticalMaterialProperties()

OdIfc2x3::IfcOpticalMaterialProperties::IfcOpticalMaterialProperties ( )

Default constructor for the IfcOpticalMaterialProperties class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getInstanceType()

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

◆ getSolarReflectanceBack()

double OdIfc2x3::IfcOpticalMaterialProperties::getSolarReflectanceBack ( ) const

Returns the value of SolarReflectanceBack attribute. This attribute represents the reflectance at normal incidence (solar): back side. Defines the fraction of the solar ray that is reflected and not transmitted when the ray passes from one medium into another, at the "back" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.

Returns
Returns the value of SolarReflectanceBack attribute.

◆ getSolarReflectanceFront()

double OdIfc2x3::IfcOpticalMaterialProperties::getSolarReflectanceFront ( ) const

Returns the value of SolarReflectanceFront attribute. This attribute represents the reflectance at normal incidence (solar): front side. Defines the fraction of the solar ray that is reflected and not transmitted when the ray passes from one medium into another, at the "front" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.

Returns
Returns the value of SolarReflectanceFront attribute.

◆ getSolarTransmittance()

double OdIfc2x3::IfcOpticalMaterialProperties::getSolarTransmittance ( ) const

Returns the value of SolarTransmittance attribute. This attribute represents the transmittance at normal incidence (solar). Defines the fraction of solar radiation that passes through per unit area, perpendicular to the surface.

Returns
Returns the value of SolarTransmittance attribute.

◆ getThermalIrEmissivityBack()

double OdIfc2x3::IfcOpticalMaterialProperties::getThermalIrEmissivityBack ( ) const

Returns the value of ThermalIrEmissivityBack attribute. This attribute represents the thermal IR emissivity: back side. Defines the fraction of thermal energy emitted per unit area to "blackbody" at the same temperature, through the "back" side of the material.

Returns
Returns the value of ThermalIrEmissivityBack attribute.

◆ getThermalIrEmissivityFront()

double OdIfc2x3::IfcOpticalMaterialProperties::getThermalIrEmissivityFront ( ) const

Returns the value of ThermalIrEmissivityFront attribute. This attribute represents the thermal IR emissivity: front side. Defines the fraction of thermal energy emitted per unit area to "blackbody" at the same temperature, through the "front" side of the material.

Returns
Returns the value of ThermalIrEmissivityFront attribute.

◆ getThermalIrTransmittance()

double OdIfc2x3::IfcOpticalMaterialProperties::getThermalIrTransmittance ( ) const

Returns the value of ThermalIrTransmittance attribute. This attribute represents the thermal IR transmittance at normal incidence. Defines the fraction of thermal energy that passes through per unit area, perpendicular to the surface.

Returns
Returns the value of ThermalIrTransmittance attribute.

◆ getVisibleReflectanceBack()

double OdIfc2x3::IfcOpticalMaterialProperties::getVisibleReflectanceBack ( ) const

Returns the value of VisibleReflectanceBack attribute. This attribute represents the reflectance at normal incidence (visible): back side. Defines the fraction of the solar ray in the visible spectrum that is reflected and not transmitted when the ray passes from one medium into another, at the "back" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.

Returns
Returns the value of VisibleReflectanceBack attribute.

◆ getVisibleReflectanceFront()

double OdIfc2x3::IfcOpticalMaterialProperties::getVisibleReflectanceFront ( ) const

Returns the value of VisibleReflectanceFront attribute. This attribute represents the reflectance at normal incidence (visible): front side. Defines the fraction of the solar ray in the visible spectrum that is reflected and not transmitted when the ray passes from one medium into another, at the "front" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.

Returns
Returns the value of VisibleReflectanceFront attribute.

◆ getVisibleTransmittance()

double OdIfc2x3::IfcOpticalMaterialProperties::getVisibleTransmittance ( ) const

Returns the value of VisibleTransmittance attribute. This attribute represents the transmittance at normal incidence (visible). Defines the fraction of the visible spectrum of solar radiation that passes through per unit area, perpendicular to the surface.

Returns
Returns the value of VisibleTransmittance attribute.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setSolarReflectanceBack()

void OdIfc2x3::IfcOpticalMaterialProperties::setSolarReflectanceBack ( double SolarReflectanceBack)

Sets the value of SolarReflectanceBack attribute. This attribute represents the reflectance at normal incidence (solar): back side. Defines the fraction of the solar ray that is reflected and not transmitted when the ray passes from one medium into another, at the "back" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.

Parameters
SolarReflectanceBack[in] SolarReflectanceBack attribute to set.

◆ setSolarReflectanceFront()

void OdIfc2x3::IfcOpticalMaterialProperties::setSolarReflectanceFront ( double SolarReflectanceFront)

Sets the value of SolarReflectanceFront attribute. This attribute represents the reflectance at normal incidence (solar): front side. Defines the fraction of the solar ray that is reflected and not transmitted when the ray passes from one medium into another, at the "front" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.

Parameters
SolarReflectanceFront[in] SolarReflectanceFront attribute to set.

◆ setSolarTransmittance()

void OdIfc2x3::IfcOpticalMaterialProperties::setSolarTransmittance ( double SolarTransmittance)

Sets the value of SolarTransmittance attribute. This attribute represents the transmittance at normal incidence (solar). Defines the fraction of solar radiation that passes through per unit area, perpendicular to the surface.

Parameters
SolarTransmittance[in] SolarTransmittance attribute to set.

◆ setThermalIrEmissivityBack()

void OdIfc2x3::IfcOpticalMaterialProperties::setThermalIrEmissivityBack ( double ThermalIrEmissivityBack)

Sets the value of ThermalIrEmissivityBack attribute. This attribute represents the thermal IR emissivity: back side. Defines the fraction of thermal energy emitted per unit area to "blackbody" at the same temperature, through the "back" side of the material.

Parameters
ThermalIrEmissivityBack[in] ThermalIrEmissivityBack attribute to set.

◆ setThermalIrEmissivityFront()

void OdIfc2x3::IfcOpticalMaterialProperties::setThermalIrEmissivityFront ( double ThermalIrEmissivityFront)

Sets the value of ThermalIrEmissivityFront attribute. This attribute represents the thermal IR emissivity: front side. Defines the fraction of thermal energy emitted per unit area to "blackbody" at the same temperature, through the "front" side of the material.

Parameters
ThermalIrEmissivityFront[in] ThermalIrEmissivityFront attribute to set.

◆ setThermalIrTransmittance()

void OdIfc2x3::IfcOpticalMaterialProperties::setThermalIrTransmittance ( double ThermalIrTransmittance)

Sets the value of ThermalIrTransmittance attribute. This attribute represents the thermal IR transmittance at normal incidence. Defines the fraction of thermal energy that passes through per unit area, perpendicular to the surface.

Parameters
ThermalIrTransmittance[in] ThermalIrTransmittance attribute to set.

◆ setVisibleReflectanceBack()

void OdIfc2x3::IfcOpticalMaterialProperties::setVisibleReflectanceBack ( double VisibleReflectanceBack)

Sets the value of VisibleReflectanceBack attribute. This attribute represents the reflectance at normal incidence (visible): back side. Defines the fraction of the solar ray in the visible spectrum that is reflected and not transmitted when the ray passes from one medium into another, at the "back" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.

Parameters
VisibleReflectanceBack[in] VisibleReflectanceBack attribute to set.

◆ setVisibleReflectanceFront()

void OdIfc2x3::IfcOpticalMaterialProperties::setVisibleReflectanceFront ( double VisibleReflectanceFront)

Sets the value of VisibleReflectanceFront attribute. This attribute represents the reflectance at normal incidence (visible): front side. Defines the fraction of the solar ray in the visible spectrum that is reflected and not transmitted when the ray passes from one medium into another, at the "front" side of the other material, perpendicular to the surface. Dependent on material and surface characteristics.

Parameters
VisibleReflectanceFront[in] VisibleReflectanceFront attribute to set.

◆ setVisibleTransmittance()

void OdIfc2x3::IfcOpticalMaterialProperties::setVisibleTransmittance ( double VisibleTransmittance)

Sets the value of VisibleTransmittance attribute. This attribute represents the transmittance at normal incidence (visible). Defines the fraction of the visible spectrum of solar radiation that passes through per unit area, perpendicular to the surface.

Parameters
VisibleTransmittance[in] VisibleTransmittance attribute to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

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

◆ unsetAttr() [2/2]

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

Member Data Documentation

◆ m_SolarReflectanceBack

IfcPositiveRatioMeasure OdIfc2x3::IfcOpticalMaterialProperties::m_SolarReflectanceBack
protected

◆ m_SolarReflectanceFront

IfcPositiveRatioMeasure OdIfc2x3::IfcOpticalMaterialProperties::m_SolarReflectanceFront
protected

◆ m_SolarTransmittance

IfcPositiveRatioMeasure OdIfc2x3::IfcOpticalMaterialProperties::m_SolarTransmittance
protected

◆ m_ThermalIrEmissivityBack

IfcPositiveRatioMeasure OdIfc2x3::IfcOpticalMaterialProperties::m_ThermalIrEmissivityBack
protected

◆ m_ThermalIrEmissivityFront

IfcPositiveRatioMeasure OdIfc2x3::IfcOpticalMaterialProperties::m_ThermalIrEmissivityFront
protected

◆ m_ThermalIrTransmittance

IfcPositiveRatioMeasure OdIfc2x3::IfcOpticalMaterialProperties::m_ThermalIrTransmittance
protected

◆ m_VisibleReflectanceBack

IfcPositiveRatioMeasure OdIfc2x3::IfcOpticalMaterialProperties::m_VisibleReflectanceBack
protected

◆ m_VisibleReflectanceFront

IfcPositiveRatioMeasure OdIfc2x3::IfcOpticalMaterialProperties::m_VisibleReflectanceFront
protected

◆ m_VisibleTransmittance

IfcPositiveRatioMeasure OdIfc2x3::IfcOpticalMaterialProperties::m_VisibleTransmittance
protected

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