org.orekit.files.ccsds.ndm.cdm

Class AdditionalParameters

java.lang.Object

org.orekit.files.ccsds.section.CommentsContainer

org.orekit.files.ccsds.ndm.CommonPhysicalProperties

org.orekit.files.ccsds.ndm.cdm.AdditionalParameters

All Implemented Interfaces:

Section

public class AdditionalParameters
extends CommonPhysicalProperties

Container for additional parameters data block.

Since:

11.2

Author:

Melina Vanel

Constructor Summary

Constructors

Constructor and Description
AdditionalParameters() Simple constructor.

Method Summary

Modifier and Type	Method and Description
double	getApoapsisAltitude() Get the distance of the furthest point in the objects orbit above the equatorial radius of the central body.
double	getAreaDRG() Get the effective area of the object exposed to atmospheric drag.
double	getAreaPC() Get the actual area of the object.
double	getAreaPCMax() Get the maximum area of the object to be used to compute the collision probability.
double	getAreaPCMin() Set the minimum area of the object to be used to compute the collision probability.
double	getAreaSRP() Get the effective area of the object exposed to solar radiation pressure.
double	getCDAreaOverMass() Get the object’s Cd x A/m used to propagate the state vector and covariance to TCA.
double	getCovConfidence() Get the measure of the confidence in the covariance errors matching reality.
String	getCovConfidenceMethod() Get the method used for the calculation of COV_CONFIDENCE.
double	getCRAreaOverMass() Get the object’s Cr x A/m used to propagate the state vector and covariance to TCA.
double	getHbr() Get the object hard body radius.
double	getInclination() Get the angle between the objects orbit plane and the orbit centers equatorial plane.
double	getMass() Get the mass of the object.
double	getPeriapsissAltitude() Get the distance of the closest point in the objects orbit above the equatorial radius of the central body.
double	getSedr() Get the amount of energy being removed from the object’s orbit by atmospheric drag.
double	getThrustAcceleration() Get the object’s acceleration due to in-track thrust used to propagate the state vector and covariance to TCA.
void	setApoapsisAltitude(double apoapsisAltitude) Set the distance of the furthest point in the objects orbit above the equatorial radius of the central body.
void	setAreaDRG(double areaDRG) Set the effective area of the object exposed to atmospheric drag.
void	setAreaPC(double areaPC) Set the actual area of the object.
void	setAreaPCMax(double areaPCMax) Set the maximum area for the object to be used to compute the collision probability.
void	setAreaPCMin(double areaPCMin) Get the minimum area of the object to be used to compute the collision probability.
void	setAreaSRP(double areaSRP) Set the effective area of the object exposed to solar radiation pressure.
void	setCDAreaOverMass(double CDAreaOverMass) Set the object’s Cd x A/m used to propagate the state vector and covariance to TCA.
void	setCovConfidence(double covConfidence) Set the measure of the confidence in the covariance errors matching reality.
void	setCovConfidenceMethod(String covConfidenceMethod) Set the method used for the calculation of COV_CONFIDENCE.
void	setCRAreaOverMass(double CRAreaOverMass) Set the object’s Cr x A/m used to propagate the state vector and covariance to TCA.
void	setHbr(double hbr) Set the object hard body radius.
void	setInclination(double inclination) Set the angle between the objects orbit plane and the orbit centers equatorial plane.
void	setMass(double mass) Set the mass of the object.
void	setPeriapsissAltitude(double periapsissAltitude) Set the distance of the closest point in the objects orbit above the equatorial radius of the central body.
void	setSedr(double SEDR) Set the amount of energy being removed from the object’s orbit by atmospheric drag.
void	setThrustAcceleration(double thrustAcceleration) Set the object’s acceleration due to in-track thrust used to propagate the state vector and covariance to TCA.
void	validate(double version) Check is all mandatory entries have been initialized.

Methods inherited from class org.orekit.files.ccsds.ndm.CommonPhysicalProperties

getMaxRcs, getMinRcs, getOebAreaAlongIntermediate, getOebAreaAlongMax, getOebAreaAlongMin, getOebIntermediate, getOebMax, getOebMin, getOebParentFrame, getOebParentFrameEpoch, getOebQ, getRcs, getReflectance, getVmAbsolute, getVmApparent, getVmApparentMax, getVmApparentMin, setMaxRcs, setMinRcs, setOebAreaAlongIntermediate, setOebAreaAlongMax, setOebAreaAlongMin, setOebIntermediate, setOebMax, setOebMin, setOebParentFrame, setOebParentFrameEpoch, setOebQ, setRcs, setReflectance, setVmAbsolute, setVmApparent, setVmApparentMax, setVmApparentMin

Methods inherited from class org.orekit.files.ccsds.section.CommentsContainer

acceptComments, addComment, checkAllowed, checkNotNaN, checkNotNegative, checkNotNull, getComments, refuseFurtherComments

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdditionalParameters

public AdditionalParameters()

Simple constructor.

Method Detail

validate

public void validate(double version)

Check is all mandatory entries have been initialized.

This method should throw an exception if some mandatory entries are missing or not compatible with version number.

Specified by:

validate in interface Section

Overrides:

validate in class CommonPhysicalProperties

Parameters:

version - format version

getAreaPC

public double getAreaPC()

Get the actual area of the object.

Returns:

the object area (in m²)

setAreaPC

public void setAreaPC(double areaPC)

Set the actual area of the object.

Parameters:

areaPC - area (in m²) value to be set

getAreaDRG

public double getAreaDRG()

Get the effective area of the object exposed to atmospheric drag.

