Class IIRVBuilder


  • public class IIRVBuilder
    extends Object
    Builder for IIRVVector.
    Since:
    13.0
    Author:
    Nick LaFarge
    • Constructor Detail

      • 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 Detail

      • 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 TimeStampedPVCoordinatesIIRVMessage 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • 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​(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
      • 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
      • 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
      • getSatelliteID

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