#include <IfcLightSourceGoniometricAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcLightSourceGoniometric:

Public Member Functions
const OdDAIObjectId &	getPosition () const

void	setPosition (const OdDAIObjectId &Position)

const OdDAIObjectId &	getColourAppearance () const

void	setColourAppearance (const OdDAIObjectId &ColourAppearance)

double	getColourTemperature () const

void	setColourTemperature (double ColourTemperature)

double	getLuminousFlux () const

void	setLuminousFlux (double LuminousFlux)

IfcLightEmissionSourceEnum	getLightEmissionSource () const

void	setLightEmissionSource (IfcLightEmissionSourceEnum LightEmissionSource)

IfcLightDistributionDataSourceSelect	lightDistributionDataSource ()

	IfcLightSourceGoniometric ()

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::IfcLightSource
const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdDAIObjectId &	getLightColour () const

void	setLightColour (const OdDAIObjectId &LightColour)

double	getAmbientIntensity () const

void	setAmbientIntensity (double AmbientIntensity)

double	getIntensity () const

void	setIntensity (double Intensity)

	IfcLightSource ()

Public Member Functions inherited from OdIfc2x3::IfcRepresentationItem
void	getInvLayerAssignments (OdDAIObjectIds &LayerAssignments) const

void	getInvStyledByItem (OdDAIObjectIds &StyledByItem) const

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
OdDAIObjectId	m_Position

OdDAIObjectId	m_ColourAppearance

double	m_ColourTemperature

double	m_LuminousFlux

OdDAI::Enum	m_LightEmissionSource

OdDAI::Select	m_LightDistributionDataSource

Protected Attributes inherited from OdIfc2x3::IfcLightSource
OdAnsiString	m_Name

OdDAIObjectId	m_LightColour

IfcNormalisedRatioMeasure	m_AmbientIntensity

IfcNormalisedRatioMeasure	m_Intensity

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

IfcLightSourceGoniometric defines a light source for which exact lighting data is available.

Details - This entity specifies the type of a light emitter, defines the position and orientation of a light distribution curve and the data concerning lamp and photometric information. The following image shows an example of a light emitter having two light sources (of type IfcLightSourceGoniometric).

Definition at line 49 of file Ifc2x3/IfcLightSourceGoniometricAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcLightSourceGoniometric()

OdIfc2x3::IfcLightSourceGoniometric::IfcLightSourceGoniometric ( )

Default constructor for the IfcLightSourceGoniometric class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getColourAppearance()

const OdDAIObjectId & OdIfc2x3::IfcLightSourceGoniometric::getColourAppearance ( ) const

Returns the value of ColourAppearance attribute. This attribute represents color appearance. Artificial light sources are classified in terms of their color appearance. To the human eye they all appear to be white; the difference can only be detected by direct comparison. Visual performance is not directly affected by differences in color appearance.

Returns: Returns the value of ColourAppearance attribute.

◆ getColourTemperature()

double OdIfc2x3::IfcLightSourceGoniometric::getColourTemperature ( ) const

Returns the value of ColourTemperature attribute. This attribute represents the color temperature. Color temperature of any source of radiation is defined as the temperature (in Kelvin) of a black-body or Planckian radiator whose radiation has the same chromaticity as the source of radiation. Often the values are only approximate color temperatures as the black-body radiator cannot emit radiation of every chromaticity value. The color temperatures of the commonest artificial light sources range from less than 3000K (warm white) to 4000K (intermediate) and over 5000K (daylight).

Returns: Returns the value of ColourTemperature attribute.

◆ getInstanceType()

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

◆ getLightEmissionSource()

IfcLightEmissionSourceEnum OdIfc2x3::IfcLightSourceGoniometric::getLightEmissionSource ( ) const

Returns the value of LightEmissionSource attribute. This attribute represents the types of light emitter from which the type required can be set.

Returns: Returns the value of LightEmissionSource attribute.

◆ getLuminousFlux()

double OdIfc2x3::IfcLightSourceGoniometric::getLuminousFlux ( ) const

Returns the value of LuminousFlux attribute. This attribute represents a luminous flux. Luminous flux is a photometric measure of radiant flux, i.e. the volume of light emitted from a light source. Luminous flux is measured either for the interior as a whole or for a part of the interior (partial luminous flux for a solid angle). All other photometric parameters are derivatives of luminous flux. Luminous flux is measured in lumens (lm). The luminous flux is specified as a nominal value for each lamp.

Returns: Returns the value of LuminousFlux attribute.

◆ getPosition()

const OdDAIObjectId & OdIfc2x3::IfcLightSourceGoniometric::getPosition ( ) const

Returns the value of Position attribute. This attribute represents the position of the light source. It is used to orientate the light distribution curves.

Returns: Returns the value of Position attribute.

◆ inFields()

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

◆ isKindOf()

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

◆ lightDistributionDataSource()

