Signal name Type Default. More...

#include <SimScheduler.h>

Inheritance diagram for modelspace::SimScheduler::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...

GraphTreeObject *	parent ()
	Functions to get object's parent/children. More...

GraphTreeObject **	children ()

GraphTreeObject *	childAtIndex (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...

GraphTreeObject *	getRootDataPointer ()
	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< int >	integrator_type = clockwerk::DataIO< int >(this, "integrator_type", 4 )
	The integrator type for the scheduler. Sets how models are integrated. More...

clockwerk::DataIO< Frame * >	root_frame_ptr = clockwerk::DataIO< Frame* >(this, "root_frame_ptr", nullptr )
	This is a pointer to the simulation's root frame. Sets frame for dynamics model. More...

clockwerk::DataIO< int >	max_real_time_multiple = clockwerk::DataIO< int >(this, "max_real_time_multiple", -1 )

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...

Detailed Description

Signal name Type Default.

Constructor & Destructor Documentation

◆ Params()

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

inline

Member Data Documentation

◆ integrator_type

clockwerk::DataIO< int > modelspace::SimScheduler::Params::integrator_type = clockwerk::DataIO< int >(this, "integrator_type", 4 )

The integrator type for the scheduler. Sets how models are integrated.

◆ max_real_time_multiple

clockwerk::DataIO< int > modelspace::SimScheduler::Params::max_real_time_multiple = clockwerk::DataIO< int >(this, "max_real_time_multiple", -1 )

The maximum multiple of real time at which the sim will run on a single step. For example, 2 will make the simulation cap speed at double real time. Any negative number does not set a cap on run speed. This is the default behavior. This multiple is achieved by blocking on start step to ensure the timing multiple is met.

◆ root_frame_ptr

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

This is a pointer to the simulation's root frame. Sets frame for dynamics model.

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

/home/mickey/Documents/modelspace/cpp/src/simulation/SimScheduler.h

Public Member Functions

Public Attributes