Class in Zendir.Classes | Inherits from Computer
Declaration
class GuidanceComputer;Description
A guidance computer can be added to a spacecraft which can control the guidance modes of the software. This is useful for having different behaviours, making use of the Guidance Software Chain Sequence.
Properties
| Declared | Description |
|---|---|
| ControllerMode | Returns the current controller mode that is being used by the guidancecomputer. |
| MappingMode | Returns the current mapping mode that is being used by the guidancecomputer. |
| NavigationMode | Returns the current navigation mode that is being used by the guidancecomputer. |
| Out_AttitudeErrorMsg | Gets the current guidance attitude error message from thepointing chain, if it exists. |
| Out_AttitudeReferenceMsg | Gets the current guidance attitude reference message from thepointing chain, if it exists. |
| Out_CommandTorqueMsg | Gets the current torque message from thecontroller chain, if it exists. |
| Out_GuidanceChainMsg | This is the output message from the computer softwarechain, describing the current state of the guidance. |
| Out_NavigationAttitudeMsg | Gets the current navigation attitude message from thenavigation chain, if it exists. |
| Out_NavigationTranslationMsg | Gets the current navigation translation message from thenavigation chain, if it exists. |
| PointingMode | Returns the current pointing mode that is being used by the guidancecomputer. |
| Inherited | Description |
|---|---|
| Behaviours | A collection of behaviours attached to this object. |
| BootTimeSeconds | Time in seconds to transition from Shutdown to Running (boot). Default 0 = instant. |
| CenterOfMassB_B | The center of mass of the component in respect to the body frame (B) of the component. This is isolated from anychildren and exists in isolation. |
| CenterOfMassDot_LB_B | The center of mass time-derivative of the component within its own local coordinates. This does not include anyof the sub-components and exists in isolation. |
| CenterOfMassDotB_B | The center of mass time-derivative of the component relative to the body frame (B). This does not include any ofthe sub-components and exists in isolation. |
| CenterOfMassL_L | The center of mass of the component within its own local coordinates. This does not include any of thesub-components and exists in isolation. |
| CenterOfMassPrime_LB_B | The center of mass general-derivative of the component within its own local coordinates. This does not includeany of the sub-components and exists in isolation. |
| CenterOfMassPrimeB_B | [m/s] The center of mass general-derivative of the component relative to the body frame (B). This does notinclude any of the sub-components and exists in isolation. |
| Children | A collection of children attached to this object. |
| CurrentState | The current state of the computer based on how much poweris being provided to the system |
| DCM_BN | The rotational DCM matrix between the body frame (B) at the top of this component chain and the inertial frame (N). |
| DCM_LB | The rotational DCM matrix between the component frame of this object (L) relative to the body frame (B). |
| DCM_LN | The DCM rotational matrix of the component relative to the inertial origin (N) of the world. |
| DCM_LP | The DCM matrix of the component in the parent’s frame (P), taken from the Component Transform (PL). |
| EnterSafeModeTimeSeconds | Time in seconds to transition from Running to Safe. Default 0 = instant. |
| ExitSafeModeTimeSeconds | Time in seconds to transition from Safe to Running. Default 0 = instant. |
| IsEnabled | Is true if the object is currently enabled. |
| LocalForward | The direction of the transform frame’s forward vector, which is along the Y axis. |
| LocalRight | The direction of the transform frame’s right vector, which is along the X axis. |
| LocalUp | The direction of the transform frame’s up vector, which is along the Z axis. |
| Mass | The component mass defined in the object. This is independent of any parent or children objects and exists inisolation. |
| MassDot | The component mass time-derivative defined in the object. This is independent of any parent or children objectsand exists in isolation. |
| Models | A collection of models attached to this object. |
| MomentOfInertia_LB | The moment of inertia of the component, measured at the local center of mass, represented with its own localcoordinates. This does not include any of the sub-components and exists in isolation. |
| MomentOfInertiaB_B | The moment of inertia of this component, measured in the body frame relative to the parented body. This isindependent of any children and exists in isolation. |
| MomentOfInertiaPrime_LB | The derivative of the moment of inertia of the component, measured at the local center of mass, represented withits own local coordinates. This does not include any of the sub-components and exists in isolation. |
| MomentOfInertiaPrimeB_B | The derivative of the moment of inertia of the component, represented in the body frame (B). This is independentand exists in isolation. |
| Name | The display name or tag of this object. |
| Nanoseconds | The number of nanoseconds since the UNIX Epoch |
| NumSoftware | The number of software that have been added to the computer. |
| Out_ComponentMassMsg | The component mass message defines the set of mass properties and states of the system within this componentlocally. This is independent of any parent or children properties or objects. |
| Out_ComputerStatusMsg | The computer status message that outputs the status of thecurrent computer. |
| Out_TransformMsg | This defines the base transform message that stores the state of the transform of this object. |
| Parent | The currently attached parent object (if any). |
| Position | [m] The position of the object relative to the parent or to world origin, if no parent exists. |
| Position_BN_N | The position of the body (the root parent B) in the inertial frame relative to the inertial point (N). |
| Position_LB_B | The position of the component relative to the root object of this hierarchy. This is in the inertial frame and ifthe component is the root object, then there will be no position. |
| Position_LN_N | The position of the inertial world space. This position is derived from the world’s transform (N). |
| Position_LP_P | The position of the object relative to the parented object (P). If there is no parent object, then this will bein the inertial frame. |
| Root | The root object in the parent chain. |
| Rotation | [-] The rotation of the object relative to the parent or to the world origin, if no parent exists. |
| Seconds | The number of seconds since the UNIX Epoch |
| ShutdownTimeSeconds | Time in seconds to transition to Shutdown. Default 0 = instant. |
| Thermal | [TEMPORARY] A reference to the thermal model that is attached to this object. This will allow the object to havethermal properties and be able to be used in thermal simulations. |
Methods
| Declared | Description |
|---|---|
| GetDockPointingMessage | Configuration message for the dock alignment pointing chain. |
| GetGroundPointingMessage | The configuration for the ground pointing software chain. |
| GetIdleControllerMessage | Defines the configuration for this software chain. |
| GetInertialPointingMessage | A reference to the configuration message for the inertial pointingchain. |
| GetMagneticTorqueBarMappingMessage | Defines the configuration for this software chain. |
| GetMRPControllerMessage | Defines the configuration for this software chain. |
| GetNadirPointingMessage | The output configuration message for this particular pointingchain. |
| GetReactionWheelMappingMessage | Defines the configuration for this software chain. |
| GetRelativePointingMessage | The relative pointing software chain configuration with allconfigurations for this particular chain. |
| GetSimpleNavigationMessage | Defines the configuration for this software chain. |
| GetSunEstimationNavigationMessage | Defines the configuration for this software chain. |
| GetSunPointingMessage | The configuration message for the sun pointing software chain |
| GetThrusterMappingMessage | Configuration message for the thruster mapping chain. |
| GetVelocityPointingMessage | Defines the configuration for this software chain. |
| LoadSoftware | Force loads all the software to ensure it is ready to go based on thecurrent modes that have been set. |
| Inherited | Description |
|---|---|
| AddObject | Returns a new simulation object with the specified type. |
| Attach | Attempts to attach this object to a new parent. This will only work if the current object is no parented to anyother object. |
| ContainsModelWithID | Returns true if an attached model satisfies the specified ID. |
| ContainsModelWithType | Returns true if an attached model satisfies the specified type. |
| Detach | This is an action to detach the current object from its parent, if it exists and move it to another object or tojust exist within the simulation. |
| FindBehavioursWithType | Returns all attached behaviours that satisfies the specified type. |
| FindBehaviourWithID | Returns an attached behaviour that satisfies the specified ID. |
| FindBehaviourWithType | Returns an attached behaviour that satisfies the specified type. |
| FindChildrenWithType | Returns all attached children that satisfies the specified type. |
| FindChildWithID | Returns an attached child that satisfies the specified ID. |
| FindChildWithType | Returns an attached child that satisfies the specified type. |
| FindModelsWithType | Returns all attached models that satisfies the specified type. |
| FindModelWithID | Returns an attached model that satisfies the specified ID. |
| FindModelWithType | Returns an attached model that satisfies the specified type. |
| FindParentWithID | Returns an attached parent that satisfies the specified ID. |
| FindParentWithType | Returns an attached parent that satisfies the specified type. |
| FindRootWithID | Returns a root object that satisfies the specified ID. |
| FindRootWithType | Returns a root object that satisfies the specified type. |
| GetModel | Returns a valid assigned model with the specified type. |
| GetWorldForward | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| GetWorldRight | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| GetWorldTransform | Returns the world transform of the object which is relative to the parent. If no parent exists, this will be thetransform of the object in world space. |
| GetWorldUp | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| IsStableState | Returns true if the state is a stable state (Running, Shutdown, Safe). |
| IsTransitionalState | Returns true if the state is a transitional state (Starting, ShuttingDown, EnteringSafeMode, ExitingSafeMode). |
| ReadBodyTransform | This method will reset the dirty flag on the mass so that it has been read successfully and is valid. |
| SafeMode | Set the computer into a safe mode - ensuring that only the mostimportant systems are running and the rest are in safety.If EnterSafeModeTimeSeconds is 0, sets Safe immediately; otherwise enters EnteringSafeMode. |
| SetWorldTransform | [DEPRECATED] THIS FUNCTION WILL BE REMOVED AND SHOULD NOT BE USED. |
| SyncClock | Syncs the current clock to the datetime as providedas a parameter. |
| UpdateMassProperties | Updates the mass properties of the current physical object at a particular time. |