OCL::TaskBrowser Class Reference

This component allows a text client to browse the peers of a peer RTT::TaskContext and execute commands. If your console does not support colors or you want a different prompt, the member variables which control these 'escape sequences' are public and may be changed. The TaskBrowser is most commonly used with its loop() method, but prior to/after calling loop(), you can invoke some other commands, to control what is displayed or to execute a fixed set of commands prior to showng the prompt. More...

#include <TaskBrowser.hpp>

Inheritance diagram for OCL::TaskBrowser:

[legend]

List of all members.

Public Types
enum	ColorTheme { nocolors, darkbg, whitebg }
Public Member Functions
void	browserAction (std::string &act)
void	evalCommand (std::string &comm)
void	evaluate (std::string &comm)
void	loop ()
	Call this method from ORO_main() to process keyboard input and thus startup the TaskBrowser.
void	printHelp (std::string command)
void	printHelp ()
void	printInfo (const std::string &peerpath)
void	printOperation (const std::string m, Service::shared_ptr ops)
void	printProgram (int line=-1)
void	printProgram (const std::string &pn, int line=-1, RTT::TaskContext *progpeer=0)
void	printResult (RTT::base::DataSourceBase *ds, bool recurse)
bool	printService (const std::string name)
void	printSource (const std::string m)
void	setColorTheme (ColorTheme t)
void	switchBack ()
void	switchTask (RTT::TaskContext *c)
void	switchTaskContext (RTT::TaskContext *tc, bool store=true)
void	switchTaskContext (std::string &path)
	TaskBrowser (RTT::TaskContext *c)
	~TaskBrowser ()
Static Public Attributes
static std::string	blue
static std::string	coloroff
static std::string	coloron
static std::string	green
static std::string	prompt
static std::string	red
static std::string	underline
Protected Member Functions
void	cancelMacro ()
void	checkPorts ()
void	doPrint (RTT::base::DataSourceBase::shared_ptr ds, bool recurse)
void	endMacro ()
void	enterTask ()
void	leaveTask ()
void	listText (std::stringstream &txtss, int start, int end, int ln, char s)
void	recordMacro (std::string name)
Service::shared_ptr	stringToService (std::string const &names)
Protected Attributes
std::string	macroname
bool	macrorecording
std::string	macrotext
std::stringstream	sresult
Private Types
typedef std::map< std::pair < RTT::TaskContext *, std::string >, int >	PTrace
Static Private Member Functions
static RTT::TaskContext *	findPeer (std::string comm)
Private Attributes
RTT::internal::DataSource < bool >::shared_ptr	accepted
int	debug
base::DataSourceBase::shared_ptr	last_expr
int	lastc
char *	line_read
PTrace	ptraces
int	storedline
	last program listed to screen
std::string	storedname
PTrace	straces
std::deque< RTT::TaskContext * >	taskHistory
bool	usehex
	last program line number listed to screen
Static Private Attributes
static RTT::TaskContext *	context = 0
static RTT::TaskContext *	peer = 0
static RTT::TaskContext *	taskcontext = 0
static RTT::Service::shared_ptr	taskobject
static RTT::TaskContext *	tb = 0

Detailed Description

This component allows a text client to browse the peers of a peer RTT::TaskContext and execute commands. If your console does not support colors or you want a different prompt, the member variables which control these 'escape sequences' are public and may be changed. The TaskBrowser is most commonly used with its loop() method, but prior to/after calling loop(), you can invoke some other commands, to control what is displayed or to execute a fixed set of commands prior to showng the prompt.

Definition at line 86 of file TaskBrowser.hpp.

Member Typedef Documentation

typedef std::map<std::pair<RTT::TaskContext*,std::string>,int> OCL::TaskBrowser::PTrace [private]

Definition at line 112 of file TaskBrowser.hpp.

Member Enumeration Documentation

enum OCL::TaskBrowser::ColorTheme

The kinds of color themes the TaskBrowser supports.

Enumerator:

nocolors	Do not use colors.
darkbg	Use colors suitable for a dark background.
whitebg	Use colors suitable for a white background.

Definition at line 176 of file TaskBrowser.hpp.

Constructor & Destructor Documentation

OCL::TaskBrowser::TaskBrowser ( RTT::TaskContext * c )

Create a TaskBrowser which initially visits a given RTT::TaskContext c.

Definition at line 577 of file TaskBrowser.cpp.

OCL::TaskBrowser::~TaskBrowser ( )

Definition at line 612 of file TaskBrowser.cpp.

Member Function Documentation

void OCL::TaskBrowser::browserAction ( std::string & act )

Execute a specific browser action, such as "loadProgram pname", "loadStateMachine smname", "unloadProgram pname", "unloadStateMachine smname"

Definition at line 1038 of file TaskBrowser.cpp.

void OCL::TaskBrowser::cancelMacro ( ) [protected]

Definition at line 845 of file TaskBrowser.cpp.

void OCL::TaskBrowser::checkPorts ( ) [protected]

Definition at line 885 of file TaskBrowser.cpp.

void OCL::TaskBrowser::doPrint	(	RTT::base::DataSourceBase::shared_ptr	ds,
		bool	recurse
	)			`[protected]`

void OCL::TaskBrowser::endMacro ( ) [protected]

Definition at line 855 of file TaskBrowser.cpp.

void OCL::TaskBrowser::enterTask ( ) [protected]

Definition at line 803 of file TaskBrowser.cpp.

void OCL::TaskBrowser::evalCommand ( std::string & comm )

Evaluate command

Definition at line 1303 of file TaskBrowser.cpp.

void OCL::TaskBrowser::evaluate ( std::string & comm )

Execute/evaluate a string which may be a command, method, expression etc. The string does not need the script prefixes such as 'do', 'set', etc. For example "x = 1 + 1" or "myobject.doStuff(1, 2, true)".

Definition at line 1237 of file TaskBrowser.cpp.

RTT::TaskContext * OCL::TaskBrowser::findPeer ( std::string comm ) [static, private]

Definition at line 1014 of file TaskBrowser.cpp.

void OCL::TaskBrowser::leaveTask ( ) [protected]

Definition at line 813 of file TaskBrowser.cpp.