com.qualcomm.robotcore.util

Class RobotLog

java.lang.Object

com.qualcomm.robotcore.util.RobotLog

public class RobotLog
extends java.lang.Object

Allows consistent logging across all RobotCore packages

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RobotLog.LoggingThread

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPMODE_START_TAG
static java.lang.String	OPMODE_STOP_TAG
static java.lang.String	TAG

Method Summary

Modifier and Type	Method and Description
static void	a(java.lang.String message)
static void	a(java.lang.String format, java.lang.Object... args)
static void	aa(java.lang.String tag, java.lang.String message)
static void	aa(java.lang.String tag, java.lang.String format, java.lang.Object... args)
static void	aa(java.lang.String tag, java.lang.Throwable throwable, java.lang.String message)
static void	aa(java.lang.String tag, java.lang.Throwable throwable, java.lang.String format, java.lang.Object... args)
static void	addGlobalWarningMessage(java.lang.String msg) Adds a global warning message.
static void	cancelWriteLogcatToDisk() Cancels any logcat writing to disk that might currently be going on
static void	clearGlobalErrorMsg() Clears the current global error message.
static void	clearGlobalWarningMsg() Clears the current global warning message.
static java.lang.String	combineGlobalWarnings(java.util.List<java.lang.String> warnings) Combines possibly multiple warnings together using an appropriate delimiter.
static void	d(java.lang.String message)
static void	d(java.lang.String format, java.lang.Object... args)
static void	dd(java.lang.String tag, java.lang.String message)
static void	dd(java.lang.String tag, java.lang.String format, java.lang.Object... args)
static void	dd(java.lang.String tag, java.lang.Throwable throwable, java.lang.String message)
static void	dd(java.lang.String tag, java.lang.Throwable throwable, java.lang.String format, java.lang.Object... args)
static void	e(java.lang.String message)
static void	e(java.lang.String format, java.lang.Object... args)
static void	ee(java.lang.String tag, java.lang.String message)
static void	ee(java.lang.String tag, java.lang.String format, java.lang.Object... args)
static void	ee(java.lang.String tag, java.lang.Throwable throwable, java.lang.String message)
static void	ee(java.lang.String tag, java.lang.Throwable throwable, java.lang.String format, java.lang.Object... args)
static java.util.List<java.io.File>	getExtantLogFiles(Context context)
static java.lang.String	getGlobalErrorMsg() Get the current global error message
static java.lang.String	getGlobalWarningMessage() Returns the current global warning, or "" if there is none
protected static int	getIntStatic(java.lang.Class clazz, java.lang.String name)
static long	getLocalTime(long remoteTime)
static java.lang.String	getLogFilename()
static java.lang.String	getLogFilename(Context context)
static java.lang.String	getMatchLogFilename(Context context, java.lang.String opModeName, int matchNum)
static long	getRemoteTime()
static long	getRemoteTime(long localTime)
protected static java.lang.String	getStringStatic(java.lang.Class clazz, java.lang.String name)
static boolean	hasGlobalErrorMsg() Returns true if a global error message is set
static boolean	hasGlobalWarningMsg() Returns whether a global warning currently exists
static void	i(java.lang.String message)
static void	i(java.lang.String format, java.lang.Object... args)
static void	ii(java.lang.String tag, java.lang.String message)
static void	ii(java.lang.String tag, java.lang.String format, java.lang.Object... args)
static void	ii(java.lang.String tag, java.lang.Throwable throwable, java.lang.String message)
static void	ii(java.lang.String tag, java.lang.Throwable throwable, java.lang.String format, java.lang.Object... args)
static void	internalLog(int priority, java.lang.String tag, java.lang.String message)
static void	internalLog(int priority, java.lang.String tag, java.lang.Throwable throwable, java.lang.String message)
static void	logAndThrow(java.lang.String errMsg)
static void	logBuildConfig(java.lang.Class buildConfig)
static void	logBytes(java.lang.String tag, java.lang.String caption, byte[] data, int cb)
static void	logBytes(java.lang.String tag, java.lang.String caption, byte[] data, int ibStart, int cb)
static void	logDeviceInfo()
static void	logExceptionHeader(java.lang.Exception e, java.lang.String format, java.lang.Object... args)
static void	logExceptionHeader(java.lang.String tag, java.lang.Exception e, java.lang.String format, java.lang.Object... args)
static void	logStackTrace(java.lang.String tag, java.lang.Throwable e)
static void	logStackTrace(java.lang.Thread thread, java.lang.StackTraceElement[] stackTrace)
static void	logStackTrace(java.lang.Thread thread, java.lang.String format, java.lang.Object... args)
static void	logStacktrace(java.lang.Throwable e) Deprecated. obsolete capitalization
static void	logStackTrace(java.lang.Throwable e)
static void	onApplicationStart() Write logcat logs to disk.
static void	processTimeSynch(long t0, long t1, long t2, long t3) Processes the reception of a set of NTP timestamps between this device (t0 and t3) and a remote device (t1 and t2) with whom it is trying to synchronize time.
protected static void	pruneMatchLogsIfNecessary()
static void	registerGlobalWarningSource(GlobalWarningSource globalWarningSource) Adds (if not already present) a new source that can contribute the generation of warnings on the robot controller and driver station displays (if the source is already registered, the call has no effect).
static void	setGlobalErrorMsg(RobotCoreException e, java.lang.String message)
static void	setGlobalErrorMsg(java.lang.RuntimeException e, java.lang.String message)
static boolean	setGlobalErrorMsg(java.lang.String message) Set a global error message This message stays set until clearGlobalErrorMsg is called.
static void	setGlobalErrorMsg(java.lang.String format, java.lang.Object... args)
static void	setGlobalErrorMsgAndThrow(RobotCoreException e, java.lang.String message)
static void	setGlobalErrorMsgAndThrow(java.lang.RuntimeException e, java.lang.String message)
static void	setGlobalErrorMsgSticky(boolean sticky) Causes all calls to clearGlobalErrorMsg() to be ignored.
static void	setGlobalWarningMessage(java.lang.String message) Deprecated.
static void	setGlobalWarningMessage(java.lang.String format, java.lang.Object... args)
static void	setGlobalWarningMsg(RobotCoreException e, java.lang.String message)
static void	setGlobalWarningMsgSticky(boolean sticky) Causes all calls to clearGlobalWarningMsg() to be ignored.
static void	setMsTimeOffset(double offset)
static void	startMatchLogging(Context context, java.lang.String opModeName, int matchNum)
static void	stopMatchLogging()
static void	unregisterGlobalWarningSource(GlobalWarningSource globalWarningSource) Removes (if present) a source from the list of warning sources contributing to the overall system warning message (if the indicated source is not currently registered, this call has no effect).
static void	v(java.lang.String message)
static void	v(java.lang.String format, java.lang.Object... args)
static void	vv(java.lang.String tag, java.lang.String message)
static void	vv(java.lang.String tag, java.lang.String format, java.lang.Object... args)
static void	vv(java.lang.String tag, java.lang.Throwable throwable, java.lang.String message)
static void	vv(java.lang.String tag, java.lang.Throwable throwable, java.lang.String format, java.lang.Object... args)
static void	w(java.lang.String message)
static void	w(java.lang.String format, java.lang.Object... args)
protected static void	writeLogcatToDisk(Context context, int kbFileSize)
static void	ww(java.lang.String tag, java.lang.String message)
static void	ww(java.lang.String tag, java.lang.String format, java.lang.Object... args)
static void	ww(java.lang.String tag, java.lang.Throwable throwable, java.lang.String message)
static void	ww(java.lang.String tag, java.lang.Throwable throwable, java.lang.String format, java.lang.Object... args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPMODE_START_TAG

public static final java.lang.String OPMODE_START_TAG

See Also:

Constant Field Values

OPMODE_STOP_TAG

public static final java.lang.String OPMODE_STOP_TAG

See Also:

Constant Field Values

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Method Detail

processTimeSynch

public static void processTimeSynch(long t0,
                                    long t1,
                                    long t2,
                                    long t3)

Processes the reception of a set of NTP timestamps between this device (t0 and t3) and a remote device (t1 and t2) with whom it is trying to synchronize time. Our current implementation is very, very crude: we just calculate the instantaneous offset, and remember. But that's probably good enough for trying to coordinate timestamps in logs.

setMsTimeOffset

public static void setMsTimeOffset(double offset)

getRemoteTime

public static long getRemoteTime()

getRemoteTime

public static long getRemoteTime(long localTime)

getLocalTime

public static long getLocalTime(long remoteTime)

a

public static void a(java.lang.String format,
                     java.lang.Object... args)

a

public static void a(java.lang.String message)

aa

public static void aa(java.lang.String tag,
                      java.lang.String format,
                      java.lang.Object... args)

aa

public static void aa(java.lang.String tag,
                      java.lang.String message)

aa

public static void aa(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String format,
                      java.lang.Object... args)

aa

public static void aa(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String message)

v

public static void v(java.lang.String format,
                     java.lang.Object... args)

v

public static void v(java.lang.String message)

vv

public static void vv(java.lang.String tag,
                      java.lang.String format,
                      java.lang.Object... args)

vv

public static void vv(java.lang.String tag,
                      java.lang.String message)

vv

public static void vv(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String format,
                      java.lang.Object... args)

vv

public static void vv(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String message)

d

public static void d(java.lang.String format,
                     java.lang.Object... args)

d

public static void d(java.lang.String message)

dd

public static void dd(java.lang.String tag,
                      java.lang.String format,
                      java.lang.Object... args)

dd

public static void dd(java.lang.String tag,
                      java.lang.String message)

dd

public static void dd(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String format,
                      java.lang.Object... args)

dd

public static void dd(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String message)

i

public static void i(java.lang.String format,
                     java.lang.Object... args)

i

public static void i(java.lang.String message)

ii

public static void ii(java.lang.String tag,
                      java.lang.String format,
                      java.lang.Object... args)

ii

public static void ii(java.lang.String tag,
                      java.lang.String message)

ii

public static void ii(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String format,
                      java.lang.Object... args)

ii

public static void ii(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String message)

w

public static void w(java.lang.String format,
                     java.lang.Object... args)

w

public static void w(java.lang.String message)

ww

public static void ww(java.lang.String tag,
                      java.lang.String format,
                      java.lang.Object... args)

ww

public static void ww(java.lang.String tag,
                      java.lang.String message)

ww

public static void ww(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String format,
                      java.lang.Object... args)

ww

public static void ww(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String message)

e

public static void e(java.lang.String format,
                     java.lang.Object... args)

e

public static void e(java.lang.String message)

ee

public static void ee(java.lang.String tag,
                      java.lang.String format,
                      java.lang.Object... args)

ee

public static void ee(java.lang.String tag,
                      java.lang.String message)

ee

public static void ee(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String format,
                      java.lang.Object... args)

ee

public static void ee(java.lang.String tag,
                      java.lang.Throwable throwable,
                      java.lang.String message)

internalLog

public static void internalLog(int priority,
                               java.lang.String tag,
                               java.lang.String message)

internalLog

public static void internalLog(int priority,
                               java.lang.String tag,
                               java.lang.Throwable throwable,
                               java.lang.String message)

logExceptionHeader

public static void logExceptionHeader(java.lang.Exception e,
                                      java.lang.String format,
                                      java.lang.Object... args)

logExceptionHeader

public static void logExceptionHeader(java.lang.String tag,
                                      java.lang.Exception e,
                                      java.lang.String format,
                                      java.lang.Object... args)

logStacktrace

@Deprecated
public static void logStacktrace(java.lang.Throwable e)

Deprecated. obsolete capitalization

logStackTrace

public static void logStackTrace(java.lang.Throwable e)

logStackTrace

public static void logStackTrace(java.lang.Thread thread,
                                 java.lang.String format,
                                 java.lang.Object... args)

logStackTrace

public static void logStackTrace(java.lang.Thread thread,
                                 java.lang.StackTraceElement[] stackTrace)

logStackTrace

public static void logStackTrace(java.lang.String tag,
                                 java.lang.Throwable e)

logAndThrow

public static void logAndThrow(java.lang.String errMsg)
                        throws RobotCoreException

Throws:

RobotCoreException

setGlobalErrorMsg

public static boolean setGlobalErrorMsg(java.lang.String message)

Set a global error message This message stays set until clearGlobalErrorMsg is called. Additional calls to set the global error message will be silently ignored until the current error message is cleared. This is so that if multiple global error messages are raised, the first error message is captured. Presently, the global error is cleared only when the robot is restarted.

Parameters:

message - error message

setGlobalErrorMsg

public static void setGlobalErrorMsg(java.lang.String format,
                                     java.lang.Object... args)

setGlobalWarningMessage

@Deprecated
public static void setGlobalWarningMessage(java.lang.String message)

Deprecated.

Adds a global warning message. This stays set until clearGlobalWarningMsg is called.

Parameters:

message - the warning message to set

addGlobalWarningMessage

public static void addGlobalWarningMessage(java.lang.String msg)

Adds a global warning message. This stays set until clearGlobalWarningMsg is called.

Parameters:

msg - the warning message to set

setGlobalWarningMessage

public static void setGlobalWarningMessage(java.lang.String format,
                                           java.lang.Object... args)

registerGlobalWarningSource

public static void registerGlobalWarningSource(GlobalWarningSource globalWarningSource)

Adds (if not already present) a new source that can contribute the generation of warnings on the robot controller and driver station displays (if the source is already registered, the call has no effect). The source will periodically be polled for its contribution to the overall warning message; if the source has no warning to contribute, it should return an empty string. Note that weak references are used in this registration: the act of adding a global warning source will not of its own accord keep that source from being reclaimed by the system garbage collector.

Parameters:

globalWarningSource - the warning source to add

unregisterGlobalWarningSource

public static void unregisterGlobalWarningSource(GlobalWarningSource globalWarningSource)

Removes (if present) a source from the list of warning sources contributing to the overall system warning message (if the indicated source is not currently registered, this call has no effect). Note that explicit unregistration of a warning source is not required: due to the internal use of weak references, warning sources will be automatically unregistered if they are reclaimed by the garbage collector. However, explicit unregistration may be useful to the source itself so that it will stop being polled for its warning contribution.

Parameters:

globalWarningSource - the source to remove as a global warning source

setGlobalWarningMsg

public static void setGlobalWarningMsg(RobotCoreException e,
                                       java.lang.String message)

setGlobalErrorMsg

public static void setGlobalErrorMsg(RobotCoreException e,
                                     java.lang.String message)

setGlobalErrorMsgAndThrow

public static void setGlobalErrorMsgAndThrow(RobotCoreException e,
                                             java.lang.String message)
                                      throws RobotCoreException

Throws:

RobotCoreException

setGlobalErrorMsg

public static void setGlobalErrorMsg(java.lang.RuntimeException e,
                                     java.lang.String message)

setGlobalErrorMsgAndThrow

public static void setGlobalErrorMsgAndThrow(java.lang.RuntimeException e,
                                             java.lang.String message)
                                      throws RobotCoreException

Throws:

RobotCoreException

getGlobalErrorMsg

public static java.lang.String getGlobalErrorMsg()

Get the current global error message

Returns:

error message

setGlobalErrorMsgSticky

public static void setGlobalErrorMsgSticky(boolean sticky)

Causes all calls to clearGlobalErrorMsg() to be ignored. Use with caution.

Parameters:

sticky - true, ignore clears, false, don't ignore.

getGlobalWarningMessage

public static java.lang.String getGlobalWarningMessage()

Returns the current global warning, or "" if there is none

Returns:

the current global warning

setGlobalWarningMsgSticky

public static void setGlobalWarningMsgSticky(boolean sticky)

Causes all calls to clearGlobalWarningMsg() to be ignored. Use with caution.

Parameters:

sticky - true, ignore clears, false, don't ignore.

combineGlobalWarnings

public static java.lang.String combineGlobalWarnings(java.util.List<java.lang.String> warnings)

Combines possibly multiple warnings together using an appropriate delimiter. If there is no actual warning in effect, then "" is returned.

hasGlobalErrorMsg

public static boolean hasGlobalErrorMsg()

Returns true if a global error message is set

Returns:

true if there is an error message

hasGlobalWarningMsg

public static boolean hasGlobalWarningMsg()

Returns whether a global warning currently exists

Returns:

whether a global warning currently exists

clearGlobalErrorMsg

public static void clearGlobalErrorMsg()

Clears the current global error message.

clearGlobalWarningMsg

public static void clearGlobalWarningMsg()

Clears the current global warning message.

onApplicationStart

public static void onApplicationStart()

Write logcat logs to disk. Log data will continue to be written to disk until cancelWriteLogcatToDisk() is called. onApplicationStart() is idempotent: additional calls to this method will be a NOOP.

writeLogcatToDisk

protected static void writeLogcatToDisk(Context context,
                                        int kbFileSize)

startMatchLogging

public static void startMatchLogging(Context context,
                                     java.lang.String opModeName,
                                     int matchNum)
                              throws RobotCoreException

Throws:

RobotCoreException

stopMatchLogging

public static void stopMatchLogging()

getLogFilename

public static java.lang.String getLogFilename()

getLogFilename

public static java.lang.String getLogFilename(Context context)

pruneMatchLogsIfNecessary

protected static void pruneMatchLogsIfNecessary()

getMatchLogFilename

public static java.lang.String getMatchLogFilename(Context context,
                                                   java.lang.String opModeName,
                                                   int matchNum)

getExtantLogFiles

public static java.util.List<java.io.File> getExtantLogFiles(Context context)

cancelWriteLogcatToDisk

public static void cancelWriteLogcatToDisk()

Cancels any logcat writing to disk that might currently be going on

logBuildConfig

public static void logBuildConfig(java.lang.Class buildConfig)

logDeviceInfo

public static void logDeviceInfo()

getStringStatic

protected static java.lang.String getStringStatic(java.lang.Class clazz,
                                                  java.lang.String name)

getIntStatic

protected static int getIntStatic(java.lang.Class clazz,
                                  java.lang.String name)

logBytes

public static void logBytes(java.lang.String tag,
                            java.lang.String caption,
                            byte[] data,
                            int cb)

logBytes

public static void logBytes(java.lang.String tag,
                            java.lang.String caption,
                            byte[] data,
                            int ibStart,
                            int cb)