org.bimserver.models.ifc4.IfcStructuralAnalysisModel 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;

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

/**
 * 
 * A representation of the model object 'Ifc Structural Analysis Model'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getPredefinedType Predefined Type}
 *   {@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getOrientationOf2DPlane Orientation Of2 DPlane}
 *   {@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getLoadedBy Loaded By}
 *   {@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getHasResults Has Results}
 *   {@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getSharedPlacement Shared Placement}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcStructuralAnalysisModel()
 * @model
 * @generated
 */
public interface IfcStructuralAnalysisModel extends IfcSystem {
	/**
	 * Returns the value of the 'Predefined Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcAnalysisModelTypeEnum}.
	 * 
	 * 
	 * If the meaning of the 'Predefined Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Predefined Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcAnalysisModelTypeEnum
	 * @see #setPredefinedType(IfcAnalysisModelTypeEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcStructuralAnalysisModel_PredefinedType()
	 * @model
	 * @generated
	 */
	IfcAnalysisModelTypeEnum getPredefinedType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getPredefinedType Predefined Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Predefined Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcAnalysisModelTypeEnum
	 * @see #getPredefinedType()
	 * @generated
	 */
	void setPredefinedType(IfcAnalysisModelTypeEnum value);

	/**
	 * Returns the value of the 'Orientation Of2 DPlane' reference.
	 * 
	 * 
	 * If the meaning of the 'Orientation Of2 DPlane' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Orientation Of2 DPlane' reference.
	 * @see #isSetOrientationOf2DPlane()
	 * @see #unsetOrientationOf2DPlane()
	 * @see #setOrientationOf2DPlane(IfcAxis2Placement3D)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcStructuralAnalysisModel_OrientationOf2DPlane()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcAxis2Placement3D getOrientationOf2DPlane();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getOrientationOf2DPlane Orientation Of2 DPlane}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Orientation Of2 DPlane' reference.
	 * @see #isSetOrientationOf2DPlane()
	 * @see #unsetOrientationOf2DPlane()
	 * @see #getOrientationOf2DPlane()
	 * @generated
	 */
	void setOrientationOf2DPlane(IfcAxis2Placement3D value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getOrientationOf2DPlane Orientation Of2 DPlane}' reference.
	 * 
	 * 
	 * @see #isSetOrientationOf2DPlane()
	 * @see #getOrientationOf2DPlane()
	 * @see #setOrientationOf2DPlane(IfcAxis2Placement3D)
	 * @generated
	 */
	void unsetOrientationOf2DPlane();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getOrientationOf2DPlane Orientation Of2 DPlane}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Orientation Of2 DPlane' reference is set.
	 * @see #unsetOrientationOf2DPlane()
	 * @see #getOrientationOf2DPlane()
	 * @see #setOrientationOf2DPlane(IfcAxis2Placement3D)
	 * @generated
	 */
	boolean isSetOrientationOf2DPlane();

	/**
	 * Returns the value of the 'Loaded By' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcStructuralLoadGroup}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcStructuralLoadGroup#getLoadGroupFor Load Group For}'.
	 * 
	 * 
	 * If the meaning of the 'Loaded By' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Loaded By' reference list.
	 * @see #isSetLoadedBy()
	 * @see #unsetLoadedBy()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcStructuralAnalysisModel_LoadedBy()
	 * @see org.bimserver.models.ifc4.IfcStructuralLoadGroup#getLoadGroupFor
	 * @model opposite="LoadGroupFor" unsettable="true"
	 * @generated
	 */
	EList getLoadedBy();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getLoadedBy Loaded By}' reference list.
	 * 
	 * 
	 * @see #isSetLoadedBy()
	 * @see #getLoadedBy()
	 * @generated
	 */
	void unsetLoadedBy();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getLoadedBy Loaded By}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Loaded By' reference list is set.
	 * @see #unsetLoadedBy()
	 * @see #getLoadedBy()
	 * @generated
	 */
	boolean isSetLoadedBy();

	/**
	 * Returns the value of the 'Has Results' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcStructuralResultGroup}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcStructuralResultGroup#getResultGroupFor Result Group For}'.
	 * 
	 * 
	 * If the meaning of the 'Has Results' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Results' reference list.
	 * @see #isSetHasResults()
	 * @see #unsetHasResults()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcStructuralAnalysisModel_HasResults()
	 * @see org.bimserver.models.ifc4.IfcStructuralResultGroup#getResultGroupFor
	 * @model opposite="ResultGroupFor" unsettable="true"
	 * @generated
	 */
	EList getHasResults();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getHasResults Has Results}' reference list.
	 * 
	 * 
	 * @see #isSetHasResults()
	 * @see #getHasResults()
	 * @generated
	 */
	void unsetHasResults();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getHasResults Has Results}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has Results' reference list is set.
	 * @see #unsetHasResults()
	 * @see #getHasResults()
	 * @generated
	 */
	boolean isSetHasResults();

	/**
	 * Returns the value of the 'Shared Placement' reference.
	 * 
	 * 
	 * If the meaning of the 'Shared Placement' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Shared Placement' reference.
	 * @see #isSetSharedPlacement()
	 * @see #unsetSharedPlacement()
	 * @see #setSharedPlacement(IfcObjectPlacement)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcStructuralAnalysisModel_SharedPlacement()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcObjectPlacement getSharedPlacement();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getSharedPlacement Shared Placement}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Shared Placement' reference.
	 * @see #isSetSharedPlacement()
	 * @see #unsetSharedPlacement()
	 * @see #getSharedPlacement()
	 * @generated
	 */
	void setSharedPlacement(IfcObjectPlacement value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getSharedPlacement Shared Placement}' reference.
	 * 
	 * 
	 * @see #isSetSharedPlacement()
	 * @see #getSharedPlacement()
	 * @see #setSharedPlacement(IfcObjectPlacement)
	 * @generated
	 */
	void unsetSharedPlacement();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStructuralAnalysisModel#getSharedPlacement Shared Placement}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Shared Placement' reference is set.
	 * @see #unsetSharedPlacement()
	 * @see #getSharedPlacement()
	 * @see #setSharedPlacement(IfcObjectPlacement)
	 * @generated
	 */
	boolean isSetSharedPlacement();

} // IfcStructuralAnalysisModel