/** * Copyright (c) 2019 CentraleSupélec & EDF. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * This file is part of the RiseClipse tool * * Contributors: * Computer Science Department, CentraleSupélec * EDF R&D * Contacts: * dominique.marcadet@centralesupelec.fr * aurelie.dehouck-neveu@edf.fr * Web site: * http://wdi.supelec.fr/software/RiseClipse/ * */ package fr.centralesupelec.edf.riseclipse.iec61850.nsd; import javax.xml.datatype.XMLGregorianCalendar; import org.eclipse.emf.common.util.EList; /** * <!-- begin-user-doc --> * A representation of the model object '<em><b>NS Doc</b></em>'. * <!-- end-user-doc --> * * <!-- begin-model-doc --> * A non-empty list of tDoc elements. * <!-- end-model-doc --> * * <p> * The following features are supported: * </p> * <ul> * <li>{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getDoc <em>Doc</em>}</li> * <li>{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getId <em>Id</em>}</li> * <li>{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getLang <em>Lang</em>}</li> * <li>{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getPublicationStage <em>Publication Stage</em>}</li> * <li>{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getRevision <em>Revision</em>}</li> * <li>{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getUmlDate <em>Uml Date</em>}</li> * <li>{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getUmlVersion <em>Uml Version</em>}</li> * </ul> * * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.NsdPackage#getNSDoc() * @model extendedMetaData="name='tNSDoc' kind='elementOnly'" * @generated */ public interface NSDoc extends Copyrighted, NSDObjectWithVersionAndRelease { /** * Returns the value of the '<em><b>Doc</b></em>' containment reference list. * The list contents are of type {@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.Doc}. * <!-- begin-user-doc --> * <!-- end-user-doc --> * <!-- begin-model-doc --> * List of documentation identifiers and corresponding documentation strings in the corresponding language. * <!-- end-model-doc --> * @return the value of the '<em>Doc</em>' containment reference list. * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.NsdPackage#getNSDoc_Doc() * @model containment="true" required="true" * extendedMetaData="kind='element' name='Doc' namespace='##targetNamespace'" * @generated */ EList< Doc > getDoc(); /** * Returns the value of the '<em><b>Id</b></em>' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * <!-- begin-model-doc --> * Identifier of the namespace, e.g., "IEC 61850-7-4", "(Tr)IEC 61850-90-4". * <!-- end-model-doc --> * @return the value of the '<em>Id</em>' attribute. * @see #setId(String) * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.NsdPackage#getNSDoc_Id() * @model required="true" * extendedMetaData="kind='attribute' name='id'" * @generated */ String getId(); /** * Sets the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getId <em>Id</em>}' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @param value the new value of the '<em>Id</em>' attribute. * @see #getId() * @generated */ void setId( String value ); /** * Returns the value of the '<em><b>Lang</b></em>' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * <!-- begin-model-doc --> * Language of the documentation strings in the file. * <!-- end-model-doc --> * @return the value of the '<em>Lang</em>' attribute. * @see #setLang(String) * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.NsdPackage#getNSDoc_Lang() * @model dataType="org.eclipse.emf.ecore.xml.type.Language" required="true" * extendedMetaData="kind='attribute' name='lang'" * @generated */ String getLang(); /** * Sets the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getLang <em>Lang</em>}' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @param value the new value of the '<em>Lang</em>' attribute. * @see #getLang() * @generated */ void setLang( String value ); /** * Returns the value of the '<em><b>Publication Stage</b></em>' attribute. * The default value is <code>"IS"</code>. * The literals are from the enumeration {@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.PubStage}. * <!-- begin-user-doc --> * <!-- end-user-doc --> * <!-- begin-model-doc --> * The publication stage of the namespace, by default IS. * <!-- end-model-doc --> * @return the value of the '<em>Publication Stage</em>' attribute. * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.PubStage * @see #isSetPublicationStage() * @see #unsetPublicationStage() * @see #setPublicationStage(PubStage) * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.NsdPackage#getNSDoc_PublicationStage() * @model default="IS" unsettable="true" * extendedMetaData="kind='attribute' name='publicationStage'" * @generated */ PubStage getPublicationStage(); /** * Sets the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getPublicationStage <em>Publication Stage</em>}' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @param value the new value of the '<em>Publication Stage</em>' attribute. * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.PubStage * @see #isSetPublicationStage() * @see #unsetPublicationStage() * @see #getPublicationStage() * @generated */ void setPublicationStage( PubStage value ); /** * Unsets the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getPublicationStage <em>Publication Stage</em>}' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @see #isSetPublicationStage() * @see #getPublicationStage() * @see #setPublicationStage(PubStage) * @generated */ void unsetPublicationStage(); /** * Returns whether the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getPublicationStage <em>Publication Stage</em>}' attribute is set. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @return whether the value of the '<em>Publication Stage</em>' attribute is set. * @see #unsetPublicationStage() * @see #getPublicationStage() * @see #setPublicationStage(PubStage) * @generated */ boolean isSetPublicationStage(); /** * Returns the value of the '<em><b>Revision</b></em>' attribute. * The default value is <code>"A"</code>. * <!-- begin-user-doc --> * <!-- end-user-doc --> * <!-- begin-model-doc --> * Revision of the namespace version, by default 'A'. * <!-- end-model-doc --> * @return the value of the '<em>Revision</em>' attribute. * @see #isSetRevision() * @see #unsetRevision() * @see #setRevision(String) * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.NsdPackage#getNSDoc_Revision() * @model default="A" unsettable="true" * extendedMetaData="kind='attribute' name='revision'" * @generated */ String getRevision(); /** * Sets the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getRevision <em>Revision</em>}' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @param value the new value of the '<em>Revision</em>' attribute. * @see #isSetRevision() * @see #unsetRevision() * @see #getRevision() * @generated */ void setRevision( String value ); /** * Unsets the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getRevision <em>Revision</em>}' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @see #isSetRevision() * @see #getRevision() * @see #setRevision(String) * @generated */ void unsetRevision(); /** * Returns whether the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getRevision <em>Revision</em>}' attribute is set. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @return whether the value of the '<em>Revision</em>' attribute is set. * @see #unsetRevision() * @see #getRevision() * @see #setRevision(String) * @generated */ boolean isSetRevision(); /** * Returns the value of the '<em><b>Uml Date</b></em>' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * <!-- begin-model-doc --> * UTC Date and time of the UML version from which this namespace definition file was generated. Shall be provided if umlVersion is present. Format: YYYY-MM-DDThh:mm:ssZ, where: YYYY indicates the year, MM indicates the month, DD indicates the day, T indicates the start of the required time section, hh indicates the hour, mm indicates the minute, ss indicates the second, and Z the UTC time stamp indication. * * <!-- end-model-doc --> * @return the value of the '<em>Uml Date</em>' attribute. * @see #setUmlDate(XMLGregorianCalendar) * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.NsdPackage#getNSDoc_UmlDate() * @model dataType="org.eclipse.emf.ecore.xml.type.DateTime" * extendedMetaData="kind='attribute' name='umlDate'" * @generated */ XMLGregorianCalendar getUmlDate(); /** * Sets the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getUmlDate <em>Uml Date</em>}' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @param value the new value of the '<em>Uml Date</em>' attribute. * @see #getUmlDate() * @generated */ void setUmlDate( XMLGregorianCalendar value ); /** * Returns the value of the '<em><b>Uml Version</b></em>' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * <!-- begin-model-doc --> * Version of UML from which this namespace definition file was generated from. * <!-- end-model-doc --> * @return the value of the '<em>Uml Version</em>' attribute. * @see #setUmlVersion(String) * @see fr.centralesupelec.edf.riseclipse.iec61850.nsd.NsdPackage#getNSDoc_UmlVersion() * @model extendedMetaData="kind='attribute' name='umlVersion'" * @generated */ String getUmlVersion(); /** * Sets the value of the '{@link fr.centralesupelec.edf.riseclipse.iec61850.nsd.NSDoc#getUmlVersion <em>Uml Version</em>}' attribute. * <!-- begin-user-doc --> * <!-- end-user-doc --> * @param value the new value of the '<em>Uml Version</em>' attribute. * @see #getUmlVersion() * @generated */ void setUmlVersion( String value ); } // NSDoc