org.bimserver.models.ifc4.IfcTimeSeries Maven / Gradle / Ivy

/**
 * Copyright (C) 2009-2014 BIMserver.org
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package org.bimserver.models.ifc4;

import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Ifc Time Series'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcTimeSeries#getName Name}
 *   {@link org.bimserver.models.ifc4.IfcTimeSeries#getDescription Description}
 *   {@link org.bimserver.models.ifc4.IfcTimeSeries#getStartTime Start Time}
 *   {@link org.bimserver.models.ifc4.IfcTimeSeries#getEndTime End Time}
 *   {@link org.bimserver.models.ifc4.IfcTimeSeries#getTimeSeriesDataType Time Series Data Type}
 *   {@link org.bimserver.models.ifc4.IfcTimeSeries#getDataOrigin Data Origin}
 *   {@link org.bimserver.models.ifc4.IfcTimeSeries#getUserDefinedDataOrigin User Defined Data Origin}
 *   {@link org.bimserver.models.ifc4.IfcTimeSeries#getUnit Unit}
 *   {@link org.bimserver.models.ifc4.IfcTimeSeries#getHasExternalReference Has External Reference}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries()
 * @model
 * @generated
 */
public interface IfcTimeSeries extends IfcMetricValueSelect, IfcObjectReferenceSelect, IfcResourceObjectSelect {
	/**
	 * Returns the value of the 'Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Name' attribute.
	 * @see #setName(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries_Name()
	 * @model
	 * @generated
	 */
	String getName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getName Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Name' attribute.
	 * @see #getName()
	 * @generated
	 */
	void setName(String value);

