Class Ifc4x1::IfcTimeSeries

Nested Relationships

This class is a nested type of Struct Ifc4x1.

Inheritance Relationships

Base Type

Derived Types

Class Documentation

class Ifc4x1::IfcTimeSeries : public IfcUtil::IfcBaseEntity

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 may arrive at unspecified points in time.

The modeling of buildings and their performance involves data that are generated and recorded over a period of time. Such data cover a large spectrum, from weather data to schedules of all kinds to status measurements to reporting to everything else that has a time related aspect. Their correct placement in time is essential for their proper understanding and use, and the IfcTimeSeries subtypes provide the appropriate data structures to accommodate these types of data.

HISTORY: New entity in IFC 2x2.

Subclassed by Ifc4x1::IfcIrregularTimeSeries, Ifc4x1::IfcRegularTimeSeries

Public Types

typedef IfcTemplatedEntityList<IfcTimeSeries> list

Public Functions

std::string Name() const

An unique name for the time series.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcTimeSeries.

std::string Description() const

A text description of the data that the series represents.

void setDescription(std::string v)
std::string StartTime() const

The start time of a time series.

void setStartTime(std::string v)
std::string EndTime() const

The end time of a time series.

void setEndTime(std::string v)
::Ifc4x1::IfcTimeSeriesDataTypeEnum::Value TimeSeriesDataType() const

The time series data type.

void setTimeSeriesDataType(::Ifc4x1::IfcTimeSeriesDataTypeEnum::Value v)
::Ifc4x1::IfcDataOriginEnum::Value DataOrigin() const

The orgin of a time series data.

void setDataOrigin(::Ifc4x1::IfcDataOriginEnum::Value v)
bool hasUserDefinedDataOrigin() const

Whether the optional attribute UserDefinedDataOrigin is defined for this IfcTimeSeries.

std::string UserDefinedDataOrigin() const

Value of the data origin if DataOrigin attribute is USERDEFINED.

void setUserDefinedDataOrigin(std::string v)
bool hasUnit() const

Whether the optional attribute Unit is defined for this IfcTimeSeries.

::Ifc4x1::IfcUnit *Unit() const

The unit to be assigned to all values within the time series. Note that mixing units is not allowed. If the value is not given, the global unit for the type of IfcValue, as defined at IfcProject.UnitsInContext is used.

void setUnit(::Ifc4x1::IfcUnit *v)
IfcTemplatedEntityList<IfcExternalReferenceRelationship>::ptr HasExternalReference() const
const IfcParse::entity &declaration() const
IfcTimeSeries(IfcEntityInstanceData *e)
IfcTimeSeries(std::string v1_Name, boost::optional<std::string> v2_Description, std::string v3_StartTime, std::string v4_EndTime, ::Ifc4x1::IfcTimeSeriesDataTypeEnum::Value v5_TimeSeriesDataType, ::Ifc4x1::IfcDataOriginEnum::Value v6_DataOrigin, boost::optional<std::string> v7_UserDefinedDataOrigin, ::Ifc4x1::IfcUnit *v8_Unit)

Public Static Functions

const IfcParse::entity &Class()