org.bimserver.models.ifc4.IfcLocalPlacement 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 Local Placement'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcLocalPlacement#getPlacementRelTo Placement Rel To}
 *   {@link org.bimserver.models.ifc4.IfcLocalPlacement#getRelativePlacement Relative Placement}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLocalPlacement()
 * @model
 * @generated
 */
public interface IfcLocalPlacement extends IfcObjectPlacement {
	/**
	 * Returns the value of the 'Placement Rel To' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcObjectPlacement#getReferencedByPlacements Referenced By Placements}'.
	 * 
	 * 
	 * If the meaning of the 'Placement Rel To' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Placement Rel To' reference.
	 * @see #isSetPlacementRelTo()
	 * @see #unsetPlacementRelTo()
	 * @see #setPlacementRelTo(IfcObjectPlacement)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLocalPlacement_PlacementRelTo()
	 * @see org.bimserver.models.ifc4.IfcObjectPlacement#getReferencedByPlacements
	 * @model opposite="ReferencedByPlacements" unsettable="true"
	 * @generated
	 */
	IfcObjectPlacement getPlacementRelTo();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLocalPlacement#getPlacementRelTo Placement Rel To}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Placement Rel To' reference.
	 * @see #isSetPlacementRelTo()
	 * @see #unsetPlacementRelTo()
	 * @see #getPlacementRelTo()
	 * @generated
	 */
	void setPlacementRelTo(IfcObjectPlacement value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcLocalPlacement#getPlacementRelTo Placement Rel To}' reference.
	 * 
	 * 
	 * @see #isSetPlacementRelTo()
	 * @see #getPlacementRelTo()
	 * @see #setPlacementRelTo(IfcObjectPlacement)
	 * @generated
	 */
	void unsetPlacementRelTo();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcLocalPlacement#getPlacementRelTo Placement Rel To}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Placement Rel To' reference is set.
	 * @see #unsetPlacementRelTo()
	 * @see #getPlacementRelTo()
	 * @see #setPlacementRelTo(IfcObjectPlacement)
	 * @generated
	 */
	boolean isSetPlacementRelTo();

	/**
	 * Returns the value of the 'Relative Placement' reference.
	 * 
	 * 
	 * If the meaning of the 'Relative Placement' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Relative Placement' reference.
	 * @see #setRelativePlacement(IfcAxis2Placement)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLocalPlacement_RelativePlacement()
	 * @model
	 * @generated
	 */
	IfcAxis2Placement getRelativePlacement();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLocalPlacement#getRelativePlacement Relative Placement}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Relative Placement' reference.
	 * @see #getRelativePlacement()
	 * @generated
	 */
	void setRelativePlacement(IfcAxis2Placement value);

} // IfcLocalPlacement