Returns:

the object area (in m²) exposed to atmospheric drag

setAreaDRG

public void setAreaDRG(double areaDRG)

Set the effective area of the object exposed to atmospheric drag.

Parameters:

areaDRG - area (in m²) value to be set

getAreaSRP

public double getAreaSRP()

Get the effective area of the object exposed to solar radiation pressure.

Returns:

the object area (in m²) exposed to solar radiation pressure

setAreaSRP

public void setAreaSRP(double areaSRP)

Set the effective area of the object exposed to solar radiation pressure.

Parameters:

areaSRP - area (in m²) to be set

getMass

public double getMass()

Get the mass of the object.

Returns:

the mass (in kg) of the object

setMass

public void setMass(double mass)

Set the mass of the object.

Parameters:

mass - mass (in kg) of the object to be set

getCDAreaOverMass

public double getCDAreaOverMass()

Get the object’s Cd x A/m used to propagate the state vector and covariance to TCA.

Returns:

the object’s Cd x A/m (in m²/kg)

setCDAreaOverMass

public void setCDAreaOverMass(double CDAreaOverMass)

Set the object’s Cd x A/m used to propagate the state vector and covariance to TCA.

Parameters:

CDAreaOverMass - object’s Cd x A/m (in m²/kg) value to be set

getCRAreaOverMass

public double getCRAreaOverMass()

Get the object’s Cr x A/m used to propagate the state vector and covariance to TCA.

Returns:

the object’s Cr x A/m (in m²/kg)

setCRAreaOverMass

public void setCRAreaOverMass(double CRAreaOverMass)

Set the object’s Cr x A/m used to propagate the state vector and covariance to TCA.

Parameters:

CRAreaOverMass - object’s Cr x A/m (in m²/kg) value to be set

getThrustAcceleration

public double getThrustAcceleration()

Get the object’s acceleration due to in-track thrust used to propagate the state vector and covariance to TCA.

Returns:

the object’s acceleration (in m/s²) due to in-track thrust

setThrustAcceleration

public void setThrustAcceleration(double thrustAcceleration)

Set the object’s acceleration due to in-track thrust used to propagate the state vector and covariance to TCA.

Parameters:

thrustAcceleration - object’s acceleration (in m/s²) due to in-track thrust

getSedr

public double getSedr()

Get the amount of energy being removed from the object’s orbit by atmospheric drag. This value is an average calculated during the OD. SEDR = Specific Energy Dissipation Rate.

Returns:

the amount of energy (in W/kg) being removed from the object’s orbit by atmospheric drag

setSedr

public void setSedr(double SEDR)

Set the amount of energy being removed from the object’s orbit by atmospheric drag. This value is an average calculated during the OD. SEDR = Specific Energy Dissipation Rate.

Parameters:

SEDR - amount of energy (in W/kg) being removed from the object’s orbit by atmospheric drag

getAreaPCMin

public double getAreaPCMin()

Set the minimum area of the object to be used to compute the collision probability.

Returns:

the areaPCMin

setAreaPCMin

public void setAreaPCMin(double areaPCMin)

Get the minimum area of the object to be used to compute the collision probability.

Parameters:

areaPCMin - the areaPCMin to set

getAreaPCMax

public double getAreaPCMax()

Get the maximum area of the object to be used to compute the collision probability.

Returns:

the areaPCMax

setAreaPCMax

public void setAreaPCMax(double areaPCMax)

Set the maximum area for the object to be used to compute the collision probability.

Parameters:

areaPCMax - the areaPCMax to set

getHbr

public double getHbr()

Get the object hard body radius.

Returns:

the object hard body radius.

setHbr

public void setHbr(double hbr)

Set the object hard body radius.

Parameters:

hbr - the object hard body radius.

getApoapsisAltitude

public double getApoapsisAltitude()

Get the distance of the furthest point in the objects orbit above the equatorial radius of the central body.

Returns:

the apoapsisAltitude

setApoapsisAltitude

public void setApoapsisAltitude(double apoapsisAltitude)

Set the distance of the furthest point in the objects orbit above the equatorial radius of the central body.

Parameters:

apoapsisAltitude - the apoapsisHeight to set

getPeriapsissAltitude

public double getPeriapsissAltitude()

Get the distance of the closest point in the objects orbit above the equatorial radius of the central body.

Returns:

the periapsissAltitude

setPeriapsissAltitude

public void setPeriapsissAltitude(double periapsissAltitude)

Set the distance of the closest point in the objects orbit above the equatorial radius of the central body.

Parameters:

periapsissAltitude - the periapsissHeight to set

getInclination

public double getInclination()

Get the angle between the objects orbit plane and the orbit centers equatorial plane.

Returns:

the inclination

setInclination

public void setInclination(double inclination)

Set the angle between the objects orbit plane and the orbit centers equatorial plane.

Parameters:

inclination - the inclination to set

getCovConfidence

public double getCovConfidence()

Get the measure of the confidence in the covariance errors matching reality.

Returns:

the covConfidence

setCovConfidence

public void setCovConfidence(double covConfidence)

Set the measure of the confidence in the covariance errors matching reality.

Parameters:

covConfidence - the covConfidence to set

getCovConfidenceMethod

public String getCovConfidenceMethod()

Get the method used for the calculation of COV_CONFIDENCE.

Returns:

the covConfidenceMethod

setCovConfidenceMethod

public void setCovConfidenceMethod(String covConfidenceMethod)

Set the method used for the calculation of COV_CONFIDENCE.

Parameters:

covConfidenceMethod - the covConfidenceMethod to set