fr.cnes.sirius.patrius.signalpropagation

Enum VacuumSignalPropagation.SignalPropagationRole

java.lang.Object

java.lang.Enum<VacuumSignalPropagation.SignalPropagationRole>

fr.cnes.sirius.patrius.signalpropagation.VacuumSignalPropagation.SignalPropagationRole

All Implemented Interfaces:

Serializable, Comparable<VacuumSignalPropagation.SignalPropagationRole>

Enclosing class:

VacuumSignalPropagation

public static enum VacuumSignalPropagation.SignalPropagationRole
extends Enum<VacuumSignalPropagation.SignalPropagationRole>

This enumerate represents the role of a protagonist in the signal propagation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RECEIVER Represent the reception role in the signal propagation.
TRANSMITTER Represent the transmission role in the signal propagation.

Method Summary

Modifier and Type	Method and Description
abstract AbsoluteDate	getDate(VacuumSignalPropagation signalPropagation) Getter for the date associated to this role (transmission or reception date).
abstract RealMatrix	getdPropDPos(VacuumSignalPropagation signalPropagation) Getter for the propagation vector (from antenna to space object) partial derivatives matrix wrt the space object position in the reference frame at the emission or reception date depending on the SignalDirection value.
abstract Vector3D	getdTPropDPos(VacuumSignalPropagation signalPropagation) Getter for the propagation time partial derivatives vector wrt the space object position in the reference frame at the emission or reception date depending on the SignalDirection value.
static VacuumSignalPropagation.SignalPropagationRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static VacuumSignalPropagation.SignalPropagationRole[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRANSMITTER

public static final VacuumSignalPropagation.SignalPropagationRole TRANSMITTER

Represent the transmission role in the signal propagation.

RECEIVER

public static final VacuumSignalPropagation.SignalPropagationRole RECEIVER

Represent the reception role in the signal propagation.

Method Detail

values

public static VacuumSignalPropagation.SignalPropagationRole[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VacuumSignalPropagation.SignalPropagationRole c : VacuumSignalPropagation.SignalPropagationRole.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VacuumSignalPropagation.SignalPropagationRole valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDate

public abstract AbsoluteDate getDate(VacuumSignalPropagation signalPropagation)

Getter for the date associated to this role (transmission or reception date).

Parameters:

signalPropagation - Signal propagation data

Returns:

the space object date

getdTPropDPos

public abstract Vector3D getdTPropDPos(VacuumSignalPropagation signalPropagation)

Getter for the propagation time partial derivatives vector wrt the space object position in the reference frame at the emission or reception date depending on the SignalDirection value.

Parameters:

signalPropagation - Signal propagation data

Returns:

the propagation time partial derivatives vector wrt the space object position

getdPropDPos

public abstract RealMatrix getdPropDPos(VacuumSignalPropagation signalPropagation)

Getter for the propagation vector (from antenna to space object) partial derivatives matrix wrt the space object position in the reference frame at the emission or reception date depending on the SignalDirection value.

Parameters:

signalPropagation - Signal propagation data

Returns:

the propagation vector partial derivatives matrix wrt the space object position