#include <IfcRegularTimeSeriesAutoImpl.h>

Inheritance diagram for OdIfc4::IfcRegularTimeSeries:

Public Member Functions
double	getTimeStep () const

void	setTimeStep (double TimeStep)

void	getValues (OdDAIObjectIds &Values) const

OdDAI::ListOfOdDAIObjectId &	values ()

	IfcRegularTimeSeries ()

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

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

const OdAnsiString &	getStartTime () const

void	setStartTime (const OdAnsiString &StartTime)

const OdAnsiString &	getEndTime () const

void	setEndTime (const OdAnsiString &EndTime)

IfcTimeSeriesDataTypeEnum	getTimeSeriesDataType () const

void	setTimeSeriesDataType (IfcTimeSeriesDataTypeEnum TimeSeriesDataType)

IfcDataOriginEnum	getDataOrigin () const

void	setDataOrigin (IfcDataOriginEnum DataOrigin)

const OdAnsiString &	getUserDefinedDataOrigin () const

void	setUserDefinedDataOrigin (const OdAnsiString &UserDefinedDataOrigin)

IfcUnit	unit ()

void	getInvHasExternalReference (OdDAIObjectIds &HasExternalReference) const

	IfcTimeSeries ()

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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
double	m_TimeStep

OdDAI::ListOfOdDAIObjectId	m_Values

Protected Attributes inherited from OdIfc4::IfcTimeSeries
OdAnsiString	m_Name

OdAnsiString	m_Description

OdAnsiString	m_StartTime

OdAnsiString	m_EndTime

OdDAI::Enum	m_TimeSeriesDataType

OdDAI::Enum	m_DataOrigin

OdAnsiString	m_UserDefinedDataOrigin

OdDAI::Select	m_Unit

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

In regular time series, the data arrives predictably at predefined intervals. In regular time series there is no need to store multiple time stamps and the algorithms for analyzing the time series are significantly simpler. Using the start time provided in the supertype, the time step identifies the frequency of the occurrences of the list of values.

Definition at line 43 of file Ifc4/IfcRegularTimeSeriesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRegularTimeSeries()

OdIfc4::IfcRegularTimeSeries::IfcRegularTimeSeries ( )

Default constructor for the IfcRegularTimeSeries class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ getTimeStep()

double OdIfc4::IfcRegularTimeSeries::getTimeStep ( ) const

Returns the value of TimeStep attribute. This attribute represents a duration of time intervals between values.

Returns: Returns the value of TimeStep attribute.

◆ getValues()

void OdIfc4::IfcRegularTimeSeries::getValues ( OdDAIObjectIds & Values ) const

Gets the value of Values attribute. This attribute represents the collection of time series values.

Parameters

Values [out] Receives the values.

◆ inFields()

virtual OdResult OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ isKindOf()

virtual bool OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ outFields()

virtual OdResult OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ setTimeStep()

void OdIfc4::IfcRegularTimeSeries::setTimeStep ( double TimeStep )

Sets the value of TimeStep attribute. This attribute represents a duration of time intervals between values.

Parameters

TimeStep [in] Time step to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcRegularTimeSeries::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::IfcTimeSeries.

◆ values()

OdDAI::ListOfOdDAIObjectId & OdIfc4::IfcRegularTimeSeries::values ( )

Returns the value of Values attribute. This attribute represents the collection of time series values.

Returns: Returns the value of Values attribute.

Member Data Documentation

◆ m_TimeStep

double OdIfc4::IfcRegularTimeSeries::m_TimeStep

protected

Definition at line 216 of file Ifc4/IfcRegularTimeSeriesAutoImpl.h.

◆ m_Values

OdDAI::ListOfOdDAIObjectId OdIfc4::IfcRegularTimeSeries::m_Values

protected

Definition at line 217 of file Ifc4/IfcRegularTimeSeriesAutoImpl.h.

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

Ifc4/IfcRegularTimeSeriesAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcRegularTimeSeries()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getTimeStep()

◆ getValues()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setTimeStep()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

◆ values()

Member Data Documentation

◆ m_TimeStep

◆ m_Values