#include <IfcTimeSeriesAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcTimeSeries:

Public Member Functions
const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

IfcDateTimeSelect	startTime ()

IfcDateTimeSelect	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	getInvDocumentedBy (OdDAIObjectIds &DocumentedBy) const

	IfcTimeSeries ()

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::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
OdAnsiString	m_Name

OdAnsiString	m_Description

OdDAI::Select	m_StartTime

OdDAI::Select	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

Friends
class	IfcTimeSeriesReferenceRelationship

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 time series is a set of a time-stamped data entries. It allows a natural association of data collected over intervals of time. Time series can be regular or irregular. In regular time series data arrive predictably at predefined intervals. In irregular time series some or all time stamps do not follow a repetitive pattern and unpredictable bursts of data can arrive at unspecified points in time.

Remarks: This definition may not be instantiated

Definition at line 51 of file Ifc2x3/IfcTimeSeriesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcTimeSeries()

OdIfc2x3::IfcTimeSeries::IfcTimeSeries ( )

Default constructor for the IfcTimeSeries class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcTimeSeries::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 in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ endTime()

IfcDateTimeSelect OdIfc2x3::IfcTimeSeries::endTime ( )

Returns the value of EndTime attribute. This attribute represents the end time of a time series.

Returns: Returns the value of EndTime attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcTimeSeries::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 in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcTimeSeries::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ getDataOrigin()

IfcDataOriginEnum OdIfc2x3::IfcTimeSeries::getDataOrigin ( ) const

Returns the value of DataOrigin attribute. This attribute represents the origin of a time series data.

Returns: Returns the value of DataOrigin attribute.

◆ getDescription()

const OdAnsiString & OdIfc2x3::IfcTimeSeries::getDescription ( ) const

Returns the value of Description attribute. This attribute represents a text description of the data that the series represents.

Returns: Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcTimeSeries::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 in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ getInvDocumentedBy()

void OdIfc2x3::IfcTimeSeries::getInvDocumentedBy ( OdDAIObjectIds & DocumentedBy ) const

◆ getName()

const OdAnsiString & OdIfc2x3::IfcTimeSeries::getName ( ) const

Returns the value of Name attribute. This attribute represents an unique name for the time series.

Returns: Returns the value of Name attribute.

◆ getTimeSeriesDataType()

IfcTimeSeriesDataTypeEnum OdIfc2x3::IfcTimeSeries::getTimeSeriesDataType ( ) const

Returns the value of TimeSeriesDataType attribute. This attribute represents the time series data type.

Returns: Returns the value of TimeSeriesDataType attribute.

◆ getUserDefinedDataOrigin()

const OdAnsiString & OdIfc2x3::IfcTimeSeries::getUserDefinedDataOrigin ( ) const

Returns the value of UserDefinedDataOrigin attribute. This attribute represents value of the data origin if DataOrigin attribute is USERDEFINED.

Returns: Returns the value of UserDefinedDataOrigin attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcTimeSeries::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 in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ isKindOf()

virtual bool OdIfc2x3::IfcTimeSeries::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ outFields()

virtual OdResult OdIfc2x3::IfcTimeSeries::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 in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcTimeSeries::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcTimeSeries::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ setDataOrigin()

void OdIfc2x3::IfcTimeSeries::setDataOrigin ( IfcDataOriginEnum DataOrigin )

Sets the value of DataOrigin attribute. This attribute represents the origin of a time series data.

Parameters

DataOrigin [in] Data origin to set.

◆ setDescription()

void OdIfc2x3::IfcTimeSeries::setDescription ( const OdAnsiString & Description )

Sets the value of Description attribute. This attribute represents a text description of the data that the series represents.

Parameters

Description [in] Description to set.

◆ setName()

void OdIfc2x3::IfcTimeSeries::setName ( const OdAnsiString & Name )

Sets the value of Name attribute. This attribute represents an unique name for the time series.

Parameters

Name	[in] Name to set.

◆ setTimeSeriesDataType()

