org.bimserver.models.ifc4.IfcProperty 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 Property'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcProperty#getName Name}
 *   {@link org.bimserver.models.ifc4.IfcProperty#getDescription Description}
 *   {@link org.bimserver.models.ifc4.IfcProperty#getPartOfPset Part Of Pset}
 *   {@link org.bimserver.models.ifc4.IfcProperty#getPropertyForDependance Property For Dependance}
 *   {@link org.bimserver.models.ifc4.IfcProperty#getPropertyDependsOn Property Depends On}
 *   {@link org.bimserver.models.ifc4.IfcProperty#getPartOfComplex Part Of Complex}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcProperty()
 * @model
 * @generated
 */
public interface IfcProperty extends IfcPropertyAbstraction {
	/**
	 * 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#getIfcProperty_Name()
	 * @model
	 * @generated
	 */
	String getName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcProperty#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#getIfcProperty_Description()
	 * @model unsettable="true"
	 * @generated
	 */
	String getDescription();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcProperty#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.IfcProperty#getDescription Description}' attribute.
	 * 
	 * 
	 * @see #isSetDescription()
	 * @see #getDescription()
	 * @see #setDescription(String)
	 * @generated
	 */
	void unsetDescription();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcProperty#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 'Part Of Pset' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcPropertySet}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcPropertySet#getHasProperties Has Properties}'.
	 * 
	 * 
	 * If the meaning of the 'Part Of Pset' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Part Of Pset' reference list.
	 * @see #isSetPartOfPset()
	 * @see #unsetPartOfPset()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcProperty_PartOfPset()
	 * @see org.bimserver.models.ifc4.IfcPropertySet#getHasProperties
	 * @model opposite="HasProperties" unsettable="true"
	 * @generated
	 */
	EList getPartOfPset();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcProperty#getPartOfPset Part Of Pset}' reference list.
	 * 
	 * 
	 * @see #isSetPartOfPset()
	 * @see #getPartOfPset()
	 * @generated
	 */
	void unsetPartOfPset();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcProperty#getPartOfPset Part Of Pset}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Part Of Pset' reference list is set.
	 * @see #unsetPartOfPset()
	 * @see #getPartOfPset()
	 * @generated
	 */
	boolean isSetPartOfPset();

	/**
	 * Returns the value of the 'Property For Dependance' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcPropertyDependencyRelationship}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcPropertyDependencyRelationship#getDependingProperty Depending Property}'.
	 * 
	 * 
	 * If the meaning of the 'Property For Dependance' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Property For Dependance' reference list.
	 * @see #isSetPropertyForDependance()
	 * @see #unsetPropertyForDependance()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcProperty_PropertyForDependance()
	 * @see org.bimserver.models.ifc4.IfcPropertyDependencyRelationship#getDependingProperty
	 * @model opposite="DependingProperty" unsettable="true"
	 * @generated
	 */
	EList getPropertyForDependance();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcProperty#getPropertyForDependance Property For Dependance}' reference list.
	 * 
	 * 
	 * @see #isSetPropertyForDependance()
	 * @see #getPropertyForDependance()
	 * @generated
	 */
	void unsetPropertyForDependance();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcProperty#getPropertyForDependance Property For Dependance}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Property For Dependance' reference list is set.
	 * @see #unsetPropertyForDependance()
	 * @see #getPropertyForDependance()
	 * @generated
	 */
	boolean isSetPropertyForDependance();

	/**
	 * Returns the value of the 'Property Depends On' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcPropertyDependencyRelationship}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcPropertyDependencyRelationship#getDependantProperty Dependant Property}'.
	 * 
	 * 
	 * If the meaning of the 'Property Depends On' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Property Depends On' reference list.
	 * @see #isSetPropertyDependsOn()
	 * @see #unsetPropertyDependsOn()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcProperty_PropertyDependsOn()
	 * @see org.bimserver.models.ifc4.IfcPropertyDependencyRelationship#getDependantProperty
	 * @model opposite="DependantProperty" unsettable="true"
	 * @generated
	 */
	EList getPropertyDependsOn();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcProperty#getPropertyDependsOn Property Depends On}' reference list.
	 * 
	 * 
	 * @see #isSetPropertyDependsOn()
	 * @see #getPropertyDependsOn()
	 * @generated
	 */
	void unsetPropertyDependsOn();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcProperty#getPropertyDependsOn Property Depends On}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Property Depends On' reference list is set.
	 * @see #unsetPropertyDependsOn()
	 * @see #getPropertyDependsOn()
	 * @generated
	 */
	boolean isSetPropertyDependsOn();

	/**
	 * Returns the value of the 'Part Of Complex' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcComplexProperty}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcComplexProperty#getHasProperties Has Properties}'.
	 * 
	 * 
	 * If the meaning of the 'Part Of Complex' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Part Of Complex' reference list.
	 * @see #isSetPartOfComplex()
	 * @see #unsetPartOfComplex()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcProperty_PartOfComplex()
	 * @see org.bimserver.models.ifc4.IfcComplexProperty#getHasProperties
	 * @model opposite="HasProperties" unsettable="true"
	 * @generated
	 */
	EList getPartOfComplex();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcProperty#getPartOfComplex Part Of Complex}' reference list.
	 * 
	 * 
	 * @see #isSetPartOfComplex()
	 * @see #getPartOfComplex()
	 * @generated
	 */
	void unsetPartOfComplex();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcProperty#getPartOfComplex Part Of Complex}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Part Of Complex' reference list is set.
	 * @see #unsetPartOfComplex()
	 * @see #getPartOfComplex()
	 * @generated
	 */
	boolean isSetPartOfComplex();

} // IfcProperty