public class CdmRelativeMetadata extends Object
Constructor and Description |
---|
CdmRelativeMetadata()
Simple constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addComment(String comments)
Set comment for relative metadata.
|
void |
checkNotNull(Object field,
Enum<?> key)
Complain if a field is null.
|
void |
checkScreenVolumeConditions()
Check screen volume conditions.
|
double |
getApproachAngle()
Get the approach angle computed between Objects 1 and 2 in the RTN coordinate frame relative to object 1.
|
int[] |
getCollisionPercentile()
Get the array of 1 to n elements indicating the percentile(s) for which estimates of the collision probability are provided in the
COLLISION_PROBABILITY variable.
|
double |
getCollisionProbability()
Get the probability (between 0.0 and 1.0) that Object1 and Object2 will collide.
|
PocMethodFacade |
getCollisionProbaMethod()
Get the method that was used to calculate the collision probability.
|
List<String> |
getComment()
Get comment for relative metadata.
|
String |
getConjunctionId()
Get the Originator’s ID that uniquely identifies the conjunction to which the message refers.
|
double |
getMahalanobisDistance()
Get the Mahalanobis Distance.
|
double |
getMaxCollisionProbability()
Get max collision probability.
|
PocMethodFacade |
getMaxCollisionProbabilityMethod()
Get max collision probability method.
|
double |
getMissDistance()
Get the norm of relative position vector at TCA.
|
AbsoluteDate |
getNextMessageEpoch()
Get Scheduled UTC epoch of the next CDM associated with the event identified by CONJUNCTION_ID.
|
AbsoluteDate |
getPreviousMessageEpoch()
Get the UTC epoch of the previous CDM issued for the event identified by CONJUNCTION_ID.
|
String |
getPreviousMessageId()
Get the ID of previous CDM issued for event identified by CONJUNCTION_ID.
|
org.hipparchus.geometry.euclidean.threed.Vector3D |
getRelativePosition()
Get the Object2’s position vector relative to Object1's at TCA in RTN frame, getX for R component,
getY for T component, getZ for N component.
|
double |
getRelativeSpeed()
Get the norm of relative velocity vector at TCA.
|
org.hipparchus.geometry.euclidean.threed.Vector3D |
getRelativeVelocity()
Get the Object2’s velocity vector relative to Object1's at TCA in RTN frame, getX for R component,
getY for T component, getZ for N component.
|
AbsoluteDate |
getScreenEntryTime()
Get the time in UTC when Object2 enters the screening volume.
|
AbsoluteDate |
getScreenExitTime()
Get the time in UTC when Object2 exits the screening volume.
|
double |
getScreenPcThreshold()
Get the collision probability screening threshold used to identify this conjunction.
|
ScreenType |
getScreenType()
Get the type of screening to be used.
|
ScreenVolumeFrame |
getScreenVolumeFrame()
Get the name of the Object1 centered reference frame in which the screening volume data are given.
|
double |
getScreenVolumeRadius()
Get the screen volume radius.
|
ScreenVolumeShape |
getScreenVolumeShape()
Get the shape of the screening volume.
|
double |
getScreenVolumeX()
Get the R or T (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
|
double |
getScreenVolumeY()
Get the T or V (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
|
double |
getScreenVolumeZ()
Get the N component size of the screening volume in the corresponding frame.
|
double |
getSefiCollisionProbability()
Get the Space Environment Fragmentation Impact probability.
|
PocMethodFacade |
getSefiCollisionProbabilityMethod()
Get the Space Environment Fragmentation Impact probability method.
|
String |
getSefiFragmentationModel()
Get the Space Environment Fragmentation Impact fragmentation model.
|
AbsoluteDate |
getStartScreenPeriod()
Get the start time in UTC of the screening period for the conjunction assessment.
|
AbsoluteDate |
getStopScreenPeriod()
Get the stop time in UTC of the screening period for the conjunction assessment.
|
AbsoluteDate |
getTca()
Get the date and time in UTC of the closest approach.
|
TimeSystem |
getTimeSystem()
Get the Time System that: for CDM, is used for relative metadata, metadata,
OD parameters, state vector.
|
void |
setApproachAngle(double approachAngle)
Set the approach angle computed between Objects 1 and 2 in the RTN coordinate frame relative to object 1.
|
void |
setCollisionPercentile(int[] collisionPercentile)
Set the array of 1 to n elements indicating the percentile(s) for which estimates of the collision probability are provided in the
COLLISION_PROBABILITY variable.
|
void |
setCollisionProbability(double collisionProbability)
Set the probability (between 0.0 and 1.0) that Object1 and Object2 will collide.
|
void |
setCollisionProbaMethod(PocMethodFacade collisionProbaMethod)
Set the method that was used to calculate the collision probability.
|
void |
setConjunctionId(String conjunctionId)
Set the Originator’s ID that uniquely identifies the conjunction to which the message refers.
|
void |
setMahalanobisDistance(double mahalanobisDistance)
Set the Mahalanobis Distance.
|
void |
setMaxCollisionProbability(double maxCollisionProbability)
Set max collision probability.
|
void |
setMaxCollisionProbabilityMethod(PocMethodFacade pocMethodFacade)
Set max collision probability method.
|
void |
setMissDistance(double missDistance)
Set the norm of relative position vector at TCA.
|
void |
setNextMessageEpoch(AbsoluteDate nextMessageEpoch)
Set Scheduled UTC epoch of the next CDM associated with the event identified by CONJUNCTION_ID.
|
void |
setPreviousMessageEpoch(AbsoluteDate previousMessageEpoch)
Set the UTC epoch of the previous CDM issued for the event identified by CONJUNCTION_ID.
|
void |
setPreviousMessageId(String previousMessageId)
Set the ID of previous CDM issued for event identified by CONJUNCTION_ID.
|
void |
setRelativePositionN(double relativePositionN)
Set the N component of Object2’s position relative to Object1’s in RTN frame.
|
void |
setRelativePositionR(double relativePositionR)
Set the R component of Object2’s position relative to Object1’s in RTN frame.
|
void |
setRelativePositionT(double relativePositionT)
Set the T component of Object2’s position relative to Object1’s in RTN frame.
|
void |
setRelativeSpeed(double relativeSpeed)
Set the norm of relative velocity vector at TCA.
|
void |
setRelativeVelocityN(double relativeVelocityN)
Set the N component of Object2’s velocity relative to Object1’s in RTN frame.
|
void |
setRelativeVelocityR(double relativeVelocityR)
Set the R component of Object2’s velocity relative to Object1’s in RTN frame.
|
void |
setRelativeVelocityT(double relativeVelocityT)
Set the T component of Object2’s velocity relative to Object1’s in RTN frame.
|
void |
setScreenEntryTime(AbsoluteDate screenEntryTime)
Set the time in UTC when Object2 enters the screening volume.
|
void |
setScreenExitTime(AbsoluteDate screenExitTime)
Set the time in UTC when Object2 exits the screening volume.
|
void |
setScreenPcThreshold(double screenPcThreshold)
Set the collision probability screening threshold used to identify this conjunction.
|
void |
setScreenType(ScreenType screenType)
Set the type of screening to be used.
|
void |
setScreenVolumeFrame(ScreenVolumeFrame screenVolumeFrame)
Set the name of the Object1 centered reference frame in which the screening volume data are given.
|
void |
setScreenVolumeRadius(double screenVolumeRadius)
set the screen volume radius.
|
void |
setScreenVolumeShape(ScreenVolumeShape screenVolumeShape)
Set the shape of the screening volume.
|
void |
setScreenVolumeX(double screenVolumeX)
Set the R or T (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
|
void |
setScreenVolumeY(double screenVolumeY)
Set the T or V (depending on if RTN or TVN is selected) component size of the screening volume in the corresponding frame.
|
void |
setScreenVolumeZ(double screenVolumeZ)
Set the N component size of the screening volume in the corresponding frame.
|
void |
setSefiCollisionProbability(double sefiCollisionProbability)
Set the Space Environment Fragmentation Impact probability.
|
void |
setSefiCollisionProbabilityMethod(PocMethodFacade pocMethodFacade)
Set the Space Environment Fragmentation Impact probability method.
|
void |
setSefiFragmentationModel(String sefiFragmentationModel)
Set the Space Environment Fragmentation Impact fragmentation model.
|
void |
setStartScreenPeriod(AbsoluteDate startScreenPeriod)
Set the start time in UTC of the screening period for the conjunction assessment.
|
void |
setStopScreenPeriod(AbsoluteDate stopScreenPeriod)
Set the stop time in UTC of the screening period for the conjunction assessment.
|
void |
setTca(AbsoluteDate tca)
Set the date and time in UTC of the closest approach.
|
void |
setTimeSystem(TimeSystem timeSystem)
Set the Time System that: for CDM, is used for relative metadata, metadata,
OD parameters, state vector.
|
void |
validate()
Check is all mandatory entries have been initialized.
|
public void validate()
public String getConjunctionId()
public void setConjunctionId(String conjunctionId)
conjunctionId
- the conjunction id to be setpublic AbsoluteDate getTca()
public void setTca(AbsoluteDate tca)
tca
- time of closest approach to be setpublic double getMissDistance()
public void setMissDistance(double missDistance)
missDistance
- the miss distance to be set (in m)public double getRelativeSpeed()
public void setRelativeSpeed(double relativeSpeed)
relativeSpeed
- the relative speed (in m/s) at TCA to be setpublic org.hipparchus.geometry.euclidean.threed.Vector3D getRelativeVelocity()
public org.hipparchus.geometry.euclidean.threed.Vector3D getRelativePosition()
public void setRelativePositionR(double relativePositionR)
relativePositionR
- the R component (in m) of Object2’s position relative to Object1’spublic void setRelativePositionT(double relativePositionT)
relativePositionT
- the T component (in m) of Object2’s position relative to Object1’spublic void setRelativePositionN(double relativePositionN)
relativePositionN
- the N component (in m) of Object2’s position relative to Object1’spublic void setRelativeVelocityR(double relativeVelocityR)
relativeVelocityR
- the R component (in m/s) of Object2’s velocity relative to Object1’spublic void setRelativeVelocityT(double relativeVelocityT)
relativeVelocityT
- the T component (in m/s) of Object2’s velocity relative to Object1’spublic void setRelativeVelocityN(double relativeVelocityN)
relativeVelocityN
- the N component (in m/s) of Object2’s velocity relative to Object1’spublic AbsoluteDate getStartScreenPeriod()
public void setStartScreenPeriod(AbsoluteDate startScreenPeriod)
startScreenPeriod
- start time in UTC of the screening period to be setpublic AbsoluteDate getStopScreenPeriod()
public void setStopScreenPeriod(AbsoluteDate stopScreenPeriod)
stopScreenPeriod
- stop time in UTC of the screening period to be setpublic ScreenVolumeFrame getScreenVolumeFrame()
public void setScreenVolumeFrame(ScreenVolumeFrame screenVolumeFrame)
screenVolumeFrame
- name of screen volume framepublic ScreenVolumeShape getScreenVolumeShape()
public void setScreenVolumeShape(ScreenVolumeShape screenVolumeShape)
screenVolumeShape
- shape of the screening volumepublic double getScreenVolumeX()
public void setScreenVolumeX(double screenVolumeX)
screenVolumeX
- first component size of the screening volume (in m)public double getScreenVolumeY()
public void setScreenVolumeY(double screenVolumeY)
screenVolumeY
- second component size of the screening volume (in m)public double getScreenVolumeZ()
public void setScreenVolumeZ(double screenVolumeZ)
screenVolumeZ
- third component size of the screening volume (in m)public AbsoluteDate getScreenEntryTime()
public void setScreenEntryTime(AbsoluteDate screenEntryTime)
screenEntryTime
- time in UTC when Object2 enters the screening volumepublic AbsoluteDate getScreenExitTime()
public void setScreenExitTime(AbsoluteDate screenExitTime)
screenExitTime
- time in UTC when Object2 exits the screening volumepublic double getCollisionProbability()
public void setCollisionProbability(double collisionProbability)
collisionProbability
- first component size of the screening volumepublic PocMethodFacade getCollisionProbaMethod()
public void setCollisionProbaMethod(PocMethodFacade collisionProbaMethod)
collisionProbaMethod
- method used to calculate probability of collisionpublic void checkNotNull(Object field, Enum<?> key)
field
- field to checkkey
- key associated with the fieldpublic void setTimeSystem(TimeSystem timeSystem)
timeSystem
- the time system to be setpublic TimeSystem getTimeSystem()
public void addComment(String comments)
comments
- to be setpublic List<String> getComment()
public double getApproachAngle()
public void setApproachAngle(double approachAngle)
approachAngle
- the approachAngle to setpublic ScreenType getScreenType()
public void setScreenType(ScreenType screenType)
screenType
- the screenType to setpublic double getMaxCollisionProbability()
public void setMaxCollisionProbability(double maxCollisionProbability)
maxCollisionProbability
- the max collision probability to setpublic PocMethodFacade getMaxCollisionProbabilityMethod()
public void setMaxCollisionProbabilityMethod(PocMethodFacade pocMethodFacade)
pocMethodFacade
- the max collision probability method to setpublic double getSefiCollisionProbability()
public void setSefiCollisionProbability(double sefiCollisionProbability)
sefiCollisionProbability
- the Space Environment Fragmentation Impact probability to setpublic PocMethodFacade getSefiCollisionProbabilityMethod()
public void setSefiCollisionProbabilityMethod(PocMethodFacade pocMethodFacade)
pocMethodFacade
- the Space Environment Fragmentation Impact probability method to setpublic String getSefiFragmentationModel()
public void setSefiFragmentationModel(String sefiFragmentationModel)
sefiFragmentationModel
- the Space Environment Fragmentation Impact fragmentation model to setpublic double getMahalanobisDistance()
public void setMahalanobisDistance(double mahalanobisDistance)
mahalanobisDistance
- the mahalanobisDistance to setpublic double getScreenVolumeRadius()
public void setScreenVolumeRadius(double screenVolumeRadius)
screenVolumeRadius
- the screen volume radius to setpublic double getScreenPcThreshold()
public void setScreenPcThreshold(double screenPcThreshold)
screenPcThreshold
- the screenPcThreshold to setpublic void checkScreenVolumeConditions()
The method verifies that all keys are present. Otherwise, an exception is thrown.
public int[] getCollisionPercentile()
public void setCollisionPercentile(int[] collisionPercentile)
collisionPercentile
- the collisionPercentile to setpublic String getPreviousMessageId()
public void setPreviousMessageId(String previousMessageId)
previousMessageId
- the previousMessageId to setpublic AbsoluteDate getPreviousMessageEpoch()
public void setPreviousMessageEpoch(AbsoluteDate previousMessageEpoch)
previousMessageEpoch
- the previousMessageEpoch to setpublic AbsoluteDate getNextMessageEpoch()
public void setNextMessageEpoch(AbsoluteDate nextMessageEpoch)
nextMessageEpoch
- the nextMessageEpoch to setCopyright © 2002-2023 CS GROUP. All rights reserved.