void OdIfc2x3::IfcTimeSeries::setTimeSeriesDataType ( IfcTimeSeriesDataTypeEnum TimeSeriesDataType )

Sets the value of TimeSeriesDataType attribute. This attribute represents the time series data type.

Parameters

TimeSeriesDataType [in] Time series data type to set.

◆ setUserDefinedDataOrigin()

void OdIfc2x3::IfcTimeSeries::setUserDefinedDataOrigin ( const OdAnsiString & UserDefinedDataOrigin )

Sets the value of UserDefinedDataOrigin attribute. This attribute represents value of the data origin if DataOrigin attribute is USERDEFINED.

Parameters

UserDefinedDataOrigin [in] UserDefinedDataOrigin to set.

◆ startTime()

IfcDateTimeSelect OdIfc2x3::IfcTimeSeries::startTime ( )

Returns the value of StartTime attribute. This attribute represents the start time of a time series.

Returns: Returns the value of StartTime attribute.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcTimeSeries::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcTimeSeries::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcTimeSeries::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ unit()

IfcUnit OdIfc2x3::IfcTimeSeries::unit ( )

Returns the value of Unit attribute. This attribute represents the unit to be assigned to all values within the time series.

Returns: Returns the value of Unit attribute.

Remarks: Mixing units is not allowed. If the value is not provided, the global unit for the type of IfcValue, as defined at IfcProject.UnitsInContext is used.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcTimeSeries::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcTimeSeries::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcIrregularTimeSeries, and OdIfc2x3::IfcRegularTimeSeries.

Friends And Related Symbol Documentation

◆ IfcTimeSeriesReferenceRelationship

friend class IfcTimeSeriesReferenceRelationship

friend

Definition at line 307 of file Ifc2x3/IfcTimeSeriesAutoImpl.h.

Member Data Documentation

◆ m_DataOrigin

OdDAI::Enum OdIfc2x3::IfcTimeSeries::m_DataOrigin

protected

Definition at line 302 of file Ifc2x3/IfcTimeSeriesAutoImpl.h.

◆ m_Description

OdAnsiString OdIfc2x3::IfcTimeSeries::m_Description

protected

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

◆ m_EndTime

OdDAI::Select OdIfc2x3::IfcTimeSeries::m_EndTime

protected

Definition at line 300 of file Ifc2x3/IfcTimeSeriesAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc2x3::IfcTimeSeries::m_Name

protected

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

◆ m_StartTime

OdDAI::Select OdIfc2x3::IfcTimeSeries::m_StartTime

protected

Definition at line 299 of file Ifc2x3/IfcTimeSeriesAutoImpl.h.

◆ m_TimeSeriesDataType

OdDAI::Enum OdIfc2x3::IfcTimeSeries::m_TimeSeriesDataType

protected

Definition at line 301 of file Ifc2x3/IfcTimeSeriesAutoImpl.h.

◆ m_Unit

OdDAI::Select OdIfc2x3::IfcTimeSeries::m_Unit

protected

Definition at line 304 of file Ifc2x3/IfcTimeSeriesAutoImpl.h.

◆ m_UserDefinedDataOrigin

OdAnsiString OdIfc2x3::IfcTimeSeries::m_UserDefinedDataOrigin

protected

Definition at line 303 of file Ifc2x3/IfcTimeSeriesAutoImpl.h.

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

Ifc2x3/IfcTimeSeriesAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcTimeSeries()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ endTime()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getDataOrigin()

◆ getDescription()

◆ getInstanceType()

◆ getInvDocumentedBy()

◆ getName()

◆ getTimeSeriesDataType()

◆ getUserDefinedDataOrigin()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setDataOrigin()

◆ setDescription()

◆ setName()

◆ setTimeSeriesDataType()

◆ setUserDefinedDataOrigin()

◆ startTime()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unit()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcTimeSeriesReferenceRelationship

Member Data Documentation

◆ m_DataOrigin

◆ m_Description

◆ m_EndTime

◆ m_Name

◆ m_StartTime

◆ m_TimeSeriesDataType

◆ m_Unit

◆ m_UserDefinedDataOrigin