	/**
	 * Returns the value of the 'Description' attribute.
	 * 
	 * 
	 * If the meaning of the 'Description' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Description' attribute.
	 * @see #isSetDescription()
	 * @see #unsetDescription()
	 * @see #setDescription(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries_Description()
	 * @model unsettable="true"
	 * @generated
	 */
	String getDescription();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getDescription Description}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Description' attribute.
	 * @see #isSetDescription()
	 * @see #unsetDescription()
	 * @see #getDescription()
	 * @generated
	 */
	void setDescription(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getDescription Description}' attribute.
	 * 
	 * 
	 * @see #isSetDescription()
	 * @see #getDescription()
	 * @see #setDescription(String)
	 * @generated
	 */
	void unsetDescription();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getDescription Description}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Description' attribute is set.
	 * @see #unsetDescription()
	 * @see #getDescription()
	 * @see #setDescription(String)
	 * @generated
	 */
	boolean isSetDescription();

	/**
	 * Returns the value of the 'Start Time' attribute.
	 * 
	 * 
	 * If the meaning of the 'Start Time' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Start Time' attribute.
	 * @see #setStartTime(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries_StartTime()
	 * @model
	 * @generated
	 */
	String getStartTime();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getStartTime Start Time}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Start Time' attribute.
	 * @see #getStartTime()
	 * @generated
	 */
	void setStartTime(String value);

	/**
	 * Returns the value of the 'End Time' attribute.
	 * 
	 * 
	 * If the meaning of the 'End Time' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'End Time' attribute.
	 * @see #setEndTime(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries_EndTime()
	 * @model
	 * @generated
	 */
	String getEndTime();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getEndTime End Time}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'End Time' attribute.
	 * @see #getEndTime()
	 * @generated
	 */
	void setEndTime(String value);

	/**
	 * Returns the value of the 'Time Series Data Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcTimeSeriesDataTypeEnum}.
	 * 
	 * 
	 * If the meaning of the 'Time Series Data Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Time Series Data Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcTimeSeriesDataTypeEnum
	 * @see #setTimeSeriesDataType(IfcTimeSeriesDataTypeEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries_TimeSeriesDataType()
	 * @model
	 * @generated
	 */
	IfcTimeSeriesDataTypeEnum getTimeSeriesDataType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getTimeSeriesDataType Time Series Data Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Time Series Data Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcTimeSeriesDataTypeEnum
	 * @see #getTimeSeriesDataType()
	 * @generated
	 */
	void setTimeSeriesDataType(IfcTimeSeriesDataTypeEnum value);

	/**
	 * Returns the value of the 'Data Origin' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcDataOriginEnum}.
	 * 
	 * 
	 * If the meaning of the 'Data Origin' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Data Origin' attribute.
	 * @see org.bimserver.models.ifc4.IfcDataOriginEnum
	 * @see #setDataOrigin(IfcDataOriginEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries_DataOrigin()
	 * @model
	 * @generated
	 */
	IfcDataOriginEnum getDataOrigin();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getDataOrigin Data Origin}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Data Origin' attribute.
	 * @see org.bimserver.models.ifc4.IfcDataOriginEnum
	 * @see #getDataOrigin()
	 * @generated
	 */
	void setDataOrigin(IfcDataOriginEnum value);

	/**
	 * Returns the value of the 'User Defined Data Origin' attribute.
	 * 
	 * 
	 * If the meaning of the 'User Defined Data Origin' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User Defined Data Origin' attribute.
	 * @see #isSetUserDefinedDataOrigin()
	 * @see #unsetUserDefinedDataOrigin()
	 * @see #setUserDefinedDataOrigin(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries_UserDefinedDataOrigin()
	 * @model unsettable="true"
	 * @generated
	 */
	String getUserDefinedDataOrigin();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getUserDefinedDataOrigin User Defined Data Origin}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'User Defined Data Origin' attribute.
	 * @see #isSetUserDefinedDataOrigin()
	 * @see #unsetUserDefinedDataOrigin()
	 * @see #getUserDefinedDataOrigin()
	 * @generated
	 */
	void setUserDefinedDataOrigin(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getUserDefinedDataOrigin User Defined Data Origin}' attribute.
	 * 
	 * 
	 * @see #isSetUserDefinedDataOrigin()
	 * @see #getUserDefinedDataOrigin()
	 * @see #setUserDefinedDataOrigin(String)
	 * @generated
	 */
	void unsetUserDefinedDataOrigin();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getUserDefinedDataOrigin User Defined Data Origin}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'User Defined Data Origin' attribute is set.
	 * @see #unsetUserDefinedDataOrigin()
	 * @see #getUserDefinedDataOrigin()
	 * @see #setUserDefinedDataOrigin(String)
	 * @generated
	 */
	boolean isSetUserDefinedDataOrigin();

	/**
	 * Returns the value of the 'Unit' reference.
	 * 
	 * 
	 * If the meaning of the 'Unit' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Unit' reference.
	 * @see #isSetUnit()
	 * @see #unsetUnit()
	 * @see #setUnit(IfcUnit)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries_Unit()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcUnit getUnit();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getUnit Unit}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Unit' reference.
	 * @see #isSetUnit()
	 * @see #unsetUnit()
	 * @see #getUnit()
	 * @generated
	 */
	void setUnit(IfcUnit value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getUnit Unit}' reference.
	 * 
	 * 
	 * @see #isSetUnit()
	 * @see #getUnit()
	 * @see #setUnit(IfcUnit)
	 * @generated
	 */
	void unsetUnit();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getUnit Unit}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Unit' reference is set.
	 * @see #unsetUnit()
	 * @see #getUnit()
	 * @see #setUnit(IfcUnit)
	 * @generated
	 */
	boolean isSetUnit();

	/**
	 * Returns the value of the 'Has External Reference' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcExternalReferenceRelationship}.
	 * 
	 * 
	 * If the meaning of the 'Has External Reference' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has External Reference' reference list.
	 * @see #isSetHasExternalReference()
	 * @see #unsetHasExternalReference()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcTimeSeries_HasExternalReference()
	 * @model unsettable="true"
	 * @generated
	 */
	EList getHasExternalReference();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getHasExternalReference Has External Reference}' reference list.
	 * 
	 * 
	 * @see #isSetHasExternalReference()
	 * @see #getHasExternalReference()
	 * @generated
	 */
	void unsetHasExternalReference();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcTimeSeries#getHasExternalReference Has External Reference}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has External Reference' reference list is set.
	 * @see #unsetHasExternalReference()
	 * @see #getHasExternalReference()
	 * @generated
	 */
	boolean isSetHasExternalReference();

} // IfcTimeSeries