ModelSpace
Documentation for ModelSpace models and classes.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
modelspace::VisualsModel::Params Struct Reference

#include <VisualsModel.h>

Inheritance diagram for modelspace::VisualsModel::Params:

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. More...
 
virtual ~GraphTreeObject ()
 Destructor. More...
 
GraphTreeObjectparent ()
 Functions to get object's parent/children. More...
 
GraphTreeObject ** children ()
 
GraphTreeObjectchildAtIndex (uint8 i) const
 
int16 parent (GraphTreeObject *new_parent)
 Function to assign the node's parent via pointer. More...
 
int16 parent (GraphTreeObject &new_parent)
 Function to assign the node's parent via reference. More...
 
uint8 nChildren () const
 Getters for number of children and descendants. More...
 
uint16 nDescendants () const
 
uint8 capacity () const
 
const char * name () const
 Getter and setter for object name. More...
 
int16 name (const char *new_name)
 
uint8 rank ()
 Getter for the object rank. More...
 
int8 type ()
 Function to indicate type – -1 by default unless implemented downstream. More...
 
bool loggable ()
 Getter for object logability flag – note no setter because should only be set by this or a derived class in its definition. More...
 
GraphTreeObjectgetRootDataPointer ()
 Get the pointer to the highest object in the graph tree. More...
 
virtual int16 str (char *output, size_t size) const
 Get object represented as string. More...
 
virtual int16 fromStr (const char *val)
 Set value of graphtreeobject from string. More...
 

Public Attributes

clockwerk::DataIO< Frame * > planet_frame = clockwerk::DataIO< Frame* >(this, "planet_frame", nullptr )
 
clockwerk::DataIO< clockwerk::Timesc_rate = clockwerk::DataIO< clockwerk::Time >(this, "sc_rate", clockwerk::Time(100, 0) )
 
clockwerk::DataIO< clockwerk::Timegs_rate = clockwerk::DataIO< clockwerk::Time >(this, "gs_rate", clockwerk::Time(1, 0) )
 
clockwerk::DataIO< clockwerk::Timelead_time = clockwerk::DataIO< clockwerk::Time >(this, "lead_time", clockwerk::Time(5400, 0) )
 
clockwerk::DataIO< clockwerk::Timetrail_time = clockwerk::DataIO< clockwerk::Time >(this, "trail_time", clockwerk::Time(5400, 0) )
 
clockwerk::DataIO< int > run_cesium_app = clockwerk::DataIO< int >(this, "run_cesium_app", 1 )
 
clockwerk::DataIO< double > max_range = clockwerk::DataIO< double >(this, "max_range", 10000.0 )
 
clockwerk::DataIO< double > max_range_rate = clockwerk::DataIO< double >(this, "max_range_rate", 1000.0 )
 

Additional Inherited Members

- Protected Member Functions inherited from clockwerk::GraphTreeObject
int16 _setStorage (GraphTreeObject **storage_array, uint8 storage_size)
 Getter for object's string address. More...
 
void _recalculateDescendants ()
 Function to recursively re-calculate the number of descendants of a given node on the tree. More...
 
void _recalculateRank ()
 Function to recursively re-calculate the rank of a given node on the tree. More...
 
int16 _addChild (GraphTreeObject *child)
 Function to decompose a string into a series of substrings via indexing. More...
 
int16 _removeChild (GraphTreeObject *child)
 Function to remove a child from the graph node's children. More...
 
- 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. More...
 
uint8 _num_children = 0
 Number of direct children of the tree (not including the tree itself) More...
 
uint8 _rank = 0
 
int8 _graph_tree_type = BASE_GRAPH_TREE
 Variable to store graph tree object type. More...
 
bool _loggable = false
 Variable to indicate whether the selected object is loggable. Set to false by default. More...
 
uint32 _index = 0
 Index pointing to the next write location for the graph tree children. More...
 

Constructor & Destructor Documentation

◆ Params()

modelspace::VisualsModel::Params::Params ( clockwerk::GraphTreeObject par,
const char *  nme 
)
inline

Member Data Documentation

◆ gs_rate

clockwerk::DataIO< clockwerk::Time > modelspace::VisualsModel::Params::gs_rate = clockwerk::DataIO< clockwerk::Time >(this, "gs_rate", clockwerk::Time(1, 0) )

Rate of ground station logging. Sould be set low enough to catch start/end of access

◆ lead_time

clockwerk::DataIO< clockwerk::Time > modelspace::VisualsModel::Params::lead_time = clockwerk::DataIO< clockwerk::Time >(this, "lead_time", clockwerk::Time(5400, 0) )

Amount of lead time projected in front of spacecraft objects

◆ max_range

clockwerk::DataIO< double > modelspace::VisualsModel::Params::max_range = clockwerk::DataIO< double >(this, "max_range", 10000.0 )

Maximum range for a link to be considered connected (meters)

◆ max_range_rate

clockwerk::DataIO< double > modelspace::VisualsModel::Params::max_range_rate = clockwerk::DataIO< double >(this, "max_range_rate", 1000.0 )

Maximum range rate for a link to be considered connected (m/s)

◆ planet_frame

clockwerk::DataIO< Frame* > modelspace::VisualsModel::Params::planet_frame = clockwerk::DataIO< Frame* >(this, "planet_frame", nullptr )

Central planet frame for the visualization. Setting nothing defaults to use the simulation executive root frame.

◆ run_cesium_app

clockwerk::DataIO< int > modelspace::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.

◆ sc_rate

clockwerk::DataIO< clockwerk::Time > modelspace::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

◆ trail_time

clockwerk::DataIO< clockwerk::Time > modelspace::VisualsModel::Params::trail_time = clockwerk::DataIO< clockwerk::Time >(this, "trail_time", clockwerk::Time(5400, 0) )

Amount of trail time projected behind spacecraft objects


The documentation for this struct was generated from the following file: