#include <IfcPropertySingleValueAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcPropertySingleValue:

Public Member Functions
IfcValue	nominalValue ()

IfcUnit	unit ()

	IfcPropertySingleValue ()

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

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

void	getInvPartOfPset (OdDAIObjectIds &PartOfPset) const

void	getInvPropertyForDependance (OdDAIObjectIds &PropertyForDependance) const

void	getInvPropertyDependsOn (OdDAIObjectIds &PropertyDependsOn) const

void	getInvPartOfComplex (OdDAIObjectIds &PartOfComplex) const

void	getInvHasConstraints (OdDAIObjectIds &HasConstraints) const

void	getInvHasApprovals (OdDAIObjectIds &HasApprovals) const

	IfcProperty ()

Public Member Functions inherited from OdIfc4x2::IfcPropertyAbstraction
void	getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) const

Public Member Functions inherited from OdIfc4x2::OdIfc4x2Instance
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::Select	m_NominalValue

OdDAI::Select	m_Unit

Protected Attributes inherited from OdIfc4x2::IfcProperty
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

The property with a single value IfcPropertySingleValue defines a property object which has a single (numeric or descriptive) value assigned. It defines a property - single value combination for which the property Name, an optional Description, and an optional NominalValue with measure type is provided. In addition, the default unit as specified within the project unit context can be overridden by assigning an Unit.

If the Unit attribute is not specified, than the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. 
The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext).
If the Unit attribute is specified, the unit assigned by the Unit attribute overrides the globally assigned unit.

\changes

IFC2X_FINAL changes: Entity has been renamed from IfcSimpleProperty. IFC2X3 changes: Attribute NominalValue has been made OPTIONAL with upward compatibility for file based exchange.

Definition at line 56 of file Ifc4x2/IfcPropertySingleValueAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPropertySingleValue()

OdIfc4x2::IfcPropertySingleValue::IfcPropertySingleValue ( )

Default constructor for the IfcPropertySingleValue class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcProperty.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcProperty.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcSimpleProperty.

◆ inFields()

virtual OdResult OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcProperty.

◆ isKindOf()

virtual bool OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcSimpleProperty.

◆ nominalValue()

IfcValue OdIfc4x2::IfcPropertySingleValue::nominalValue ( )

Returns the value of NominalValue attribute. NominalValue is value and measure type of this property.

Returns: Returns the value of NominalValue attribute.

Remarks: By virtue of the defined data type that is selected from the SELECT IfcValue, the appropriate unit can be found within the IfcUnitAssignment, defined for the project if no value for the unit attribute is given.

◆ outFields()

virtual OdResult OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcProperty.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcProperty.

◆ putAttr() [2/2]

virtual bool OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcProperty.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcProperty.

◆ testAttr() [2/2]

virtual bool OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcProperty.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcSimpleProperty.

◆ unit()

IfcUnit OdIfc4x2::IfcPropertySingleValue::unit ( )

Returns the value of Unit attribute that represents the unit for the nominal value. If not specified, the default value for the measure type is used as defined by the global unit assignment at IfcProject.

Returns: Returns the value of Unit attribute.

◆ unsetAttr() [1/2]

virtual void OdIfc4x2::IfcPropertySingleValue::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x2::IfcProperty.

◆ unsetAttr() [2/2]

virtual void OdIfc4x2::IfcPropertySingleValue::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 OdIfc4x2::IfcProperty.

Member Data Documentation

◆ m_NominalValue

OdDAI::Select OdIfc4x2::IfcPropertySingleValue::m_NominalValue

protected

Definition at line 199 of file Ifc4x2/IfcPropertySingleValueAutoImpl.h.

◆ m_Unit

OdDAI::Select OdIfc4x2::IfcPropertySingleValue::m_Unit

protected

Definition at line 200 of file Ifc4x2/IfcPropertySingleValueAutoImpl.h.

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

Ifc4x2/IfcPropertySingleValueAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcPropertySingleValue()

Member Function Documentation

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ inFields()

◆ isKindOf()

◆ nominalValue()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unit()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_NominalValue

◆ m_Unit