arcs::common_interface::Trace Class Reference

provides a logging system for controller extension programs More...

#include <trace.h>

Public Member Functions
	Trace ()
virtual	~Trace ()
int	alarm (TraceLevel level, int code, const std::vector< std::string > &args={})
	Injects alarm information into the aubo_control log.
int	textmsg (const std::string &msg)
	print message into log
int	notify (const std::string &msg)
	Notify the system.
int	popup (TraceLevel level, const std::string &title, const std::string &msg, int mode)
	Send a popup request to the connected RTDE client
RobotMsgVector	peek (size_t num, uint64_t last_time=0)
	peek the latest AlarmInfo (after the last retrieval)

Protected Attributes
void *	d_

Detailed Description

provides a logging system for controller extension programs

Definition at line 21 of file trace.h.

Constructor & Destructor Documentation

Trace()

arcs::common_interface::Trace::Trace

(

)

~Trace()

virtual arcs::common_interface::Trace::~Trace ( )

virtual

Member Function Documentation

alarm()

int arcs::common_interface::Trace::alarm	(	TraceLevel	level,
		int	code,
		const std::vector< std::string > &	args = {}
	)

Injects alarm information into the aubo_control log.

TraceLevel:
0 - FATAL
1 - ERROR
2 - WARNING
3 - INFO
4 - DEBUG
Code definitions refer to error_stack

Parameters

level
code
args

Returns

Python function prototype

alarm(self: pyaubo_sdk.Trace, arg0: arcs::common_interface::TraceLevel, arg1: int, arg2: List[str]) -> int

Lua function prototype

alarm(level: number, code: number, args: table) -> nil

JSON-RPC request example

{"jsonrpc":"2.0","method":"rob1.Trace.alarm","params":["",1,["Error","Trajectory planning failed!","1"]],"id":1}

notify()

int arcs::common_interface::Trace::notify

(

const std::string &

msg

)

Notify the system.

Parameters

msg

Returns

peek()

RobotMsgVector arcs::common_interface::Trace::peek	(	size_t	num,
		uint64_t	last_time = 0
	)

peek the latest AlarmInfo (after the last retrieval)

When last_time is set as 0, retrieve all AlarmInfo

Parameters

num
last_time

Returns

Python function prototype

peek(self: pyaubo_sdk.Trace, arg0: int, arg1: int) -> List[arcs::common_interface::RobotMsg]

Lua function prototype

peek(num: number, last_time: number) -> table

JSON-RPC request example

{"jsonrpc":"2.0","method":"rob1.Trace.peek","params":[1,0],"id":1}

JSON-RPC response example

{{"id":1,"jsonrpc":"2.0","result":[{"args":["RobotModeType.Running"], "code":30045,"level":"INFO","source":"rob1","timestamp":5102883064300}]}

popup()

int arcs::common_interface::Trace::popup	(	TraceLevel	level,
		const std::string &	title,
		const std::string &	msg,
		int	mode
	)

Send a popup request to the connected RTDE client

Parameters

level
title
msg
mode	mode 0: normal mode 1: blocking mode 2: input mode bool 3: input mode int 4: input mode double 5: input mode string

Returns

Python function prototype

popup(self: pyaubo_sdk.Trace, arg0: arcs::common_interface::TraceLevel, arg1: str, arg2: str, arg3: int) -> int

Lua function prototype

popup(level: number, title: string, msg: string, mode: number) -> nil

JSON-RPC request example

{"jsonrpc":"2.0","method":"rob1.Trace.popup","params":["","Error","Trajectory planning failed!",1],"id":1}

JSON-RPC response example

{"id":1,"jsonrpc":"2.0","result":0}

textmsg()

int arcs::common_interface::Trace::textmsg

(

const std::string &

msg

)

print message into log

Parameters

msg	message information

Returns

Python function prototype

textmsg(self: pyaubo_sdk.Trace, arg0: str) -> int

Lua function prototype

textmsg(msg: string) -> nil

JSON-RPC request example

{"jsonrpc":"2.0","method":"rob1.Trace.textmsg","params":["test"],"id":1}

JSON-RPC responose example

{"id":1,"jsonrpc":"2.0","result":0}

Member Data Documentation

d_

void* arcs::common_interface::Trace::d_

protected

Definition at line 224 of file trace.h.

---

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

• include/aubo/trace.h