Class OrphanFrame
- java.lang.Object
-
- org.orekit.frames.OrphanFrame
-
- All Implemented Interfaces:
Serializable
public class OrphanFrame extends Object implements Serializable
Prototype frame that can be built from leaf to roots and later attached to a tree.Regular
Frame
instances can be built only from a parent frame, i.e. the frames tree can be built only from root to leafs. In some cases, it may desirable to build a subset tree and attach it to the main tree after build time, which means the tree is built from leafs to root. This class allows building this subtree.During the build process, the
Frame
associated with eachOrphanFrame
is not available. It becomes available only once theOrphanFrame
has been attached to the main tree, and at this time it can be used to computetransforms
.- Since:
- 6.0
- Author:
- Luc Maisonobe
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description OrphanFrame(String name)
Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChild(OrphanFrame child, Transform transform, boolean isPseudoInertial)
Add a child.void
addChild(OrphanFrame child, TransformProvider transformProvider, boolean isPseudoInertial)
Add a child.void
attachTo(Frame parent, Transform transform, boolean isPseudoInertial)
Attach the instance (and all its children down to leafs) to the main tree.void
attachTo(Frame parent, TransformProvider transformProvider, boolean isPseudoInertial)
Attach the instance (and all its children down to leafs) to the main tree.List<OrphanFrame>
getChildren()
Get all children of the instance.Frame
getFrame()
Get the associatedframe
.String
toString()
-
-
-
Constructor Detail
-
OrphanFrame
public OrphanFrame(String name)
Simple constructor.- Parameters:
name
- name of the frame
-
-
Method Detail
-
addChild
public void addChild(OrphanFrame child, Transform transform, boolean isPseudoInertial)
Add a child.If a child is added after the instance has been attached, the child and all its tree will be attached immediately too.
- Parameters:
child
- child to addtransform
- transform from instance to childisPseudoInertial
- true if child is considered pseudo-inertial (i.e. suitable for propagating orbit)
-
addChild
public void addChild(OrphanFrame child, TransformProvider transformProvider, boolean isPseudoInertial)
Add a child.If a child is added after the instance has been attached, the child and all its tree will be attached immediately too.
- Parameters:
child
- child to addtransformProvider
- provider for transform from instance to childisPseudoInertial
- true if child is considered pseudo-inertial (i.e. suitable for propagating orbit)
-
attachTo
public void attachTo(Frame parent, Transform transform, boolean isPseudoInertial)
Attach the instance (and all its children down to leafs) to the main tree.- Parameters:
parent
- parent frame to attach totransform
- transform from parent frame to instanceisPseudoInertial
- true if frame is considered pseudo-inertial (i.e. suitable for propagating orbit)
-
attachTo
public void attachTo(Frame parent, TransformProvider transformProvider, boolean isPseudoInertial)
Attach the instance (and all its children down to leafs) to the main tree.- Parameters:
parent
- parent frame to attach totransformProvider
- provider for transform from parent frame to instanceisPseudoInertial
- true if frame is considered pseudo-inertial (i.e. suitable for propagating orbit)
-
getChildren
public List<OrphanFrame> getChildren()
Get all children of the instance.- Returns:
- unmodifiable list of children
-
-