CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4::IfcSensor Class Reference

#include <IfcSensorAutoImpl.h>

Inheritance diagram for OdIfc4::IfcSensor:
OdIfc4::IfcDistributionControlElement OdIfc4::IfcDistributionElement OdIfc4::IfcElement OdIfc4::IfcProduct OdIfc4::IfcObject OdIfc4::IfcObjectDefinition OdIfc4::IfcRoot OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance

Public Member Functions

IfcSensorTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcSensorTypeEnum PredefinedType)
 
 IfcSensor ()
 
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 OdIfc4::IfcDistributionControlElement
void getInvAssignedToFlowElement (OdDAIObjectIds &AssignedToFlowElement) const
 
- Public Member Functions inherited from OdIfc4::IfcDistributionElement
void getInvHasPorts (OdDAIObjectIds &HasPorts) const
 
- Public Member Functions inherited from OdIfc4::IfcElement
const OdAnsiString & getTag () const
 
void setTag (const OdAnsiString &Tag)
 
void getInvFillsVoids (OdDAIObjectIds &FillsVoids) const
 
void getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const
 
void getInvIsInterferedByElements (OdDAIObjectIds &IsInterferedByElements) const
 
void getInvInterferesElements (OdDAIObjectIds &InterferesElements) const
 
void getInvHasProjections (OdDAIObjectIds &HasProjections) const
 
void getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const
 
void getInvHasOpenings (OdDAIObjectIds &HasOpenings) const
 
void getInvIsConnectionRealization (OdDAIObjectIds &IsConnectionRealization) const
 
void getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const
 
void getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const
 
void getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const
 
void getInvHasCoverings (OdDAIObjectIds &HasCoverings) const
 
 IfcElement ()
 
- Public Member Functions inherited from OdIfc4::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
virtual void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc4::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const
 
void getInvDeclares (OdDAIObjectIds &Declares) const
 
void getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc4::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvNests (OdDAIObjectIds &Nests) const
 
void getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const
 
void getInvHasContext (OdDAIObjectIds &HasContext) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc4::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 OdIfc4::OdIfc4Instance
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

OdDAI::Enum m_PredefinedType
 
- Protected Attributes inherited from OdIfc4::IfcElement
OdAnsiString m_Tag
 
- Protected Attributes inherited from OdIfc4::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc4::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4::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

A sensor is a device that measures a physical quantity and converts it into a signal which can be read by an observer or by an instrument.

  • Control Flow - This concept can be applied to the following resources: IfcDistributionFlowElement - Sensors can be connected to a flow element for which an aspect of the fluid or flow is measured.
  • Material Set - This concept can be applied to the following resources: Casing - Material from which the casing is constructed.
  • Object Typing - This concept can be applied to the following resources: IfcSensorType
  • Port Nesting - This concept can be applied with the following combinations:
    PortName

Flow PredefinedType Output SOURCE SIGNAL

  • Property Sets for Objects - This concept can be applied to the following resources: Pset_SensorTypeCommon Pset_SensorTypeLevelSensor (only applies to LEVELSENSOR) Pset_SensorTypeCO2Sensor (only applies to CO2SENSOR) Pset_SensorTypeConductanceSensor (only applies to CONDUCTANCESENSOR) Pset_SensorTypeContactSensor (only applies to CONTACTSENSOR) Pset_SensorTypeEarthquakeSensor (only applies to EARTHQUAKESENSOR) Pset_SensorTypeFireSensor (only applies to FIRESENSOR) Pset_SensorTypeFlowSensor (only applies to FLOWSENSOR) Pset_SensorTypeForeignObjectDetectionSensor (only applies to FOREIGNOBJECTDETECTIONSENSOR) Pset_SensorTypeFrostSensor (only applies to FROSTSENSOR) Pset_SensorTypeGasSensor (only applies to GASSENSOR) Pset_SensorTypeHeatSensor (only applies to HEATSENSOR) Pset_SensorTypeHumiditySensor (only applies to HUMIDITYSENSOR) Pset_SensorTypeIdentifierSensor (only applies to IDENTIFIERSENSOR) Pset_SensorTypeIonConcentrationSensor (only applies to IONCONCENTRATIONSENSOR) Pset_SensorTypeLightSensor (only applies to LIGHTSENSOR) Pset_SensorTypeMoistureSensor (only applies to MOISTURESENSOR) Pset_SensorTypeMovementSensor (only applies to MOVEMENTSENSOR) Pset_SensorTypePHSensor (only applies to PHSENSOR) Pset_SensorTypePressureSensor (only applies to PRESSURESENSOR) Pset_SensorTypeRadiationSensor (only applies to RADIATIONSENSOR) Pset_SensorTypeRadioactivitySensor (only applies to RADIOACTIVITYSENSOR) Pset_SensorTypeRainSensor (only applies to RAINSENSOR) Pset_SensorTypeSmokeSensor (only applies to SMOKESENSOR) Pset_SensorTypeSnowSensor (only applies to SNOWDEPTHSENSOR) Pset_SensorTypeSoundSensor (only applies to SOUNDSENSOR) Pset_SensorTypeTemperatureSensor (only applies to TEMPERATURESENSOR) Pset_SensorTypeTurnoutClosureSensor (only applies to TURNOUTCLOSURESENSOR) Pset_AxleCountingEquipment (only applies to WHEELSENSOR) Pset_SensorTypeWindSensor (only applies to WINDSENSOR)
  • Property Sets for Performance - This concept can be applied to the following resources: Pset_SensorPHistory
  • Quantity Sets - This concept can be applied to the following resources: Qto_SensorBaseQuantities

Definition at line 101 of file Ifc4/IfcSensorAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSensor()

OdIfc4::IfcSensor::IfcSensor ( )

Default constructor for the IfcSensor class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ getPredefinedType()

IfcSensorTypeEnum OdIfc4::IfcSensor::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents types to further identify the object. Some property sets can be specifically applicable to one of these types.

Returns
Returns the value of PredefinedType attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ isKindOf()

virtual bool OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ outFields()

virtual OdResult OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ setPredefinedType()

void OdIfc4::IfcSensor::setPredefinedType ( IfcSensorTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents types to further identify the object. Some property sets can be specifically applicable to one of these types.

Parameters
PredefinedType[in] Predefined type to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcSensor::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4::IfcDistributionControlElement.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcSensor::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 OdIfc4::IfcDistributionControlElement.

Member Data Documentation

◆ m_PredefinedType

OdDAI::Enum OdIfc4::IfcSensor::m_PredefinedType
protected

Definition at line 261 of file Ifc4/IfcSensorAutoImpl.h.


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