modelspace::LogManager Class Reference

Class to manage logs. More...

#include <LogManager.h>

Inheritance diagram for modelspace::LogManager:

Collaboration diagram for modelspace::LogManager:

Public Member Functions
	LogManager (clockwerk::Executive &executive)
	Constructor for the log manager.
	~LogManager ()
	Destructor for the log manager. Frees memory allocated internally to logging events and monitors.
void	addLog (clockwerk::SimLogger &log, const clockwerk::Time &rate)
	Overloaded function to register and set up a logger.
void	addLog (clockwerk::SimLogger &log, unsigned int rate)
	Overloaded function to register and set up a logger.
void	addLog (clockwerk::SimLogger &log, clockwerk::Monitor &monitor)
	Overloaded function to register and set up a logger.
void	outDir (const std::string &directory)
	Function to set output directory for all logs.
GraphTreeObject *	parent ()
	Functions to get object's parent/children.
int	parent (GraphTreeObject *new_parent)
	Function to assign the node's parent via pointer.
int	parent (GraphTreeObject &new_parent)
	Function to assign the node's parent via reference.
std::vector< GraphTreeObject * > &	children ()
unsigned int	nChildren ()
	Getters for number of children and descendants.
unsigned int	nDescendants ()
std::string	name () const
	Getter and setter for object name.
int	name (const std::string &new_name)
int	rank ()
	Getter for the object rank.
virtual int	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.
std::string	address ()
	Getter for object's string address.
std::vector< std::string >	search (const std::string &address)
	Function to search through the graph tree by string address.
GraphTreeObject *	getByAddress (const std::string &address)
	Function to get an object from the graph tree by string address.
void	dump (bool recursive=false)
	Function to dump the graph node, optionally including descendents.
void	graphNodeInfo ()
	Function to return all info associated with a given graph node.
void	recurseGraphNodeInfo (unsigned int counter)
	Function to recurse through graph tree and print all node info.
virtual int	header (void *logger)
	Function to pass headers for this object to the logger.
virtual std::vector< std::string >	header_info () const
void	findLoggable (std::vector< GraphTreeObject * > &matches)
	Function to find all loggable parameters in this node and its children.
virtual int	log (void *logger)
	Function to log data to a logger.
void	lock (bool recursive=true)
	Function to lock the graph tree object and its children to changes.
void	unlock (bool recursive=true)
	Function to unlock the graph tree and its children for changes.
bool	locked ()
	Function to return whether graph tree object is locked.

Public Attributes
clockwerk::Executive &	exc

Protected Member Functions
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.
std::vector< std::string >	decomposeAddress (std::string address)
	Function to decompose a string into a series of substrings via indexing.
void	findMatches (const std::vector< std::string > &subaddresses, const unsigned int &num_subaddresses, unsigned int index, bool match_found, std::vector< GraphTreeObject * > &matches)
	Function to find all addresses mathcing the set of substrings @parem subaddresses A vector of subaddresses to match.
std::vector< GraphTreeObject * >	searchNodes (const std::string &address)
	Function to search through the graph tree by string address.
int	addChild (GraphTreeObject *child)
	Function to add a child to the graph tree object.
int	removeChild (GraphTreeObject *child)
	Function to remove a child from the graph node's children.

Protected Attributes
std::string	_output_directory = ""
	Output directory.
std::vector< LogEvent * >	_log_events
	List of logging events.
std::vector< RateMonitor * >	_monitors
	List of rate monitors established in the log manager.
GraphTreeObject *	_parent = nullptr
	Pointer to the object's parent – should be null if the object is the root. Is set to null by default.
std::vector< GraphTreeObject * >	_children
	Pointers to the object's children – automatically set to an empty vector, and can be increased to any size.
std::string	_name = DEFAULT_NAME
	String name for object.
uint16_t	_num_descendants = 0
	Total number of descendants (includes children of children) of the tree, again not including the tree itself.
uint8_t	_num_children = 0
	Number of direct children of the tree (not including the tree itself)
uint8_t	_rank = 0
	Rank for how far down on the graph tree the object is – starts at zero and maxes out at 256 via variable size.
uint8_t	_graph_tree_type = BASE_GRAPH_TREE
	Variable to store graph tree object type.
bool	_locked = false
	Variable to lock the graph tree object and prevent structural updates.
bool	_loggable = false
	Variable to indicate whether the selected object is loggable. Set to false by default.

Detailed Description

Class to manage logs.

This is the header for the log manager, which is responsible for adding logs to the simulation and ensuring they are executed in accordance with their rate or triggers.

Member Function Documentation

addChild()

int clockwerk::GraphTreeObject::addChild ( GraphTreeObject *  child )

protectedinherited

Function to add a child to the graph tree object.

Parameters

child

