Package org.orekit.files.iirv

Class IIRVBuilder

java.lang.Object
org.orekit.files.iirv.IIRVBuilder
public class IIRVBuilder extends Object
Builder for IIRVVector.
Since:
13.0
Author:
Nick LaFarge

  • Constructor Details

    • IIRVBuilder

      public IIRVBuilder(UTCScale utc)
      Constructs an IIRVBuilder instance with a UTC timescale and default values for all parameters.
      Parameters:
      utc - UTC time scale

  • Method Details

    • buildVector

      public IIRVVector buildVector(DayOfYearTerm dayOfYear, VectorEpochTerm vectorEpoch, PositionVectorComponentTerm xPosition, PositionVectorComponentTerm yPosition, PositionVectorComponentTerm zPosition, VelocityVectorComponentTerm xVelocity, VelocityVectorComponentTerm yVelocity, VelocityVectorComponentTerm zVelocity)
      Constructs an IIRV object using the configured parameters.
      Parameters:
      dayOfYear - Day of year, 001 to 366
      vectorEpoch - Vector epoch in UTC
      xPosition - X component of the position vector [m]
      yPosition - Y component of the position vector [m]
      zPosition - Z component of the position vector [m]
      xVelocity - X component of the velocity vector [m/s]
      yVelocity - Y component of the velocity vector [m/s]
      zVelocity - Z component of the velocity vector [m/s]
      Returns:
      the newly constructed IIRV object

    • buildVector

      public IIRVVector buildVector(TimeStampedPVCoordinates timeStampedPVCoordinates)
      Constructs an IIRV vector using the configured parameters, with position, velocity, and time variables derived from instances of TimeStampedPVCoordinates and AbsoluteDate.
      Parameters:
      timeStampedPVCoordinates - position and velocity components at a particular epoch corresponding to the IIRV vector
      Returns:
      the newly constructed IIRV object at the given coordinates

    • buildIIRVMessage

      public <C extends TimeStampedPVCoordinates> IIRVMessage buildIIRVMessage(List<C> timeStampedPVCoordinates)
      Constructs an IIRVMessage where each IIRVVector in initialized from the inputted list of TimeStampedPVCoordinates.
      Type Parameters:
      C - type of the Cartesian coordinates
      Parameters:
      timeStampedPVCoordinates - list of time-stamped position and velocity vectors to populate the message
      Returns:
      the newly constructed IIRVMessage containing the given coordinates

    • buildEphemerisFile

      public <C extends TimeStampedPVCoordinates> IIRVEphemerisFile buildEphemerisFile(List<C> timeStampedPVCoordinates)
      Constructs an IIRVEphemerisFile from the inputted list of TimeStampedPVCoordinates, inferring the start year from the first coordinate's AbsoluteDate.

      See buildIIRVMessage(List) for IIRVMessage construction details.

      Type Parameters:
      C - type of the Cartesian coordinates
      Parameters:
      timeStampedPVCoordinates - list of time-stamped position and velocity vectors to populate the message
      Returns:
      the newly constructed IIRVEphemerisFile containing the given coordinates

    • getMass

      public MassTerm getMass()
      Gets the current MassTerm value.
      Returns:
      the current MassTerm value.

    • setMass

      public void setMass(MassTerm mass)
      Overrides the default Mass attribute for the IIRVVector object being built.

      Units: kg

      Parameters:
      mass - mass value (kg) for the IIRV message

    • setMass

      public void setMass(String mass)
      Overrides the default Mass attribute for the IIRVVector object being built.

      Units: kg

      Parameters:
      mass - mass value (kg) for the IIRV message

    • setMass

      public void setMass(double mass)
      Overrides the default Mass attribute for the IIRVVector object being built.

      Units: kg

      Parameters:
      mass - mass value (kg) for the IIRV message

    • getMessageType

      public MessageTypeTerm getMessageType()
      Gets the current MessageTypeTerm value.
      Returns:
      the current MessageTypeTerm value.

    • setMessageType

      public void setMessageType(String messageType)
      Overrides the default MessageTypeTerm attribute for the IIRVVector object being built.
      Parameters:
      messageType - MessageTypeTerm for the IIRV message

    • setMessageType

      public void setMessageType(MessageTypeTerm messageType)
      Overrides the default MessageTypeTerm attribute for the IIRVVector object being built.
      Parameters:
      messageType - MessageTypeTerm for the IIRV message

    • getMessageSource

      public MessageSourceTerm getMessageSource()
      Gets the current MessageSourceTerm value.
      Returns:
      the current MessageSourceTerm value.

    • setMessageSource

      public void setMessageSource(String messageSource)
      Overrides the default MessageSourceTerm attribute for the IIRVVector object being built.
      Parameters:
      messageSource - MessageSourceTerm for the IIRV message

    • setMessageSource

      public void setMessageSource(MessageSourceTerm messageSource)
      Overrides the default MessageSourceTerm attribute for the IIRVVector object being built.
      Parameters:
      messageSource - MessageSourceTerm for the IIRV message

    • getMessageID

      public MessageIDTerm getMessageID()
      Gets the current MessageIDTerm value.
      Returns:
      the current MessageIDTerm value.

    • setMessageID

      public void setMessageID(MessageIDTerm messageID)
      Overrides the default MessageID attribute for the IIRVVector object being built.
      Parameters:
      messageID - message ID value for the IIRV message

    • setMessageID

      public void setMessageID(String messageID)
      Overrides the default MessageID attribute for the IIRVVector object being built.
      Parameters:
      messageID - message ID value for the IIRV message

    • setMessageID

      public void setMessageID(long messageID)
      Overrides the default MessageID attribute for the IIRVVector object being built.
      Parameters:
      messageID - message ID value for the IIRV message

    • getMessageClass

      public MessageClassTerm getMessageClass()
      Gets the current MessageClassTerm value.
      Returns:
      the current MessageClassTerm value.

    • setMessageClass

      public void setMessageClass(MessageClassTerm messageClass)
      Overrides the default MessageClass attribute for the IIRVVector object being built.
      Parameters:
      messageClass - message class value for the IIRV message

    • setMessageClass

      public void setMessageClass(String messageClass)
      Overrides the default MessageClass attribute for the IIRVVector object being built.
      Parameters:
      messageClass - message class value for the IIRV message

    • setMessageClass

      public void setMessageClass(long messageClass)
      Overrides the default MessageClass attribute for the IIRVVector object being built.
      Parameters:
      messageClass - message class value for the IIRV message

    • getOriginIdentification

      public OriginIdentificationTerm getOriginIdentification()
      Gets the current OriginIdentificationTerm value.
      Returns:
      the current OriginIdentificationTerm value.

    • setOriginIdentification

      public void setOriginIdentification(OriginIdentificationTerm originIdentification)
      Overrides the default OriginIdentification attribute for the IIRVVector object being built.
      Parameters:
      originIdentification - origin identification value for the IIRV message

    • setOriginIdentification

      public void setOriginIdentification(String originIdentification)
      Overrides the default OriginIdentification attribute for the IIRVVector object being built.
      Parameters:
      originIdentification - origin identification value for the IIRV message

    • getRoutingIndicator

      public RoutingIndicatorTerm getRoutingIndicator()
      Gets the current RoutingIndicatorTerm value.
      Returns:
      the current RoutingIndicatorTerm value.

    • setRoutingIndicator

      public void setRoutingIndicator(RoutingIndicatorTerm routingIndicator)
      Overrides the default RoutingIndicator attribute for the IIRVVector object being built.
      Parameters:
      routingIndicator - routing indicator term value for the IIRV message

    • setRoutingIndicator

      public void setRoutingIndicator(String routingIndicator)
      Overrides the default RoutingIndicator attribute for the IIRVVector object being built.
      Parameters:
      routingIndicator - routing indicator term value for the IIRV message

    • getVectorType

      public VectorTypeTerm getVectorType()
      Gets the current VectorTypeTerm value.
      Returns:
      the current VectorTypeTerm value.

    • setVectorType

      public void setVectorType(VectorTypeTerm vectorType)
      Overrides the default VectorType attribute for the IIRVVector object being built.
      Parameters:
      vectorType - vector type term value for the IIRV message

    • setVectorType

      public void setVectorType(String vectorType)
      Overrides the default VectorType attribute for the IIRVVector object being built.
      Parameters:
      vectorType - vector type term value for the IIRV message

    • setVectorType

      public void setVectorType(long vectorType)
      Overrides the default VectorType attribute for the IIRVVector object being built.
      Parameters:
      vectorType - vector type term value for the IIRV message

    • getDataSource

      public DataSourceTerm getDataSource()
      Gets the current DataSourceTerm value.
      Returns:
      the current DataSourceTerm value.

    • setDataSource

      public void setDataSource(DataSourceTerm dataSource)
      Overrides the default DataSource attribute for the IIRVVector object being built.
      Parameters:
      dataSource - data source term value for the IIRV message

    • setDataSource

      public void setDataSource(long dataSource)
      Overrides the default DataSource attribute for the IIRVVector object being built.
      Parameters:
      dataSource - data source term value for the IIRV message

    • setDataSource

      public void setDataSource(String dataSource)
      Overrides the default DataSource attribute for the IIRVVector object being built.
      Parameters:
      dataSource - data source term value for the IIRV message

    • getCoordinateSystem

      public CoordinateSystemTerm getCoordinateSystem()
      Gets the current CoordinateSystemTerm value.
      Returns:
      the current CoordinateSystemTerm value.

    • setCoordinateSystem

      public void setCoordinateSystem(CoordinateSystemTerm coordinateSystem)
      Overrides the default CoordinateSystem attribute for the IIRVVector object being built.
      Parameters:
      coordinateSystem - coordinate system term value for the IIRV message

    • setCoordinateSystem

      public void setCoordinateSystem(String coordinateSystem)
      Overrides the default CoordinateSystem attribute for the IIRVVector object being built.
      Parameters:
      coordinateSystem - coordinate system term value for the IIRV message

    • setCoordinateSystem

      public void setCoordinateSystem(long coordinateSystem)
      Overrides the default CoordinateSystem attribute for the IIRVVector object being built.
      Parameters:
      coordinateSystem - coordinate system term value for the IIRV message

    • getSupportIdCode

      public SupportIdCodeTerm getSupportIdCode()
      Gets the current SupportIdCodeTerm value.
      Returns:
      the current SupportIdCodeTerm value.

    • setSupportIdCode

      public void setSupportIdCode(SupportIdCodeTerm supportIdCode)
      Overrides the default SupportIdCode attribute for the IIRVVector object being built.
      Parameters:
      supportIdCode - support id code value for the IIRV message

    • setSupportIdCode

      public void setSupportIdCode(String supportIdCode)
      Overrides the default SupportIdCode attribute for the IIRVVector object being built.
      Parameters:
      supportIdCode - support id code value for the IIRV message

    • setSupportIdCode

      public void setSupportIdCode(long supportIdCode)
      Overrides the default SupportIdCode attribute for the IIRVVector object being built.
      Parameters:
      supportIdCode - support id code value for the IIRV message

    • getVehicleIdCode

      public VehicleIdCodeTerm getVehicleIdCode()
      Gets the current VehicleIdCodeTerm value.
      Returns:
      the current VehicleIdCodeTerm value.

    • setVehicleIdCode

      public void setVehicleIdCode(VehicleIdCodeTerm vehicleIdCode)
      Overrides the default VehicleIdCode attribute for the IIRVVector object being built.
      Parameters:
      vehicleIdCode - vehicle id code value for the IIRV message

    • setVehicleIdCode

      public void setVehicleIdCode(String vehicleIdCode)
      Overrides the default VehicleIdCode attribute for the IIRVVector object being built.
      Parameters:
      vehicleIdCode - vehicle id code value for the IIRV message

    • setVehicleIdCode

      public void setVehicleIdCode(long vehicleIdCode)
      Overrides the default VehicleIdCode attribute for the IIRVVector object being built.
      Parameters:
      vehicleIdCode - vehicle id code value for the IIRV message

    • getSequenceNumber

      public SequenceNumberTerm getSequenceNumber()
      Gets the current SequenceNumberTerm value.
      Returns:
      the current SequenceNumberTerm value.

    • setSequenceNumber

      public void setSequenceNumber(SequenceNumberTerm sequenceNumber)
      Overrides the default SequenceNumber attribute for the IIRVVector object being built.
      Parameters:
      sequenceNumber - sequence number value for the IIRV message

    • setSequenceNumber

      public void setSequenceNumber(String sequenceNumber)
      Overrides the default SequenceNumber attribute for the IIRVVector object being built.
      Parameters:
      sequenceNumber - sequence number value for the IIRV message

    • setSequenceNumber

      public void setSequenceNumber(long sequenceNumber)
      Overrides the default SequenceNumber attribute for the IIRVVector object being built.
      Parameters:
      sequenceNumber - sequence number value for the IIRV message

    • getCrossSectionalArea

      public CrossSectionalAreaTerm getCrossSectionalArea()
      Gets the current CrossSectionalAreaTerm value.
      Returns:
      the current CrossSectionalAreaTerm value.

    • setCrossSectionalArea

      public void setCrossSectionalArea(CrossSectionalAreaTerm crossSectionalArea)
      Overrides the default CrossSectionalAreaTerm attribute for the IIRVVector object being built.

      Units: m^2

      Parameters:
      crossSectionalArea - cross-sectional area value (m^2) for the IIRV message

    • setCrossSectionalArea

      public void setCrossSectionalArea(String crossSectionalArea)
      Overrides the default CrossSectionalAreaTerm attribute for the IIRVVector object being built.

      Units: m^2

      See CrossSectionalAreaTerm(String)

      Parameters:
      crossSectionalArea - cross-sectional area value (m^2) for the IIRV message

    • setCrossSectionalArea

      public void setCrossSectionalArea(double crossSectionalArea)
      Overrides the default CrossSectionalAreaTerm attribute for the IIRVVector object being built.

      Units: m^2

      See CrossSectionalAreaTerm(double)

      Parameters:
      crossSectionalArea - cross-sectional area value (m^2) for the IIRV message

    • getDragCoefficient

      public DragCoefficientTerm getDragCoefficient()
      Gets the current DragCoefficientTerm value.
      Returns:
      the current DragCoefficientTerm value.

    • setDragCoefficient

      public void setDragCoefficient(DragCoefficientTerm dragCoefficient)
      Overrides the default DragCoefficientTerm attribute for the IIRVVector object being built.

      Units: dimensionless

      Parameters:
      dragCoefficient - drag coefficient value (dimensionless) for the IIRV message

    • setDragCoefficient

      public void setDragCoefficient(String dragCoefficient)
      Overrides the default DragCoefficientTerm attribute for the IIRVVector object being built.

      Units: dimensionless

      See DragCoefficientTerm(String)

      Parameters:
      dragCoefficient - drag coefficient value (dimensionless) for the IIRV message

    • setDragCoefficient

      public void setDragCoefficient(double dragCoefficient)
      Overrides the default DragCoefficientTerm attribute for the IIRVVector object being built.

      Units: dimensionless

      See DragCoefficientTerm(double)

      Parameters:
      dragCoefficient - drag coefficient value (dimensionless) for the IIRV message

    • getSolarReflectivityCoefficient

      public SolarReflectivityCoefficientTerm getSolarReflectivityCoefficient()
      Gets the current SolarReflectivityCoefficientTerm value.
      Returns:
      the current SolarReflectivityCoefficientTerm value.

    • setSolarReflectivityCoefficient

      public void setSolarReflectivityCoefficient(SolarReflectivityCoefficientTerm solarReflectivityCoefficient)
      Overrides the default SolarReflectivityCoefficientTerm attribute for the IIRVVector object being built.

      Units: dimensionless

      Parameters:
      solarReflectivityCoefficient - solar reflectivity coefficient value (dimensionless) for the IIRV message

    • setSolarReflectivityCoefficient

      public void setSolarReflectivityCoefficient(String solarReflectivityCoefficient)
      Overrides the default SolarReflectivityCoefficientTerm attribute for the IIRVVector object being built.

      Units: dimensionless

      See SolarReflectivityCoefficientTerm(String)

      Parameters:
      solarReflectivityCoefficient - solar reflectivity coefficient value (dimensionless) for the IIRV message

    • setSolarReflectivityCoefficient

      public void setSolarReflectivityCoefficient(double solarReflectivityCoefficient)
      Overrides the default SolarReflectivityCoefficientTerm attribute for the IIRVVector object being built.

      Units: dimensionless

      See SolarReflectivityCoefficientTerm(double)

      Parameters:
      solarReflectivityCoefficient - solar reflectivity coefficient value (dimensionless) for the IIRV message

    • getOriginatorRoutingIndicator

      public OriginatorRoutingIndicatorTerm getOriginatorRoutingIndicator()
      Gets the current OriginatorRoutingIndicatorTerm value.
      Returns:
      the current OriginatorRoutingIndicatorTerm value.

    • setOriginatorRoutingIndicator

      public void setOriginatorRoutingIndicator(OriginatorRoutingIndicatorTerm originatorRoutingIndicator)
      Overrides the default OriginatorRoutingIndicatorTerm attribute for the IIRVVector object being built.
      Parameters:
      originatorRoutingIndicator - originator routing indicator value for the IIRV message

    • setOriginatorRoutingIndicator

      public void setOriginatorRoutingIndicator(String originatorRoutingIndicator)
      Overrides the default OriginatorRoutingIndicatorTerm attribute for the IIRVVector object being built.

      See OriginatorRoutingIndicatorTerm(String)

      Parameters:
      originatorRoutingIndicator - originator routing indicator value for the IIRV message

    • getSatelliteID

      public String getSatelliteID()
      Returns the satellite ID (set to the value of the VehicleIdCodeTerm).
      Returns:
      the satellite ID