org.bimserver.models.ifc4.IfcContext 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 Context'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcContext#getObjectType Object Type}
 *   {@link org.bimserver.models.ifc4.IfcContext#getLongName Long Name}
 *   {@link org.bimserver.models.ifc4.IfcContext#getPhase Phase}
 *   {@link org.bimserver.models.ifc4.IfcContext#getRepresentationContexts Representation Contexts}
 *   {@link org.bimserver.models.ifc4.IfcContext#getUnitsInContext Units In Context}
 *   {@link org.bimserver.models.ifc4.IfcContext#getIsDefinedBy Is Defined By}
 *   {@link org.bimserver.models.ifc4.IfcContext#getDeclares Declares}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcContext()
 * @model
 * @generated
 */
public interface IfcContext extends IfcObjectDefinition {
	/**
	 * Returns the value of the 'Object Type' attribute.
	 * 
	 * 
	 * If the meaning of the 'Object Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Object Type' attribute.
	 * @see #isSetObjectType()
	 * @see #unsetObjectType()
	 * @see #setObjectType(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcContext_ObjectType()
	 * @model unsettable="true"
	 * @generated
	 */
	String getObjectType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getObjectType Object Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Object Type' attribute.
	 * @see #isSetObjectType()
	 * @see #unsetObjectType()
	 * @see #getObjectType()
	 * @generated
	 */
	void setObjectType(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getObjectType Object Type}' attribute.
	 * 
	 * 
	 * @see #isSetObjectType()
	 * @see #getObjectType()
	 * @see #setObjectType(String)
	 * @generated
	 */
	void unsetObjectType();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcContext#getObjectType Object Type}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Object Type' attribute is set.
	 * @see #unsetObjectType()
	 * @see #getObjectType()
	 * @see #setObjectType(String)
	 * @generated
	 */
	boolean isSetObjectType();

	/**
	 * Returns the value of the 'Long Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Long Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Long Name' attribute.
	 * @see #isSetLongName()
	 * @see #unsetLongName()
	 * @see #setLongName(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcContext_LongName()
	 * @model unsettable="true"
	 * @generated
	 */
	String getLongName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getLongName Long Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Long Name' attribute.
	 * @see #isSetLongName()
	 * @see #unsetLongName()
	 * @see #getLongName()
	 * @generated
	 */
	void setLongName(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getLongName Long Name}' attribute.
	 * 
	 * 
	 * @see #isSetLongName()
	 * @see #getLongName()
	 * @see #setLongName(String)
	 * @generated
	 */
	void unsetLongName();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcContext#getLongName Long Name}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Long Name' attribute is set.
	 * @see #unsetLongName()
	 * @see #getLongName()
	 * @see #setLongName(String)
	 * @generated
	 */
	boolean isSetLongName();

	/**
	 * Returns the value of the 'Phase' attribute.
	 * 
	 * 
	 * If the meaning of the 'Phase' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Phase' attribute.
	 * @see #isSetPhase()
	 * @see #unsetPhase()
	 * @see #setPhase(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcContext_Phase()
	 * @model unsettable="true"
	 * @generated
	 */
	String getPhase();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getPhase Phase}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Phase' attribute.
	 * @see #isSetPhase()
	 * @see #unsetPhase()
	 * @see #getPhase()
	 * @generated
	 */
	void setPhase(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getPhase Phase}' attribute.
	 * 
	 * 
	 * @see #isSetPhase()
	 * @see #getPhase()
	 * @see #setPhase(String)
	 * @generated
	 */
	void unsetPhase();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcContext#getPhase Phase}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Phase' attribute is set.
	 * @see #unsetPhase()
	 * @see #getPhase()
	 * @see #setPhase(String)
	 * @generated
	 */
	boolean isSetPhase();

	/**
	 * Returns the value of the 'Representation Contexts' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRepresentationContext}.
	 * 
	 * 
	 * If the meaning of the 'Representation Contexts' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Representation Contexts' reference list.
	 * @see #isSetRepresentationContexts()
	 * @see #unsetRepresentationContexts()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcContext_RepresentationContexts()
	 * @model unsettable="true"
	 * @generated
	 */
	EList getRepresentationContexts();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getRepresentationContexts Representation Contexts}' reference list.
	 * 
	 * 
	 * @see #isSetRepresentationContexts()
	 * @see #getRepresentationContexts()
	 * @generated
	 */
	void unsetRepresentationContexts();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcContext#getRepresentationContexts Representation Contexts}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Representation Contexts' reference list is set.
	 * @see #unsetRepresentationContexts()
	 * @see #getRepresentationContexts()
	 * @generated
	 */
	boolean isSetRepresentationContexts();

	/**
	 * Returns the value of the 'Units In Context' reference.
	 * 
	 * 
	 * If the meaning of the 'Units In Context' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Units In Context' reference.
	 * @see #isSetUnitsInContext()
	 * @see #unsetUnitsInContext()
	 * @see #setUnitsInContext(IfcUnitAssignment)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcContext_UnitsInContext()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcUnitAssignment getUnitsInContext();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getUnitsInContext Units In Context}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Units In Context' reference.
	 * @see #isSetUnitsInContext()
	 * @see #unsetUnitsInContext()
	 * @see #getUnitsInContext()
	 * @generated
	 */
	void setUnitsInContext(IfcUnitAssignment value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getUnitsInContext Units In Context}' reference.
	 * 
	 * 
	 * @see #isSetUnitsInContext()
	 * @see #getUnitsInContext()
	 * @see #setUnitsInContext(IfcUnitAssignment)
	 * @generated
	 */
	void unsetUnitsInContext();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcContext#getUnitsInContext Units In Context}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Units In Context' reference is set.
	 * @see #unsetUnitsInContext()
	 * @see #getUnitsInContext()
	 * @see #setUnitsInContext(IfcUnitAssignment)
	 * @generated
	 */
	boolean isSetUnitsInContext();

	/**
	 * Returns the value of the 'Is Defined By' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelDefinesByProperties}.
	 * 
	 * 
	 * If the meaning of the 'Is Defined By' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Is Defined By' reference list.
	 * @see #isSetIsDefinedBy()
	 * @see #unsetIsDefinedBy()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcContext_IsDefinedBy()
	 * @model unsettable="true"
	 * @generated
	 */
	EList getIsDefinedBy();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getIsDefinedBy Is Defined By}' reference list.
	 * 
	 * 
	 * @see #isSetIsDefinedBy()
	 * @see #getIsDefinedBy()
	 * @generated
	 */
	void unsetIsDefinedBy();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcContext#getIsDefinedBy Is Defined By}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Is Defined By' reference list is set.
	 * @see #unsetIsDefinedBy()
	 * @see #getIsDefinedBy()
	 * @generated
	 */
	boolean isSetIsDefinedBy();

	/**
	 * Returns the value of the 'Declares' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelDeclares}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelDeclares#getRelatingContext Relating Context}'.
	 * 
	 * 
	 * If the meaning of the 'Declares' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Declares' reference list.
	 * @see #isSetDeclares()
	 * @see #unsetDeclares()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcContext_Declares()
	 * @see org.bimserver.models.ifc4.IfcRelDeclares#getRelatingContext
	 * @model opposite="RelatingContext" unsettable="true"
	 * @generated
	 */
	EList getDeclares();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcContext#getDeclares Declares}' reference list.
	 * 
	 * 
	 * @see #isSetDeclares()
	 * @see #getDeclares()
	 * @generated
	 */
	void unsetDeclares();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcContext#getDeclares Declares}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Declares' reference list is set.
	 * @see #unsetDeclares()
	 * @see #getDeclares()
	 * @generated
	 */
	boolean isSetDeclares();

} // IfcContext