A pointer to the graph tree object to add to the tree

Returns

An error code corresponding to success/failure

addLog() [1/3]

void modelspace::LogManager::addLog	(	clockwerk::SimLogger &	log,
		clockwerk::Monitor &	monitor
	)

Overloaded function to register and set up a logger.

Parameters

log	The logger to add to the sim
monitor	The monitor which triggers the logger

addLog() [2/3]

void modelspace::LogManager::addLog	(	clockwerk::SimLogger &	log,
		const clockwerk::Time &	rate
	)

Overloaded function to register and set up a logger.

Parameters

log	The logger to add to the sim
rate	The rate, as a Time object, at which the logger should log

addLog() [3/3]

void modelspace::LogManager::addLog	(	clockwerk::SimLogger &	log,
		unsigned int	rate
	)

Overloaded function to register and set up a logger.

Parameters

log	The logger to add to the sim
rate	The rate, in Hz, at which the logger should log

address()

std::string clockwerk::GraphTreeObject::address ( )

inherited

Getter for object's string address.

Returns

Returns the string address for the object

decomposeAddress()

std::vector< std::string > clockwerk::GraphTreeObject::decomposeAddress ( std::string  address )

protectedinherited

Function to decompose a string into a series of substrings via indexing.

Parameters

address

The address to be decomposed

Returns

A vector of strings containing each delimeter-separated substring

dump()

void clockwerk::GraphTreeObject::dump ( bool  recursive = false )

inherited

Function to dump the graph node, optionally including descendents.

Parameters

recursive

Parameter indicating whether to dump only one node (default/false) or the entire tree (true)

Note

Recursive dumps the whole tree... be careful what you wish for

findLoggable()

void clockwerk::GraphTreeObject::findLoggable ( std::vector< GraphTreeObject * > &  matches )

inherited

Function to find all loggable parameters in this node and its children.

Parameters

matches

Expandable vector to hold all matches in the tree

findMatches()

void clockwerk::GraphTreeObject::findMatches ( const std::vector< std::string > &  subaddresses, const unsigned int &  num_subaddresses, unsigned int  index, bool  match_found, std::vector< GraphTreeObject * > &  matches  )

protectedinherited

Function to find all addresses mathcing the set of substrings @parem subaddresses A vector of subaddresses to match.

Parameters

num_subaddresses	The number of subaddresses to match
index	The index of subaddresses to search in
match_found	Variable indicating whether a match was found higher in the tree
matches	Implicit return of all matches to the specified address

getByAddress()

GraphTreeObject * clockwerk::GraphTreeObject::getByAddress ( const std::string &  address )

inherited

Function to get an object from the graph tree by string address.

Parameters

address

The exact string address to access the variable with

Returns

Pointer to the graph tree object at the address, or nullptr if address is not valid or returns

header()

virtual int clockwerk::GraphTreeObject::header ( void *  logger )

inlinevirtualinherited

Function to pass headers for this object to the logger.

Parameters

logger

Pointer to logger

Returns

Error code corresponding to success/failure

Reimplemented in clockwerk::DataIO< T >, clockwerk::DataIO< bool >, clockwerk::DataIO< clockwerk::Body< double > * >, clockwerk::DataIO< clockwerk::Body< T > * >, clockwerk::DataIO< clockwerk::CartesianVector< double, 2 > >, clockwerk::DataIO< clockwerk::CartesianVector< double, 3 > >, clockwerk::DataIO< clockwerk::CartesianVector< T, 3 > >, clockwerk::DataIO< clockwerk::Euler321< double > >, clockwerk::DataIO< clockwerk::Frame< double > * >, clockwerk::DataIO< clockwerk::Frame< T > * >, clockwerk::DataIO< clockwerk::Matrix< double, 2, 2 > >, clockwerk::DataIO< clockwerk::Matrix< double, 3, 3 > >, clockwerk::DataIO< clockwerk::Matrix< double, 6, 3 > >, clockwerk::DataIO< clockwerk::Matrix< double, 6, 6 > >, clockwerk::DataIO< clockwerk::Matrix< T, 3, 3 > >, clockwerk::DataIO< clockwerk::Node< double > * >, clockwerk::DataIO< clockwerk::Quaternion< double > >, clockwerk::DataIO< clockwerk::Quaternion< T > >, clockwerk::DataIO< clockwerk::Time >, clockwerk::DataIO< double >, clockwerk::DataIO< int >, clockwerk::DataIO< modelspace::integrator_type_e >, clockwerk::DataIO< std::string >, and clockwerk::DataIO< void * >.

header_info()

virtual std::vector< std::string > clockwerk::GraphTreeObject::header_info ( ) const

inlinevirtualinherited

Reimplemented in clockwerk::Time.

lock()

