Package org.orekit.files.ccsds.ndm
Class CommonPhysicalProperties
- java.lang.Object
-
- org.orekit.files.ccsds.section.CommentsContainer
-
- org.orekit.files.ccsds.ndm.CommonPhysicalProperties
-
- All Implemented Interfaces:
Section
- Direct Known Subclasses:
AdditionalParameters
,Inertia
,OrbitPhysicalProperties
public class CommonPhysicalProperties extends CommentsContainer
Container for common physical properties for bothOrbitPhysicalProperties
andAdditionalParameters
.- Since:
- 11.3
- Author:
- Maxime Journot
-
-
Constructor Summary
Constructors Constructor Description CommonPhysicalProperties()
Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double
getMaxRcs()
Get the maximum radar cross-section.double
getMinRcs()
Get the minimum radar cross-section.double
getOebAreaAlongIntermediate()
Get the cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.double
getOebAreaAlongMax()
Get the cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.double
getOebAreaAlongMin()
Get the cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.double
getOebIntermediate()
Get the intermediate physical dimension of the OEB.double
getOebMax()
Get the maximum physical dimension of the OEB.double
getOebMin()
Get the minimum physical dimension of the OEB.FrameFacade
getOebParentFrame()
Get the Optimally Enclosing Box parent reference frame.AbsoluteDate
getOebParentFrameEpoch()
Get the Optimally Enclosing Box parent reference frame epoch.Quaternion
getOebQ()
Get the quaternion defining Optimally Enclosing Box.double
getRcs()
Get the typical (50th percentile) radar cross-section.double
getReflectance()
Get the typical (50th percentile) coefficient of reflectance.double
getVmAbsolute()
Get the typical (50th percentile) visual magnitude.double
getVmApparent()
Get the typical (50th percentile) apparent visual magnitude.double
getVmApparentMax()
Get the maximum apparent visual magnitude.double
getVmApparentMin()
Get the minimum apparent visual magnitude.void
setMaxRcs(double maxRcs)
Set the maximum radar cross-section.void
setMinRcs(double minRcs)
Set the minimum radar cross-section.void
setOebAreaAlongIntermediate(double oebAreaAlongIntermediate)
Set the cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.void
setOebAreaAlongMax(double oebAreaAlongMax)
Set the cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.void
setOebAreaAlongMin(double oebAreaAlongMin)
Set the cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.void
setOebIntermediate(double oebIntermediate)
Set the intermediate physical dimension of the OEB.void
setOebMax(double oebMax)
Set the maximum physical dimension of the OEB.void
setOebMin(double oebMin)
Set the minimum physical dimension of the OEB.void
setOebParentFrame(FrameFacade oebParentFrame)
Set the Optimally Enclosing Box parent reference frame.void
setOebParentFrameEpoch(AbsoluteDate oebParentFrameEpoch)
Set the Optimally Enclosing Box parent reference frame epoch.void
setOebQ(int i, double qI)
set the component of quaternion defining Optimally Enclosing Box.void
setRcs(double rcs)
Set the typical (50th percentile) radar cross-section.void
setReflectance(double reflectance)
Set the typical (50th percentile) coefficient of reflectance.void
setVmAbsolute(double vmAbsolute)
Set the typical (50th percentile) visual magnitude.void
setVmApparent(double vmApparent)
Set the typical (50th percentile) apparent visual magnitude.void
setVmApparentMax(double vmApparentMax)
Set the maximum apparent visual magnitude.void
setVmApparentMin(double vmApparentMin)
Set the minimum apparent visual magnitude.void
validate(double version)
Check is all mandatory entries have been initialized.-
Methods inherited from class org.orekit.files.ccsds.section.CommentsContainer
acceptComments, addComment, checkAllowed, checkNotNaN, checkNotNegative, checkNotNull, getComments, refuseFurtherComments
-
-
-
-
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 interfaceSection
- Overrides:
validate
in classCommentsContainer
- Parameters:
version
- format version
-
getOebParentFrame
public FrameFacade getOebParentFrame()
Get the Optimally Enclosing Box parent reference frame.- Returns:
- Optimally Enclosing Box parent reference frame
-
setOebParentFrame
public void setOebParentFrame(FrameFacade oebParentFrame)
Set the Optimally Enclosing Box parent reference frame.- Parameters:
oebParentFrame
- Optimally Enclosing Box parent reference frame
-
getOebParentFrameEpoch
public AbsoluteDate getOebParentFrameEpoch()
Get the Optimally Enclosing Box parent reference frame epoch.- Returns:
- Optimally Enclosing Box parent reference frame epoch
-
setOebParentFrameEpoch
public void setOebParentFrameEpoch(AbsoluteDate oebParentFrameEpoch)
Set the Optimally Enclosing Box parent reference frame epoch.- Parameters:
oebParentFrameEpoch
- Optimally Enclosing Box parent reference frame epoch
-
getOebQ
public Quaternion getOebQ()
Get the quaternion defining Optimally Enclosing Box.- Returns:
- quaternion defining Optimally Enclosing Box
-
setOebQ
public void setOebQ(int i, double qI)
set the component of quaternion defining Optimally Enclosing Box.- Parameters:
i
- index of the componentqI
- component of quaternion defining Optimally Enclosing Box
-
getOebMax
public double getOebMax()
Get the maximum physical dimension of the OEB.- Returns:
- maximum physical dimension of the OEB.
-
setOebMax
public void setOebMax(double oebMax)
Set the maximum physical dimension of the OEB.- Parameters:
oebMax
- maximum physical dimension of the OEB.
-
getOebIntermediate
public double getOebIntermediate()
Get the intermediate physical dimension of the OEB.- Returns:
- intermediate physical dimension of the OEB.
-
setOebIntermediate
public void setOebIntermediate(double oebIntermediate)
Set the intermediate physical dimension of the OEB.- Parameters:
oebIntermediate
- intermediate physical dimension of the OEB.
-
getOebMin
public double getOebMin()
Get the minimum physical dimension of the OEB.- Returns:
- dimensions the minimum physical dimension of the OEB.
-
setOebMin
public void setOebMin(double oebMin)
Set the minimum physical dimension of the OEB.- Parameters:
oebMin
- the minimum physical dimension of the OEB.
-
getOebAreaAlongMax
public double getOebAreaAlongMax()
Get the cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.- Returns:
- cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.
-
setOebAreaAlongMax
public void setOebAreaAlongMax(double oebAreaAlongMax)
Set the cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.- Parameters:
oebAreaAlongMax
- cross-sectional area of Optimally Enclosing Box when viewed along the maximum OEB direction.
-
getOebAreaAlongIntermediate
public double getOebAreaAlongIntermediate()
Get the cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.- Returns:
- cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.
-
setOebAreaAlongIntermediate
public void setOebAreaAlongIntermediate(double oebAreaAlongIntermediate)
Set the cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.- Parameters:
oebAreaAlongIntermediate
- cross-sectional area of Optimally Enclosing Box when viewed along the intermediate OEB direction.
-
getOebAreaAlongMin
public double getOebAreaAlongMin()
Get the cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.- Returns:
- cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.
-
setOebAreaAlongMin
public void setOebAreaAlongMin(double oebAreaAlongMin)
Set the cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.- Parameters:
oebAreaAlongMin
- cross-sectional area of Optimally Enclosing Box when viewed along the minimum OEB direction.
-
getRcs
public double getRcs()
Get the typical (50th percentile) radar cross-section.- Returns:
- typical (50th percentile) radar cross-section
-
setRcs
public void setRcs(double rcs)
Set the typical (50th percentile) radar cross-section.- Parameters:
rcs
- typical (50th percentile) radar cross-section
-
getMinRcs
public double getMinRcs()
Get the minimum radar cross-section.- Returns:
- minimum radar cross-section
-
setMinRcs
public void setMinRcs(double minRcs)
Set the minimum radar cross-section.- Parameters:
minRcs
- minimum radar cross-section
-
getMaxRcs
public double getMaxRcs()
Get the maximum radar cross-section.- Returns:
- maximum radar cross-section
-
setMaxRcs
public void setMaxRcs(double maxRcs)
Set the maximum radar cross-section.- Parameters:
maxRcs
- maximum radar cross-section
-
getVmAbsolute
public double getVmAbsolute()
Get the typical (50th percentile) visual magnitude.- Returns:
- typical (50th percentile) visual magnitude
-
setVmAbsolute
public void setVmAbsolute(double vmAbsolute)
Set the typical (50th percentile) visual magnitude.- Parameters:
vmAbsolute
- typical (50th percentile) visual magnitude
-
getVmApparentMin
public double getVmApparentMin()
Get the minimum apparent visual magnitude.- Returns:
- minimum apparent visual magnitude
-
setVmApparentMin
public void setVmApparentMin(double vmApparentMin)
Set the minimum apparent visual magnitude.- Parameters:
vmApparentMin
- minimum apparent visual magnitude
-
getVmApparent
public double getVmApparent()
Get the typical (50th percentile) apparent visual magnitude.- Returns:
- typical (50th percentile) apparent visual magnitude
-
setVmApparent
public void setVmApparent(double vmApparent)
Set the typical (50th percentile) apparent visual magnitude.- Parameters:
vmApparent
- typical (50th percentile) apparent visual magnitude
-
getVmApparentMax
public double getVmApparentMax()
Get the maximum apparent visual magnitude.- Returns:
- maximum apparent visual magnitude
-
setVmApparentMax
public void setVmApparentMax(double vmApparentMax)
Set the maximum apparent visual magnitude.- Parameters:
vmApparentMax
- maximum apparent visual magnitude
-
getReflectance
public double getReflectance()
Get the typical (50th percentile) coefficient of reflectance.- Returns:
- typical (50th percentile) coefficient of reflectance
-
setReflectance
public void setReflectance(double reflectance)
Set the typical (50th percentile) coefficient of reflectance.- Parameters:
reflectance
- typical (50th percentile) coefficient of reflectance
-
-