IfcLightDistributionDataSourceSelect OdIfc2x3::IfcLightSourceGoniometric::lightDistributionDataSource ( )

Returns the value of LightDistributionDataSource attribute. This attribute represents the data source from which light distribution data is obtained.

Returns: Returns the value of LightDistributionDataSource attribute.

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setColourAppearance()

void OdIfc2x3::IfcLightSourceGoniometric::setColourAppearance ( const OdDAIObjectId & ColourAppearance )

Sets the value of ColourAppearance attribute. This attribute represents color appearance. Artificial light sources are classified in terms of their color appearance. To the human eye they all appear to be white; the difference can only be detected by direct comparison. Visual performance is not directly affected by differences in color appearance.

Parameters

ColourAppearance [in] Color appearance to set.

◆ setColourTemperature()

void OdIfc2x3::IfcLightSourceGoniometric::setColourTemperature ( double ColourTemperature )

Sets the value of ColourTemperature attribute. This attribute represents the color temperature. Color temperature of any source of radiation is defined as the temperature (in Kelvin) of a black-body or Planckian radiator whose radiation has the same chromaticity as the source of radiation. Often the values are only approximate color temperatures as the black-body radiator cannot emit radiation of every chromaticity value. The color temperatures of the commonest artificial light sources range from less than 3000K (warm white) to 4000K (intermediate) and over 5000K (daylight).

Parameters

ColourTemperature [in] Color temperature to set.

◆ setLightEmissionSource()

void OdIfc2x3::IfcLightSourceGoniometric::setLightEmissionSource ( IfcLightEmissionSourceEnum LightEmissionSource )

Sets the value of LightEmissionSource attribute. This attribute represents the types of light emitter from which the type required can be set.

Parameters

LightEmissionSource [in] Light emission source to set.

◆ setLuminousFlux()

void OdIfc2x3::IfcLightSourceGoniometric::setLuminousFlux ( double LuminousFlux )

Sets the value of LuminousFlux attribute. This attribute represents a luminous flux. Luminous flux is a photometric measure of radiant flux, i.e. the volume of light emitted from a light source. Luminous flux is measured either for the interior as a whole or for a part of the interior (partial luminous flux for a solid angle). All other photometric parameters are derivatives of luminous flux. Luminous flux is measured in lumens (lm). The luminous flux is specified as a nominal value for each lamp.

Parameters

LuminousFlux [in] Luminous flux to set.

◆ setPosition()

void OdIfc2x3::IfcLightSourceGoniometric::setPosition ( const OdDAIObjectId & Position )

Sets the value of Position attribute. This attribute represents the position of the light source. It is used to orientate the light distribution curves.

Parameters

Position [in] Position to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

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

◆ unsetAttr() [2/2]

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

Member Data Documentation

◆ m_ColourAppearance

OdDAIObjectId OdIfc2x3::IfcLightSourceGoniometric::m_ColourAppearance

protected

Definition at line 294 of file Ifc2x3/IfcLightSourceGoniometricAutoImpl.h.

◆ m_ColourTemperature

double OdIfc2x3::IfcLightSourceGoniometric::m_ColourTemperature

protected

Definition at line 295 of file Ifc2x3/IfcLightSourceGoniometricAutoImpl.h.

◆ m_LightDistributionDataSource

OdDAI::Select OdIfc2x3::IfcLightSourceGoniometric::m_LightDistributionDataSource

protected

Definition at line 298 of file Ifc2x3/IfcLightSourceGoniometricAutoImpl.h.

◆ m_LightEmissionSource

OdDAI::Enum OdIfc2x3::IfcLightSourceGoniometric::m_LightEmissionSource

protected

Definition at line 297 of file Ifc2x3/IfcLightSourceGoniometricAutoImpl.h.

◆ m_LuminousFlux

double OdIfc2x3::IfcLightSourceGoniometric::m_LuminousFlux

protected

Definition at line 296 of file Ifc2x3/IfcLightSourceGoniometricAutoImpl.h.

◆ m_Position

OdDAIObjectId OdIfc2x3::IfcLightSourceGoniometric::m_Position

protected

Definition at line 293 of file Ifc2x3/IfcLightSourceGoniometricAutoImpl.h.

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

Ifc2x3/IfcLightSourceGoniometricAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcLightSourceGoniometric()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getColourAppearance()

◆ getColourTemperature()

◆ getInstanceType()

◆ getLightEmissionSource()

◆ getLuminousFlux()

◆ getPosition()

◆ inFields()

◆ isKindOf()

◆ lightDistributionDataSource()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setColourAppearance()

◆ setColourTemperature()

◆ setLightEmissionSource()

◆ setLuminousFlux()

◆ setPosition()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_ColourAppearance

◆ m_ColourTemperature

◆ m_LightDistributionDataSource

◆ m_LightEmissionSource

◆ m_LuminousFlux

◆ m_Position