#include <IfcProtectiveDeviceAutoImpl.h>

Inheritance diagram for OdIfc4x3_rc1::IfcProtectiveDevice:

Public Member Functions
IfcProtectiveDeviceTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcProtectiveDeviceTypeEnum PredefinedType)

	IfcProtectiveDevice ()

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 OdIfc4x3_rc1::IfcDistributionFlowElement
void	getInvHasControlElements (OdDAIObjectIds &HasControlElements) const

Public Member Functions inherited from OdIfc4x3_rc1::IfcDistributionElement
void	getInvHasPorts (OdDAIObjectIds &HasPorts) const

Public Member Functions inherited from OdIfc4x3_rc1::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	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 OdIfc4x3_rc1::IfcProduct
const OdDAIObjectId &	getObjectPlacement () const

void	setObjectPlacement (const OdDAIObjectId &ObjectPlacement)

const OdDAIObjectId &	getRepresentation () const

void	setRepresentation (const OdDAIObjectId &Representation)

void	getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const

void	getInvPositionedRelativeTo (OdDAIObjectIds &PositionedRelativeTo) const

void	getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const

virtual void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc4x3_rc1::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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::OdIfc4x3_RC1Instance
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::Enum	m_PredefinedType

Protected Attributes inherited from OdIfc4x3_rc1::IfcElement
OdAnsiString	m_Tag

Protected Attributes inherited from OdIfc4x3_rc1::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc4x3_rc1::IfcObject
OdAnsiString	m_ObjectType

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

A protective device breaks an electrical circuit when a stated electric current that passes through it is exceeded.

A protective device provides protection against electrical current only (not as a general protective device). It can be used to represent the complete set of elements including both the tripping unit and the breaking unit that provide the protection. This can be particularly useful at earlier stages of design where the approach to breaking the electrical supply may be determined but the method of tripping may not. Alternatively, this entity can be used to represent the breaking unit alone (in which case the tripping unit will also be specifically identified). This entity is specific to dedicated protective devices and excludes electrical outlets that can have circuit protection.

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: IfcProtectiveDeviceType
Port Nesting - This concept can be applied with the following combinations:

PortName

Flow PredefinedType Line SINK ELECTRICAL Load SOURCE ELECTRICAL

Property Sets for Objects - This concept can be applied to the following resources: Pset_ProtectiveDeviceBreakerUnitI2TCurve Pset_ProtectiveDeviceBreakerUnitI2TFuseCurve Pset_ProtectiveDeviceBreakerUnitIPICurve Pset_ProtectiveDeviceBreakerUnitTypeMotorProtection Pset_ProtectiveDeviceOccurrence Pset_ProtectiveDeviceTrippingCurve Pset_ProtectiveDeviceTypeCommon Pset_ProtectiveDeviceTypeAntiArcingDevice (only applies to ANTI_ARCING_DEVICE) Pset_ProtectiveDeviceBreakerUnitTypeMCB (only applies to CIRCUITBREAKER) Pset_ProtectiveDeviceTypeCircuitBreaker (only applies to CIRCUITBREAKER) Pset_ProtectiveDeviceTypeEarthLeakageCircuitBreaker (only applies to EARTHLEAKAGECIRCUITBREAKER) Pset_ProtectiveDeviceTypeFuseDisconnector (only applies to FUSEDISCONNECTOR) Pset_ProtectiveDeviceTypeResidualCurrentCircuitBreaker (only applies to RESIDUALCURRENTCIRCUITBREAKER) Pset_ProtectiveDeviceTypeResidualCurrentSwitch (only applies to RESIDUALCURRENTSWITCH) Pset_ProtectiveDeviceTypeSparkGap (only applies to SPARKGAP) Pset_ProtectiveDeviceTypeSparkGap (only applies to VOLTAGELIMITER) Pset_ProtectiveDeviceTypeVaristor (only applies to VARISTOR)
Quantity Sets - This concept can be applied to the following resources: Qto_ProtectiveDeviceBaseQuantities

Definition at line 86 of file Ifc4x3_RC1/IfcProtectiveDeviceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcProtectiveDevice()

OdIfc4x3_rc1::IfcProtectiveDevice::IfcProtectiveDevice ( )

Default constructor for the IfcProtectiveDevice class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcFlowController.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcDistributionFlowElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcDistributionFlowElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcFlowController.

◆ getPredefinedType()

IfcProtectiveDeviceTypeEnum OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcDistributionFlowElement.

◆ isKindOf()

virtual bool OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcFlowController.

◆ outFields()

virtual OdResult OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcDistributionFlowElement.

◆ putAttr() [1/2]

virtual bool OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcDistributionFlowElement.

◆ putAttr() [2/2]

virtual bool OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcDistributionFlowElement.

◆ setPredefinedType()

void OdIfc4x3_rc1::IfcProtectiveDevice::setPredefinedType ( IfcProtectiveDeviceTypeEnum 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 OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcDistributionFlowElement.

◆ testAttr() [2/2]

virtual bool OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcDistributionFlowElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcFlowController.

◆ unsetAttr() [1/2]

virtual void OdIfc4x3_rc1::IfcProtectiveDevice::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x3_rc1::IfcDistributionFlowElement.

◆ unsetAttr() [2/2]

virtual void OdIfc4x3_rc1::IfcProtectiveDevice::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 OdIfc4x3_rc1::IfcDistributionFlowElement.

Member Data Documentation

◆ m_PredefinedType

OdDAI::Enum OdIfc4x3_rc1::IfcProtectiveDevice::m_PredefinedType

protected

Definition at line 246 of file Ifc4x3_RC1/IfcProtectiveDeviceAutoImpl.h.

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

Ifc4x3_RC1/IfcProtectiveDeviceAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcProtectiveDevice()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getPredefinedType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setPredefinedType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_PredefinedType