TRMutex Class Reference

#include <TRMutex.h>

Public Member Functions
	TRMutex ()
void	updatePriority (priorityLevels desiredLevel)
void	print (int integer, priorityLevels priority)
void	print (char statement[], priorityLevels priority)
void	println (int integer, priorityLevels priority)
void	println (char statement[], priorityLevels priority)
void	printff (const char *format, priorityLevels priority,...)

Static Public Member Functions
static void	loop ()

Public Attributes
Thread	print_code_thread
priorityLevels	priorityIndicator

Detailed Description

The TRMutex class defines the use of printing through Mutex and threading. This class contains methods that can be used in place of print statements for better efficiency.

Constructor & Destructor Documentation

TRMutex()

TRMutex::TRMutex

(

)

Constructor for creating a TRMutex object. By calling the constructor, the thread above automatically begins running.

Member Function Documentation

loop()

void TRMutex::loop ( )

static

Loop running within the thread called by the TRMutex constructor.

print() [1/2]

void TRMutex::print	(	char	statement[],
		priorityLevels	priority
	)

Method to print string arguments with no newline at the end.

Parameters

string	to print
enum	of print priority level

print() [2/2]

void TRMutex::print	(	int	integer,
		priorityLevels	priority
	)

Method to print integer arguments with no newline at the end.

Parameters

integer	to print
enum	of print priority level

printff()

void TRMutex::printff	(	const char *	format,
		priorityLevels	priority,
			...
	)

Method that mimics the printf() functionality

Parameters

string	that contains the formatting desired. (eg. d, s etc.)
enum	of print priority level
arguments	to be formatted

println() [1/2]

void TRMutex::println	(	char	statement[],
		priorityLevels	priority
	)

Method to print string arguments with a newline at the end.

Parameters

string	to print
enum	of print priority level

println() [2/2]

void TRMutex::println	(	int	integer,
		priorityLevels	priority
	)

Method to print integer arguments with a newline at the end.

Parameters

integer	to print
enum	of print priority level

updatePriority()

void TRMutex::updatePriority

(

priorityLevels

desiredLevel

)

Method to change priority level to determine which print statements will happen

Parameters

enum	of priority level desired

Member Data Documentation

print_code_thread

Thread TRMutex::print_code_thread

Creates a thread which will be running alongside robot code, simultaneously printing data when methods from TRMutex are called.

priorityIndicator

priorityLevels TRMutex::priorityIndicator

int storing priorityIndicator

---

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

• core/util/algorithms/TRMutex.h
• core/util/algorithms/TRMutex.cpp