 |
WarpTwin
Documentation for WarpTwin models and classes.
|
|
WarpTwin
Documentation for WarpTwin models and classes.
|
#include <VisualsModel.h>
Public Member Functions | |
| Params (clockwerk::GraphTreeObject *par, const char *nme) | |
| Public Member Functions inherited from clockwerk::GraphTreeObject | |
| GraphTreeObject (const char *gt_nme="", GraphTreeObject **storage_array=nullptr, uint32 storage_size=0) | |
| Name-based constructor for GraphTreeObject which will have no children by default. | |
| virtual | ~GraphTreeObject () |
| Destructor. | |
| GraphTreeObject * | parent () |
| Functions to get object's parent/children. | |
| GraphTreeObject ** | children () |
| GraphTreeObject * | childAtIndex (uint8 i) const |
| int16 | parent (GraphTreeObject *new_parent) |
| Function to assign the node's parent via pointer. | |
| int16 | parent (GraphTreeObject &new_parent) |
| Function to assign the node's parent via reference. | |
| uint8 | nChildren () const |
| Getters for number of children and descendants. | |
| uint16 | nDescendants () const |
| uint8 | capacity () const |
| const char * | name () const |
| Getter and setter for object name. | |
| int16 | name (const char *new_name) |
| uint8 | rank () |
| Getter for the object rank. | |
| int8 | type () |
| Function to indicate type – -1 by default unless implemented downstream. | |
| bool | loggable () |
| Getter for object logability flag – note no setter because should only be set by this or a derived class in its definition. | |
| GraphTreeObject * | getRootDataPointer () |
| Get the pointer to the highest object in the graph tree. | |
| virtual int16 | str (char *output, size_t size) const |
| Get object represented as string. | |
| virtual int16 | fromStr (const char *val) |
| Set value of graphtreeobject from string. | |
Additional Inherited Members | |
| Protected Member Functions inherited from clockwerk::GraphTreeObject | |
| int16 | _setStorage (GraphTreeObject **storage_array, uint8 storage_size) |
| Getter for object's string address. | |
| void | _recalculateDescendants () |
| Function to recursively re-calculate the number of descendants of a given node on the tree. | |
| void | _recalculateRank () |
| Function to recursively re-calculate the rank of a given node on the tree. | |
| int16 | _addChild (GraphTreeObject *child) |
| Function to decompose a string into a series of substrings via indexing. | |
| int16 | _removeChild (GraphTreeObject *child) |
| Function to remove a child from the graph node's children. | |
| Protected Attributes inherited from clockwerk::GraphTreeObject | |
| GraphTreeObject * | _parent = nullptr |
| GraphTreeObject ** | _children_ptr = nullptr |
| uint32 | _max_num_children = 0 |
| uint16 | _num_descendants = 0 |
| char | _name [MAXIMUM_NAME_CHARS] = "" |
| String name for object. | |
| uint8 | _num_children = 0 |
| Number of direct children of the tree (not including the tree itself). | |
| uint8 | _rank = 0 |
| int8 | _graph_tree_type = BASE_GRAPH_TREE |
| Variable to store graph tree object type. | |
| bool | _loggable = false |
| Variable to indicate whether the selected object is loggable. Set to false by default. | |
| uint32 | _index = 0 |
| Index pointing to the next write location for the graph tree children. | |
|
inline |
| clockwerk::DataIO<clockwerk::Time> warptwin::VisualsModel::Params::gs_rate = clockwerk::DataIO<clockwerk::Time>(this, "gs_rate", clockwerk::Time(1, 0)) |
Rate of ground station logging. Sould be set fast enough to catch start/end of access
| clockwerk::DataIO<clockwerk::Time> warptwin::VisualsModel::Params::lead_time = clockwerk::DataIO<clockwerk::Time>(this, "lead_time", clockwerk::Time(0, 0)) |
Amount of lead time projected in front of spacecraft objects
| clockwerk::DataIO<std::string> warptwin::VisualsModel::Params::live_ip = clockwerk::DataIO<std::string>(this, "live_ip", "127.0.0.1") |
The IP address to which live updates should write
| clockwerk::DataIO<int> warptwin::VisualsModel::Params::live_port = clockwerk::DataIO<int>(this, "live_port", 40123) |
The port over which live updates should go
| clockwerk::DataIO<GraphTreeObject*> warptwin::VisualsModel::Params::planet_ptr = clockwerk::DataIO<GraphTreeObject*>(this, "planet_ptr", nullptr) |
A pointer to the planet object, which may be either CustomPlanet or SpicePlanet. This variable is optional, and is cast to a planet internally within the visuals model. From the planet, all frames are collected and utilized. If this variable is not set, the root frame of the simulation is utilized as the planet inertial and rotating frames. THIS MEANS PLANET_PTR MUST BE SET FOR ACCURATE ATTITUDE VISUALIZATION.
| clockwerk::DataIO<bool> warptwin::VisualsModel::Params::real_time = clockwerk::DataIO<bool>(this, "real_time", false) |
Flag to indicate whether the visuals model should run in real time/live tracking mode. If this flag is set to false, the visuals model will spit out a czml file when it finishes running, which will be ingested into the visuals. This is the default behavior. If true, it will output live visuals over a UDP socket after sending out an empty CZML file. Setting this flag to true will override the sc_rate and gs_rate parameters.
| clockwerk::DataIO<int> warptwin::VisualsModel::Params::run_cesium_app = clockwerk::DataIO<int>(this, "run_cesium_app", 1) |
Boolean indicating whether the visuals model should kick off the cesium visuals app. Default is true.
| clockwerk::DataIO<clockwerk::Time> warptwin::VisualsModel::Params::sc_rate = clockwerk::DataIO<clockwerk::Time>(this, "sc_rate", clockwerk::Time(100, 0)) |
Rate at which spacecraft state is logged. For Earth 300 seconds is sufficient due to interpolation. NOTE: Is overridden when the model is placed in live streaming mode.
| clockwerk::DataIO<clockwerk::Time> warptwin::VisualsModel::Params::trail_time = clockwerk::DataIO<clockwerk::Time>(this, "trail_time", clockwerk::Time(5400, 0)) |
Amount of trail time projected behind spacecraft objects
1.16.1