blob: 29baf4ff866968d6917b18e25628c704b50b9ada [file] [log] [blame]
/**
* *******************************************************************************
* Copyright (c) 2018 Agence spatiale canadienne / Canadian Space Agency
* 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
*
* Contributors:
* Pierre Allard - initial API and implementation
* Regent L'Archeveque
*
* SPDX-License-Identifier: EPL-1.0
* *******************************************************************************
*/
package org.eclipse.apogy.core.environment.earth.orbit.ui;
import org.eclipse.apogy.common.emf.Timed;
import org.eclipse.apogy.core.environment.earth.orbit.EarthOrbitModel;
import org.eclipse.apogy.core.environment.earth.ui.AbstractWorldWindLayer;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Orbit Model World Wind Layer</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getOrbitModel <em>Orbit Model</em>}</li>
* <li>{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getTimeSource <em>Time Source</em>}</li>
* <li>{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getTimeInterval <em>Time Interval</em>}</li>
* <li>{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getForwardPropagationDuration <em>Forward Propagation Duration</em>}</li>
* <li>{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getBackwardPropagationDuration <em>Backward Propagation Duration</em>}</li>
* <li>{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#isShowGroundTrace <em>Show Ground Trace</em>}</li>
* <li>{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#isShowOrbit <em>Show Orbit</em>}</li>
* </ul>
*
* @see org.eclipse.apogy.core.environment.earth.orbit.ui.ApogyCoreEnvironmentEarthOrbitUIPackage#getOrbitModelWorldWindLayer()
* @model annotation="http://www.eclipse.org/apogy hasCustomClass='true'"
* @generated
*/
public interface OrbitModelWorldWindLayer extends AbstractWorldWindLayer {
/**
* Returns the value of the '<em><b>Orbit Model</b></em>' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The orbit model.
* <!-- end-model-doc -->
* @return the value of the '<em>Orbit Model</em>' reference.
* @see #setOrbitModel(EarthOrbitModel)
* @see org.eclipse.apogy.core.environment.earth.orbit.ui.ApogyCoreEnvironmentEarthOrbitUIPackage#getOrbitModelWorldWindLayer_OrbitModel()
* @model annotation="http://www.eclipse.org/emf/2002/GenModel propertyCategory='ORBIT_MODEL'"
* @generated
*/
EarthOrbitModel getOrbitModel();
/**
* Sets the value of the '{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getOrbitModel <em>Orbit Model</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Orbit Model</em>' reference.
* @see #getOrbitModel()
* @generated
*/
void setOrbitModel(EarthOrbitModel value);
/**
* Returns the value of the '<em><b>Time Source</b></em>' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The time source to used to get the time
* used to define the reference time.
* <!-- end-model-doc -->
* @return the value of the '<em>Time Source</em>' reference.
* @see #setTimeSource(Timed)
* @see org.eclipse.apogy.core.environment.earth.orbit.ui.ApogyCoreEnvironmentEarthOrbitUIPackage#getOrbitModelWorldWindLayer_TimeSource()
* @model annotation="http://www.eclipse.org/emf/2002/GenModel propertyCategory='TIME'"
* @generated
*/
Timed getTimeSource();
/**
* Sets the value of the '{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getTimeSource <em>Time Source</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Time Source</em>' reference.
* @see #getTimeSource()
* @generated
*/
void setTimeSource(Timed value);
/**
* Returns the value of the '<em><b>Time Interval</b></em>' attribute.
* The default value is <code>"600.0"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The time interval at which to show
* the position.
* <!-- end-model-doc -->
* @return the value of the '<em>Time Interval</em>' attribute.
* @see #setTimeInterval(double)
* @see org.eclipse.apogy.core.environment.earth.orbit.ui.ApogyCoreEnvironmentEarthOrbitUIPackage#getOrbitModelWorldWindLayer_TimeInterval()
* @model default="600.0" unique="false"
* annotation="http://www.eclipse.org/emf/2002/GenModel propertyCategory='TIME_PERIOD'"
* annotation="http://www.eclipse.org/apogy units='s'"
* @generated
*/
double getTimeInterval();
/**
* Sets the value of the '{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getTimeInterval <em>Time Interval</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Time Interval</em>' attribute.
* @see #getTimeInterval()
* @generated
*/
void setTimeInterval(double value);
/**
* Returns the value of the '<em><b>Forward Propagation Duration</b></em>' attribute.
* The default value is <code>"43200.0"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The forward propagation duration
* from the current time.
* <!-- end-model-doc -->
* @return the value of the '<em>Forward Propagation Duration</em>' attribute.
* @see #setForwardPropagationDuration(double)
* @see org.eclipse.apogy.core.environment.earth.orbit.ui.ApogyCoreEnvironmentEarthOrbitUIPackage#getOrbitModelWorldWindLayer_ForwardPropagationDuration()
* @model default="43200.0" unique="false"
* annotation="http://www.eclipse.org/emf/2002/GenModel propertyCategory='TIME_PERIOD'"
* annotation="http://www.eclipse.org/apogy units='s'"
* @generated
*/
double getForwardPropagationDuration();
/**
* Sets the value of the '{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getForwardPropagationDuration <em>Forward Propagation Duration</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Forward Propagation Duration</em>' attribute.
* @see #getForwardPropagationDuration()
* @generated
*/
void setForwardPropagationDuration(double value);
/**
* Returns the value of the '<em><b>Backward Propagation Duration</b></em>' attribute.
* The default value is <code>"43200.0"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The backward propagation duration
* from the current time.
* <!-- end-model-doc -->
* @return the value of the '<em>Backward Propagation Duration</em>' attribute.
* @see #setBackwardPropagationDuration(double)
* @see org.eclipse.apogy.core.environment.earth.orbit.ui.ApogyCoreEnvironmentEarthOrbitUIPackage#getOrbitModelWorldWindLayer_BackwardPropagationDuration()
* @model default="43200.0" unique="false"
* annotation="http://www.eclipse.org/emf/2002/GenModel propertyCategory='TIME_PERIOD'"
* annotation="http://www.eclipse.org/apogy units='s'"
* @generated
*/
double getBackwardPropagationDuration();
/**
* Sets the value of the '{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#getBackwardPropagationDuration <em>Backward Propagation Duration</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Backward Propagation Duration</em>' attribute.
* @see #getBackwardPropagationDuration()
* @generated
*/
void setBackwardPropagationDuration(double value);
/**
* Returns the value of the '<em><b>Show Ground Trace</b></em>' attribute.
* The default value is <code>"true"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Whether or not to display the orbit
* projected on the ground.
* <!-- end-model-doc -->
* @return the value of the '<em>Show Ground Trace</em>' attribute.
* @see #setShowGroundTrace(boolean)
* @see org.eclipse.apogy.core.environment.earth.orbit.ui.ApogyCoreEnvironmentEarthOrbitUIPackage#getOrbitModelWorldWindLayer_ShowGroundTrace()
* @model default="true" unique="false"
* annotation="http://www.eclipse.org/emf/2002/GenModel propertyCategory='VISUALS' notify='true' property='Editable'"
* @generated
*/
boolean isShowGroundTrace();
/**
* Sets the value of the '{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#isShowGroundTrace <em>Show Ground Trace</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Show Ground Trace</em>' attribute.
* @see #isShowGroundTrace()
* @generated
*/
void setShowGroundTrace(boolean value);
/**
* Returns the value of the '<em><b>Show Orbit</b></em>' attribute.
* The default value is <code>"true"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Whether or not to display the orbit.
* <!-- end-model-doc -->
* @return the value of the '<em>Show Orbit</em>' attribute.
* @see #setShowOrbit(boolean)
* @see org.eclipse.apogy.core.environment.earth.orbit.ui.ApogyCoreEnvironmentEarthOrbitUIPackage#getOrbitModelWorldWindLayer_ShowOrbit()
* @model default="true" unique="false"
* annotation="http://www.eclipse.org/emf/2002/GenModel notify='true' propertyCategory='VISUALS' property='Editable'"
* @generated
*/
boolean isShowOrbit();
/**
* Sets the value of the '{@link org.eclipse.apogy.core.environment.earth.orbit.ui.OrbitModelWorldWindLayer#isShowOrbit <em>Show Orbit</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Show Orbit</em>' attribute.
* @see #isShowOrbit()
* @generated
*/
void setShowOrbit(boolean value);
} // OrbitModelWorldWindLayer