void clockwerk::GraphTreeObject::lock ( bool  recursive = true )

inherited

Function to lock the graph tree object and its children to changes.

Parameters

recursive

Flag to indicate whether lock should be recursive

log()

virtual int clockwerk::GraphTreeObject::log ( void *  logger )

inlinevirtualinherited

Function to log data to a logger.

Parameters

logger

Pointer to logger

Returns

Error code corresponding to success/failure

Reimplemented in clockwerk::Time, clockwerk::DataIO< T >, clockwerk::DataIO< bool >, clockwerk::DataIO< clockwerk::Body< double > * >, clockwerk::DataIO< clockwerk::Body< T > * >, clockwerk::DataIO< clockwerk::CartesianVector< double, 2 > >, clockwerk::DataIO< clockwerk::CartesianVector< double, 3 > >, clockwerk::DataIO< clockwerk::CartesianVector< T, 3 > >, clockwerk::DataIO< clockwerk::Euler321< double > >, clockwerk::DataIO< clockwerk::Frame< double > * >, clockwerk::DataIO< clockwerk::Frame< T > * >, clockwerk::DataIO< clockwerk::Matrix< double, 2, 2 > >, clockwerk::DataIO< clockwerk::Matrix< double, 3, 3 > >, clockwerk::DataIO< clockwerk::Matrix< double, 6, 3 > >, clockwerk::DataIO< clockwerk::Matrix< double, 6, 6 > >, clockwerk::DataIO< clockwerk::Matrix< T, 3, 3 > >, clockwerk::DataIO< clockwerk::Node< double > * >, clockwerk::DataIO< clockwerk::Quaternion< double > >, clockwerk::DataIO< clockwerk::Quaternion< T > >, clockwerk::DataIO< clockwerk::Time >, clockwerk::DataIO< double >, clockwerk::DataIO< int >, clockwerk::DataIO< modelspace::integrator_type_e >, clockwerk::DataIO< std::string >, and clockwerk::DataIO< void * >.

outDir()

void modelspace::LogManager::outDir ( const std::string &  directory )

inline

Function to set output directory for all logs.

Parameters

directory

Directory to set as base

Note

Can be overwritten if individual log out dir is set

parent() [1/2]

int clockwerk::GraphTreeObject::parent ( GraphTreeObject &  new_parent )

inherited

Function to assign the node's parent via reference.

Parameters

new_parent

The new parent to assign the node to

Returns

Error code corresponding to success/failure

Note

This function is the only method to ADD or REMOVE a node from a tree. To add, pass the address to a GraphTreeObject to this function. To remove, pass a nullptr. Note that parents for objects on an existing tree can be reassigned

parent() [2/2]

int clockwerk::GraphTreeObject::parent ( GraphTreeObject *  new_parent )

inherited

Function to assign the node's parent via pointer.

Parameters

new_parent

The new parent to assign the node to

Returns

Error code corresponding to success/failure

Note

This function is the only method to ADD or REMOVE a node from a tree. To add, pass the address to a GraphTreeObject to this function. To remove, pass a nullptr. Note that parents for objects on an existing tree can be reassigned

recurseGraphNodeInfo()

void clockwerk::GraphTreeObject::recurseGraphNodeInfo ( unsigned int  counter )

inherited

Function to recurse through graph tree and print all node info.

Returns

String containing all recursive graph node information in tab cascade format

removeChild()

int clockwerk::GraphTreeObject::removeChild ( GraphTreeObject *  child )

protectedinherited

Function to remove a child from the graph node's children.

Parameters

child

The child to remove

Returns

Success/fail error code based on whether the child is present

search()

std::vector< std::string > clockwerk::GraphTreeObject::search ( const std::string &  address )

inherited

Function to search through the graph tree by string address.

Parameters

address

`The address or address chunk to search for

Returns

A vector of string addresses meeting the criteria specified by address

searchNodes()

std::vector< GraphTreeObject * > clockwerk::GraphTreeObject::searchNodes ( const std::string &  address )

protectedinherited

Function to search through the graph tree by string address.

Parameters

address

`The address or address chunk to search for

Returns

A vector of objects addresses meeting the criteria specified by address

type()

virtual int clockwerk::GraphTreeObject::type ( )

inlinevirtualinherited

Function to indicate type – -1 by default unless implemented downstream.

Returns

Int indicating frame type – unimplemented always -1

unlock()

void clockwerk::GraphTreeObject::unlock ( bool  recursive = true )

inherited

Function to unlock the graph tree and its children for changes.

Parameters

recursive

Flag to indicate whether unlock should be recursive

---

The documentation for this class was generated from the following files:

• /home/mickey/modelspace/cpp/src/logging/LogManager.h
• /home/mickey/modelspace/cpp/src/logging/LogManager.cpp