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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pluginbase Show documentation
Base project for BIMserver plugin development. Some plugins mights also need the Shared library
The newest version!
/**
 * 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;

/**
 * 
 * A representation of the model object 'Ifc Rel Sequence'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcRelSequence#getRelatingProcess Relating Process}
 *   {@link org.bimserver.models.ifc4.IfcRelSequence#getRelatedProcess Related Process}
 *   {@link org.bimserver.models.ifc4.IfcRelSequence#getTimeLag Time Lag}
 *   {@link org.bimserver.models.ifc4.IfcRelSequence#getSequenceType Sequence Type}
 *   {@link org.bimserver.models.ifc4.IfcRelSequence#getUserDefinedSequenceType User Defined Sequence Type}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelSequence()
 * @model
 * @generated
 */
public interface IfcRelSequence extends IfcRelConnects {
	/**
	 * Returns the value of the 'Relating Process' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcProcess#getIsPredecessorTo Is Predecessor To}'.
	 * 
	 * 
	 * If the meaning of the 'Relating Process' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Relating Process' reference.
	 * @see #setRelatingProcess(IfcProcess)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelSequence_RelatingProcess()
	 * @see org.bimserver.models.ifc4.IfcProcess#getIsPredecessorTo
	 * @model opposite="IsPredecessorTo"
	 * @generated
	 */
	IfcProcess getRelatingProcess();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getRelatingProcess Relating Process}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Relating Process' reference.
	 * @see #getRelatingProcess()
	 * @generated
	 */
	void setRelatingProcess(IfcProcess value);

	/**
	 * Returns the value of the 'Related Process' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcProcess#getIsSuccessorFrom Is Successor From}'.
	 * 
	 * 
	 * If the meaning of the 'Related Process' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Related Process' reference.
	 * @see #setRelatedProcess(IfcProcess)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelSequence_RelatedProcess()
	 * @see org.bimserver.models.ifc4.IfcProcess#getIsSuccessorFrom
	 * @model opposite="IsSuccessorFrom"
	 * @generated
	 */
	IfcProcess getRelatedProcess();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getRelatedProcess Related Process}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Related Process' reference.
	 * @see #getRelatedProcess()
	 * @generated
	 */
	void setRelatedProcess(IfcProcess value);

	/**
	 * Returns the value of the 'Time Lag' reference.
	 * 
	 * 
	 * If the meaning of the 'Time Lag' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Time Lag' reference.
	 * @see #isSetTimeLag()
	 * @see #unsetTimeLag()
	 * @see #setTimeLag(IfcLagTime)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelSequence_TimeLag()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcLagTime getTimeLag();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getTimeLag Time Lag}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Time Lag' reference.
	 * @see #isSetTimeLag()
	 * @see #unsetTimeLag()
	 * @see #getTimeLag()
	 * @generated
	 */
	void setTimeLag(IfcLagTime value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getTimeLag Time Lag}' reference.
	 * 
	 * 
	 * @see #isSetTimeLag()
	 * @see #getTimeLag()
	 * @see #setTimeLag(IfcLagTime)
	 * @generated
	 */
	void unsetTimeLag();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getTimeLag Time Lag}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Time Lag' reference is set.
	 * @see #unsetTimeLag()
	 * @see #getTimeLag()
	 * @see #setTimeLag(IfcLagTime)
	 * @generated
	 */
	boolean isSetTimeLag();

	/**
	 * Returns the value of the 'Sequence Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcSequenceEnum}.
	 * 
	 * 
	 * If the meaning of the 'Sequence Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Sequence Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcSequenceEnum
	 * @see #isSetSequenceType()
	 * @see #unsetSequenceType()
	 * @see #setSequenceType(IfcSequenceEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelSequence_SequenceType()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcSequenceEnum getSequenceType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getSequenceType Sequence Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Sequence Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcSequenceEnum
	 * @see #isSetSequenceType()
	 * @see #unsetSequenceType()
	 * @see #getSequenceType()
	 * @generated
	 */
	void setSequenceType(IfcSequenceEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getSequenceType Sequence Type}' attribute.
	 * 
	 * 
	 * @see #isSetSequenceType()
	 * @see #getSequenceType()
	 * @see #setSequenceType(IfcSequenceEnum)
	 * @generated
	 */
	void unsetSequenceType();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getSequenceType Sequence Type}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Sequence Type' attribute is set.
	 * @see #unsetSequenceType()
	 * @see #getSequenceType()
	 * @see #setSequenceType(IfcSequenceEnum)
	 * @generated
	 */
	boolean isSetSequenceType();

	/**
	 * Returns the value of the 'User Defined Sequence Type' attribute.
	 * 
	 * 
	 * If the meaning of the 'User Defined Sequence Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User Defined Sequence Type' attribute.
	 * @see #isSetUserDefinedSequenceType()
	 * @see #unsetUserDefinedSequenceType()
	 * @see #setUserDefinedSequenceType(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelSequence_UserDefinedSequenceType()
	 * @model unsettable="true"
	 * @generated
	 */
	String getUserDefinedSequenceType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getUserDefinedSequenceType User Defined Sequence Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'User Defined Sequence Type' attribute.
	 * @see #isSetUserDefinedSequenceType()
	 * @see #unsetUserDefinedSequenceType()
	 * @see #getUserDefinedSequenceType()
	 * @generated
	 */
	void setUserDefinedSequenceType(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getUserDefinedSequenceType User Defined Sequence Type}' attribute.
	 * 
	 * 
	 * @see #isSetUserDefinedSequenceType()
	 * @see #getUserDefinedSequenceType()
	 * @see #setUserDefinedSequenceType(String)
	 * @generated
	 */
	void unsetUserDefinedSequenceType();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRelSequence#getUserDefinedSequenceType User Defined Sequence Type}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'User Defined Sequence Type' attribute is set.
	 * @see #unsetUserDefinedSequenceType()
	 * @see #getUserDefinedSequenceType()
	 * @see #setUserDefinedSequenceType(String)
	 * @generated
	 */
	boolean isSetUserDefinedSequenceType();

} // IfcRelSequence