From 870289d1d669ee8ee1003677458512c1bc66bc1b Mon Sep 17 00:00:00 2001 From: Miguel Angel Astor Romero Date: Mon, 1 Oct 2018 16:21:25 -0400 Subject: [PATCH] Updated javadocs for the new GH pages style. --- docs/allclasses-frame.html | 22 + docs/allclasses-noframe.html | 22 + docs/constant-values.html | 111 ++++ docs/deprecated-list.html | 111 ++++ docs/help-doc.html | 208 +++++++ docs/index-all.html | 317 +++++++++++ docs/index.html | 71 +++ docs/overview-tree.html | 142 +++++ docs/resources/background.gif | Bin 0 -> 2313 bytes docs/resources/tab.gif | Bin 0 -> 291 bytes docs/resources/titlebar.gif | Bin 0 -> 10701 bytes docs/resources/titlebar_end.gif | Bin 0 -> 849 bytes docs/stylesheet.css | 474 ++++++++++++++++ .../DecodedControlAction.Action.html | 382 +++++++++++++ .../DecodedControlAction.Motor.html | 382 +++++++++++++ .../libnxtarcontrol/DecodedControlAction.html | 380 +++++++++++++ .../libnxtarcontrol/NxtARControlProtocol.html | 508 ++++++++++++++++++ .../libnxtarcontrol/UserActionListener.html | 278 ++++++++++ .../icaro/libnxtarcontrol/package-frame.html | 29 + .../libnxtarcontrol/package-summary.html | 214 ++++++++ .../icaro/libnxtarcontrol/package-tree.html | 138 +++++ 21 files changed, 3789 insertions(+) create mode 100644 docs/allclasses-frame.html create mode 100644 docs/allclasses-noframe.html create mode 100644 docs/constant-values.html create mode 100644 docs/deprecated-list.html create mode 100644 docs/help-doc.html create mode 100644 docs/index-all.html create mode 100644 docs/index.html create mode 100644 docs/overview-tree.html create mode 100644 docs/resources/background.gif create mode 100644 docs/resources/tab.gif create mode 100644 docs/resources/titlebar.gif create mode 100644 docs/resources/titlebar_end.gif create mode 100644 docs/stylesheet.css create mode 100644 docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html create mode 100644 docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html create mode 100644 docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html create mode 100644 docs/ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html create mode 100644 docs/ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html create mode 100644 docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-frame.html create mode 100644 docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html create mode 100644 docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-tree.html diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html new file mode 100644 index 0000000..8d66533 --- /dev/null +++ b/docs/allclasses-frame.html @@ -0,0 +1,22 @@ + + + + + +All Classes + + + + +

All Classes

+
+ +
+ + diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html new file mode 100644 index 0000000..4b634b1 --- /dev/null +++ b/docs/allclasses-noframe.html @@ -0,0 +1,22 @@ + + + + + +All Classes + + + + +

All Classes

+
+ +
+ + diff --git a/docs/constant-values.html b/docs/constant-values.html new file mode 100644 index 0000000..3fc8cd4 --- /dev/null +++ b/docs/constant-values.html @@ -0,0 +1,111 @@ + + + + + +Constant Field Values + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html new file mode 100644 index 0000000..652ccfe --- /dev/null +++ b/docs/deprecated-list.html @@ -0,0 +1,111 @@ + + + + + +Deprecated List + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/help-doc.html b/docs/help-doc.html new file mode 100644 index 0000000..aa452b9 --- /dev/null +++ b/docs/help-doc.html @@ -0,0 +1,208 @@ + + + + + +API Help + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/index-all.html b/docs/index-all.html new file mode 100644 index 0000000..8dd2326 --- /dev/null +++ b/docs/index-all.html @@ -0,0 +1,317 @@ + + + + + +Index + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
A D E M N O R S U V W  + + +

A

+
+
action - Variable in class ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction
+
 
+
+ + + +

D

+
+
DecodedControlAction - Class in ve.ucv.ciens.icaro.libnxtarcontrol
+
+
An immutable and pure data class that represents an action decoded from a protocol + data message.
+
+
DecodedControlAction() - Constructor for class ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction
+
+
Create a new ControlAction object using DecodedControlAction#STOP as + the default action, DecodedControlAction#MOTOR_ABC as motor flag, and + 0 as default speed.
+
+
DecodedControlAction(DecodedControlAction.Action) - Constructor for class ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction
+
+
Create a new ControlAction object using the specified action.
+
+
DecodedControlAction(DecodedControlAction.Action, DecodedControlAction.Motor) - Constructor for class ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction
+
+
Create a new ControlAction object using the specified action and motor flag.
+
+
DecodedControlAction(DecodedControlAction.Action, DecodedControlAction.Motor, int) - Constructor for class ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction
+
+
Create a new ControlAction object using the specified action, motor flag and speed.
+
+
DecodedControlAction.Action - Enum in ve.ucv.ciens.icaro.libnxtarcontrol
+
+
All recognized actions.
+
+
DecodedControlAction.Motor - Enum in ve.ucv.ciens.icaro.libnxtarcontrol
+
+
All motor ports and possible combinations without repetitions.
+
+
decodeMessage(byte[]) - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Decodes a protocol message encoded as a byte array of two elements as specified + in the package definition.
+
+
+ + + +

E

+
+
encodeControlAction(DecodedControlAction) - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Encodes a given DecodedControlAction into a two byte array.
+
+
executeControlAction(DecodedControlAction) - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Executes an already decoded DecodedControlAction, calling the user operation + listeners if needed.
+
+
+ + + +

M

+
+
motor - Variable in class ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction
+
 
+
+ + + +

N

+
+
NxtARControlProtocol - Class in ve.ucv.ciens.icaro.libnxtarcontrol
+
+
A wrapper around the NxtAR robot control protocol for the LejOS operating system.
+
+
NxtARControlProtocol(DataInputStream, DataOutputStream) - Constructor for class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Create a new ARControl object.
+
+
+ + + +

O

+
+
onListenerRegistered() - Method in interface ve.ucv.ciens.icaro.libnxtarcontrol.UserActionListener
+
+
Executes a set of instructions just after the listener has been registered with an NxtARControlProtocol instance.
+
+
onListenerRemoved() - Method in interface ve.ucv.ciens.icaro.libnxtarcontrol.UserActionListener
+
+
Executes a set of instructions just after the listener has been removed from an NxtARControlProtocol instance.
+
+
onUserAction1(DecodedControlAction.Motor, int) - Method in interface ve.ucv.ciens.icaro.libnxtarcontrol.UserActionListener
+
+
Executes a set of instructions when a DecodedControlAction is decoded with DecodedControlAction.Action.USER_1.
+
+
onUserAction2(DecodedControlAction.Motor, int) - Method in interface ve.ucv.ciens.icaro.libnxtarcontrol.UserActionListener
+
+
Executes a set of instructions when a DecodedControlAction is decoded with DecodedControlAction.Action.USER_2.
+
+
onUserAction3(DecodedControlAction.Motor, int) - Method in interface ve.ucv.ciens.icaro.libnxtarcontrol.UserActionListener
+
+
Executes a set of instructions when a DecodedControlAction is decoded with DecodedControlAction.Action.USER_3.
+
+
+ + + +

R

+
+
readAndExecuteMessage() - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Attempts to read, decode and execute a message, calling the user operation + listeners if needed.
+
+
readRawControlMessage() - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Attempts to read a 2-byte message and returns it as is.
+
+
registerUserActionListener(UserActionListener) - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Adds an UserActionListener to this object's listeners list calling it's + onListenerRegistered() method.
+
+
removeUserActionListener(UserActionListener) - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Removes an UserActionListener from this object's listeners list calling it's + onListenerRemoved() method.
+
+
+ + + +

S

+
+
setInputStream(DataInputStream) - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Changes the input stream associated with this ARControl to the input stream passed as + parameter.
+
+
setOutputStream(DataOutputStream) - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Changes the DataOutputStream associated with this ARControl to the output stream passed as + parameter.
+
+
speed - Variable in class ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction
+
 
+
+ + + +

U

+
+
UserActionListener - Interface in ve.ucv.ciens.icaro.libnxtarcontrol
+
+
An object to be notified when an user action has been received in a protocol message.
+
+
+ + + +

V

+
+
valueOf(String) - Static method in enum ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Action
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Action
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction.Motor
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
ve.ucv.ciens.icaro.libnxtarcontrol - package ve.ucv.ciens.icaro.libnxtarcontrol
+
+
This package contains a wrapper library and reference implementation of the NxtAR + robot control protocol for the LejOS operating system.
+
+
+ + + +

W

+
+
writeMessage(DecodedControlAction) - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Encodes and writes a DecodedControlAction into the associated DataOutputStream if any.
+
+
writeRawControlMessage(byte[]) - Method in class ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
+
+
Attempts to write a 2-byte message to the associated DataOutputStream if any.
+
+
+A D E M N O R S U V W 
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..a3ea1ba --- /dev/null +++ b/docs/index.html @@ -0,0 +1,71 @@ + + + + + +Generated Documentation (Untitled) + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html">Non-frame version</a>.</p> + + + diff --git a/docs/overview-tree.html b/docs/overview-tree.html new file mode 100644 index 0000000..8e62336 --- /dev/null +++ b/docs/overview-tree.html @@ -0,0 +1,142 @@ + + + + + +Class Hierarchy + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/resources/background.gif b/docs/resources/background.gif new file mode 100644 index 0000000000000000000000000000000000000000..f471940fde2f39ef8943a6af9569bcf986b1579b GIT binary patch literal 2313 zcmV+k3HJ6!Nk%w1VKM-40OkMy00030|NlK(aXwsfKV5S}VtGJbbVOr%L0@%CZH88Q zl{{NzcR^uxNo<2iYk@pjY)*5FJz8x~bc{)B zfk z+1T6M-s9WdW8dcJ-wO*3@9+W*5AY543-j^$^!EPz_4eHZ2#>)41`h@dc!2OAgN6$a zCS2I?;lqgx6IR4nkpTe;1RN0f=zxMq2O=q`94V5d$&e>Unta)^<;;^G3>e7yp=ZvW z6DIW3xpSvaogXF?_4%`@(V;s}NR^5J!3hrtJV@1QRV&r5S*L!zYE|rss${iFkg&!? zTN5V#)~=bmMorwgZsEpdOE)iExo+FO-8;8Kga{=HbSQCnF=E6W3?o*|ID%uwi5**> zJXy127Y9m+=HQ|PhXWi+xNwoWv}n_%Pq%(e+H~mGqhq5kv4Mo|-n~g|7!F*xZ{xv< zCpXS~dGg^IGK?4@J-T%b(XnUHFul6n<@2&4)zzyO2) z3Q8`i0+UKY*`$}e9mmp;tg*))`|PsK1|hAo%u0K$vDwm4gaSkm0j{`26k#qAKmbuhxZ#cquDR>B zD{s8+&TH-uNg$C#68QG}1HMBHfrP&L@@w$F_!itRzXdCN@V|LDAu%3!IDtq1#1UV7 z#1RxvT=B(DWbCoU5l=ia$Pp`Hgb_?Mp@hmtxZDI2N-)v#$}PXVvdm1d>@v(v`0TUJ zF)Pu89(q`zv=w^nVTIF3@3BYIPA}c`(@ZCAwbNBEt@PDUKe5CTR8aB66IE1!w%Amt zy+jpcn~k>GZpVFg+H6x{_uOksvBlq0OyT$6TyQZ37k(cOxZr|JEx1sGm<(M9gH z-~PMqyn|tT=))UN`|-FFFUA#KToK0fUOaz=7}Z~KeHhVC&%O27cTfHQ^WBU8z4p&T zp#>D|V}XShTD;Hx745Iz{`>K-Z$A|7!*Boo{mY;G21vjH8t{M!OrQc6$iN0V@PQDF zpadsK!3tXNf*8!81~qnXWuHZ)kytd=_y+ADWvw31ouV;CdZ#ya*(l7-A-C-Y^+iit8O zBy3*`Ls$|5Hn4m_^I^|C7{m7EFn|5vTk;|oywIgCc9Bb*=L+Y$)M>9GC<|HGs@6NB zHLY%03!dDf=eDRt2O6lVSFRcsuWZEwU?=z$CZ0W?#VJfdN>HG(l%oKpyiftJc|Y)xkjSJYCrQal-0PC~()T9xwF!Jf zVi1UA#3BBbh(i8r5&v#Pz!cF41KjbCc?4u2@@Q~oKLirt2TM30;y6b+zyX2`Yl9u; z`0$3;v0-YUp&7NdPT#q`cZlbij$jvbRk6R>8g*>}*b9E+WDwmpHAAxYzyT aU_pX{M6b8i>#Dq3onfZy}_nli%!Q$ZV%e&!tN2 zX3B0NWXQ443Eo1rUP86rLU>O>oTp%wt3Z{Tz&P*)Iraq^_@X;RtUFY!JxH|4U!>kw zxXwqo&R3Y=EsXaR!ng@y+y$%L1P3FZ4@N!j3m5MW74HcC->_JFuvlxLXiI=-OQ2|@ zpGc#>2-aN)<1RE9^`bB0`65VSK2>5m>CHs^YZCC)NX*NfbeT1%)Cxpu2_(6cCbLvjLY`hf1%*q}QO*%V4SfOu5Nqg~`-+(-76= za<`RA&(qDB^S!nIS^od5|Nk$KPXD8(qSB!f`M*{E?A^&yOW$08V^iNPK!%UNJ-@xmz>`pG2_%4I3QWk4UdtwP!GH$C%mo2K|$Ap=_)Y!#O($1@ohsUtR1k%wI*) z4*X&g==oWh`j{uP=HFm;Ye>0>UbDdtSp^~MaQ!L9I#)Ga?q}{@T#|qec*FkMLDenm zj^sCgk!^O^3o|vG!~2$$$7`C#4Ry zdQ!tui+J1*HyavK+4{`r+zvYHj9IsRt~@uEBOreWS8~2rXAR3!|7aTdr+x4|>@$Az z)b1t$gSB~6USxpfLmy^|_J_eNt*PI=ScO1SVH895N#`ef%IOh&o-2GIjK1s-JzkyZ z@r7O%hChz}kMHCM@Wqi^R-9t&%Fh^#9dVB0%ej@$=OjXA%XZdzCXf}c>SW26_z-Te z5b{}XWg&rELM=N*%aimp)k04t2c+`WAS>ZFIPWKvtyOI))HzpRA!T!b{tv?4NzF1v zNlP%#{&p@lFFEKvcroMAsI)mq?&`!e%l+-y&j9ZqhN}oG&dB=Pw09r+Q%m0cMujS# zs$a7!9VH`CC7k{!bV(J`rm%Jpj6&nLtWhPcy$onn$8G#ZdD9hxO<9k67Ya>K_7W~3 z&KYf14fq<{qHA7u6;>AOcomhdg?ianjr9uINt}*7w?g%z9{Q`(qRo@hDwSpGmxz&h&>%G%T(URL~=c>C{>y$K?+wLFp zy*M1@FTUKYV>8DeDIAIKM+!T5c-k&C4?Y~y^E zQCIc-=9~DiPtfVZB=_c3`qH3h|NXd^BcOQG`funSe)i5!NoA_r{b6PwzSDIXG+!(F z9CqJgo&~#7^VZHWj{u23q+NDCHn}GeWDC*(SW%{f4WMtP3l2jsO7*M)EX)#NLlsNnU4q@#jn0r#rsWsf^ngE0&ambG1f;Rj zfOk#_>1|25Z%?iI{0Yv8)DQfk>m1td?~}m0N%^k^u%EuUCc#ItmlY|epQ3YLWehYw zRU0qpPb#X&WU*UOU8et(s8x~WyYWYsgJCF+;U6@*nICY8)dk}IG+(#_Bz8zURd3HZ6qPE68U1%S{wL0 z;K{PDw2iRFIGG?(UiE9kT9?siuv4O{ z`dX2-eiXU3N)H2nT4V=AO^~J}sw+gr{&~qx%$$wlMv_JCWAMfcjYl}*Cfcf!adOY8 z8oLmJ{%49e+nLiVo#H9}wRk?UCzDz^>9TDxreVHzl~R*)?YU>Uu;J2eQ27O5`&X^8 z`94{)YWJQa#l0Fbz0N6B>j&8J;<%VuG6OYM9&QIdtueWjI3X;*dEtGiF@1AcvN4U> zG5SXIEXxB>)!mtQOztJLyeF78S*kLiU-!>PtQ_s~OMl~&y(hVVe$A5 zwo}E-DJ6${QP75?LsQ}Wl@MXwXMT4d>|?rD!g?jE>J^N*y;X}5FLe%d0_ zZ>eIBK6l@jkfw{p_YiDP;MS{jww{%j#?rk2z1J!HqE;Vd!TrCl_7UPef8;edI}wD6 zT&12Bxj&q}d4%$GHq+$~UYtWv`wI9k`89oKkCEK_E;-+O)(rhThjOM|kXDn{!W1Lo z`_?yQv=lp=-w()R<=0&c5%RWHY_fw@qb}uwFuPAGkl~@Kis}eE%MY@~6ZyWcF+llM zGyK`)(vn1F%%z=W7-Y=1$`w0Mv+-|#d};%JjCmw)Y1hOxwA|{}P%6LS4X`jQCGh`mR@=hGrr|cXa^Ipj;Mh)6mTqd1s_HmP0IxXT!w7YhoIHT>Hm#!;c@|L9OjV zsTlHE{Z;HWeM9^tPm-`|&nnl$%DRtNG1~?npUvgKPwKlaccEe4q!7YU3zykJnu6Sr z()LMXs_)^~u-ds7+wMff)RAJF?2?1H`_wDnt%MssYeB5;q~ojgVm6OHA6B>FG2erv z8&`|6<`=!EPKR^8Qlp5MiKwfxy4D`mN> ze$RKh_6*YJd4y0nnUZvwN%iY&^9xk@cM|5g#pZkc#N*(PH?^w&?ilTDMXFcd0`5!E zvgHS`=Lc|~1aO=L@L~eE*aP{90lc7qXY7GOs)3JH14T{(`K1D%tpvUT1-?F^1d4_S zJ#7yXkP3Q37bJlRQfv=mV-J3B8O*m5B%L3uW)S>|Jwy`|s6iK`sv0Z-3NcU(0knrG z5ChFXA@A9PUSdLI+(VU!!J1Mbw!~0VP^jZci2X|Nx0BF!24ObrAr>b=QtlyN4TAhn z!mQncJm~^m4MIafVLt_ewDUtO+e5w*!`(6A&H^F7i9s4t5&uBpNvh$nlTZjqTM5krNRRQ zqP)VR!|9@H>7qN_!+-)&_9s!^;gOvy5s~iEB&qP8{77&2NJMzZcsnJgSt_bYDzYU% zxQ#uuk3D*e7_*d5^?HW(^(WxICGf-mcmM((VStzIz%zFsm0;ZI3h=5OciJ#a%7I(IeGbFv+PP^?^sKBPrRBl<+qK^o%3fi=L9`la>-l4~p|hzAl~W zf=%(|NHgF7r5dJD+Cf08q-c(m;Epsldaz4cqHzTHT>)4xEe(cE0i~tf{Y0xs_1~Kv z+BYQ-TpEOch13;5YC9nHYEXhSv{ew=LV~nQL%UBQEgaDL2m?9u~v zEQmOvM=aB)Z$+eE38rs%AZR_)4>@2raqwH#Fji#xoLc&PS_TU^W8W(M0GqLdO~1yF z{sfHZ_sC#FX58(}d>RSkKZCz8%D7{cC3Z$Zh@52{31&V*W-@s~Z<8~aBeNcNW?e&O zsR(7fHOf}B&fsRqdZ(WK1e~s*o^uD6{YX9QJvqyWAqQXt*E>r$V94YK=X@8+{1cg> z*_i`a%alCJvbD~lCg&Q1Gk=|BzY)sejf9EHJ{s7lu4?ExCWR3jgTiET;exy{sW!Mg zuj*_YOf0@ScN~X0$7V6&KpL172rf|rA8?K<2+GelXw)NUk#@b4aT5MO%1ip4*ym}B-JI__S1R?CK z<4eW~bH;@H@tR55x}&JNSw_NvEPk)6E>XDt7*)4sgWuw+_vNZzmaS(tsi(57zcjA9 z@~XcHtzYq~IX|z*Md9mh>W~`sk3<^s7;EmyH4wcTdAo5NkUA2ofeG69{Gx7#i_*lt zQ7;N@xEo#nNRj&SbDHNnP0w#OE0{DZ$~7ySG%IN~zwd5Vu4&dnH>*OMb>&*VL^tbA zG;7y1t9dsYU$p3pw0x6mwGe6fjBYWsZ8e3q8f~-~cefgHxBangajI$kv(c*W-DZGp zbM$UgnP{_MYPXYX|6$u^deIhE(-xuGX2RVXqS+o~(iSV%;ZW1=Zqkut(r&xak^pT> zsp*I@X|-eOd^gb+sM(%3(E$|c47Y91mTU99Xe;4vFOTl5gmwVB+fvc3n2pwK?~Xd# zwrY{?CUj@~Msr?wXU0WKv2A$hq z`$V^gNq4(<*C=;4e4}$*uIC$5&uUHkM08J~N$>VV*VpdmLCuc!?!J9=-)VH;fo9)| zNN4m#^Kb9|`RF!^ZAT-z=bC8$do8~Tjc^o-aQjyc2(TW*d50E1#NW0pKb^~tf&OUlS+W}>0!m@!~1 z&TdSLhm`0u99c-z=oxYL8IFaGCDoFwFUP!1iJ%xF1UC4hhv*VR2451Pc0+kQGC)39C5 za81oV=$+xzZNYhn=RB-CTZ>Bevj)A3mi9|OS(dcy=N#Zm=Dza|z4Jd<=3IQ2CB>FiwH7{4Ej#+oa>M67 z!56)Km&2xJ|H7B;%~rJDuJ{rbZQiaX*e^$DEt~T$#h9(y#jg6>uX?boq!N}Q;EQth zYo1rjc15dETPw~*Ymu=lreoE9g^wb)ZcRe1yp1(Eo(rmqUYZXOU$BC_| zX{{&qE?E06wXm#v#cpKwE)jaydSaI`TkCCClr_lKMzPkyFT!R%VRn&sZSrchKx&4e~pJQcfViQxxl=T=7}#gYz7Pvoh`T#Jbab%2A2m zxh?A<`}A?8_GumBEcL;$x%gQb@PZ(If%ZE~D?ax#Km4a~+GV~!;Bb~qxxh@HHc|H6 zr%$^c9Dw~UQFWJv+81rCXS1vqqLfQ~-BtO63xCArGVA4T-}xPXYGHqB5h^+n5%$24 z(BROpi13J@*qFfR$oRMHel`=(zy zovs-UKHD3VkJ?hVeq!aA+8Fh4+NIlFhcC~UrR{4I#}K*u&z%68+P1*=q0B1r*2MY> z!9gYs*vlTO5v#8S>c#3goFmp>3iVKdU)NkjNV(s7tO4Wq?2M}o5Cj-*7;S=fEshOA zR*4$dm{ROvUamG%xL_tSW6}U$Nl=@91T;nC11o-iIVyVrfkd) zTCp;^tOy|_kuOFV$Nn=$AQJO9;&sZ&eDs^!r*m;Hw!)vpO1vcfj2EV{dJ?7ap0tq6 z$SwUVM*Vt+MS_`;bas-svPV|3POQi8G~?f^KOx4hg1He+Wd*s3Hl1{TfJS-+zv6vc zPoKiwr?7wECbub(IdB)9f_!kmUjBR*KY_z4E8_QA9xSr#G&@i5y^H`jB^I{|akh>W z%Cn3luOVY|8P>u>e^~#{$kmgX&-q>k{#pFbm2({(rtG<%nb0UCQ0%{Cy`F&~7}*we z@Of>ND_)V&XwN_+n~KjVorUQWZ*B6cld7ymQl{;rwlHl34K#}2YWxE+4CX@P&u6AfCda`&ZT1MOY69e-L@gNcAvwx8%1Z7lB4zc=_Cpt~&s ze%?;){1DB(PSK!^za967qF?lIjB~&06}Lf`cgh2qUiI^|$-VCTNE=hp&Ij}^A9&|* zQQrSqo3gn#_=z9j(y6f@T|OkJYv(fjwpz}$*U$|nLH2F zPNMuTS4g8 z*^hOlRh6~Mk}58;d477R>F^~aLO$dOXmhA*6zwIaHK()t2zKjo?j^NOJbh_=+71xg zO{Mgp7x?Z-1MKzoQ<+V2g#|e}|JawOPJZBL{o~PYdtWDX?jl##!Aiq|w>)vGJLipp zBK1xGhcvgSsQ;rn>+`>UmxlID{<~}7{y>SO^cyktN^Fsz!Z|B4?p*RKQG*8}SYBt{ zuFO{vJ?jgL{gUzYsnv(io}c0vlCp#*1vE?}KL^UZ&VF^TK+D;40CxX%j);%dCt;Z{ zAeMXC9JPWvKGwsCxx4w2iv_wNGG8l16AVI93rmc^c1>r(P||YE zpXa+=-&k995hfykL^J5S&vJF^ljR&`FE#ppNMM3%Omc!F)Mn{{&Ip#)JegbEJxud2 zn`wDVB~DMii5|H%m~51YeU1juNG3!+&?*uC#q@)z8q~`4yEL5I8}PtyA1IZ=52P$x zX)KhZt z7czUXBsy-8d`GVQ`90`wIh(Xt7v5j7h0t&ET~2M!Tb~4rN-xtK@8@mB*c(6QTwOS- z%9445_WY|cfm4?$nX$72&{~^mu}an^x^Da%=UU6YI;ur3+9L6I>raW5!=-Nzy(F2Z zwZlg7aM3NN5b{K|FB>s4R}|&Lr32_Ys{wwkECxo|rV@;5aHB25iUs7(6@dDpjN{Y%?C~UGp>*Q}K?)KKk64 zAn;@-dER}QG0L${jQ1cR75eM3-~ZTltTQ8%sm9x4Y`ve@ekMuvpA#Rh51@s6;6^&Q z!&M7^b%cea7FlZkPV9}@!bPBBfB&~XvGlE2T7V?IpM~OBmuK;OSt{~N`rL5c_I^de z9n*=@p|l;d`b_YIn8Aem1t7pp0=2-MCTIcJHlY z6x+mNLgi{JpwP)y(yzAFL2A#>bI&EwZE`PGvd*FQ!rx~6bUN&+Ij3)L;=595L#G;m8*^e?ap1`J5w7-q)*iUT_W9w8 z&xS-`i++HpWzY-a-)CWd0(pLW$A85P{Dy9r-=uPekNpN^yA}pJ7yWTZ>3iw4d6+IK zF%1XXkGcJm{0*vhSG5R1ySW;jctk9O==1-Mk?=Bl<{HE1p_@tx1s^+GoczYxj#B=i=kwQvEPrOt`<4W*pJw zbNjEqpr7B|Llc%m{V*QssV)im;pb00LUob=yFaU4`P_}ywU zt*QZl-bUsmh@L&zQaX4uHL&7YD(BOb9hH;;y;O-b-_O$4EFi1vCrMlz`dN|u?}HNO^aFQV{UZg_yy%nf>IXpulip!cR8|vNu7P*; zQye@}Qmj%(TB6`5E=c~w=LITF266XJ6X5xA7!OM1SE=~N*o3EP5Qqx!W<_+EMSLGo zqkC18AQ=0AK9=hgGQtrTovYc5^?Z^RLX?hlO-j&e1MXTTbfm>MS^=}!p>C>icUKdZ zBcNOb(6IJ!kq*e7N8Fx!!kPyn+2B2^2hd00+W^PUA&+S63jFE)bP5Tv+L5l~n(pu? zbeO|+K{{?pEow3?j0+dGVu)a6(0r{1Uj7{3 zxSsZ|BdMk>1-S}-;+`pk{Q5>H=tLRx+YqeenaSRsEX@gtPzz>j1A9g!C9kGtspY(- z%YL>NkVDE2z@}*;Q{=&5)yS;NupAmmibGUE4qte7aY6PcnXJgw>}ad(SW;@HtNurF ziV0_yHz=;Di%Tki6DW^tjkL`t%Ktct(ay zvuAOYoCu!Pm~@P5CIjk$bp`_iv{^l*Au{fB8mJK1>Macv?GL)**8*+JNvySIH5Y7i#1;!%NT!efc z;Z0*AOM&1VpR+6wIQxBM{xf`8T1V@#e<#QL}=YRwMkWG8%1(Fgj{iX)N zup{Txko(DqJWf=#Oi?Z!nra-?C{);TP`w|4>L+EKx1&P3swX<*#_50F!lD_$nQyuK??!UwA-{y)^QmMxoK1xIJ~uML{u;5!Z5tQyEL>;KaUd!_9FP zl2$QOI6V1`QdF|8gkdZsSpUqCjSBu(1H)r*vL#PEy)@Px>5TIk7_9o#Bj zzD&<1_k(ejk%qO6ak=GMmG5b7LTAA^KKq-Ey#z8(2wy2;Ot^oZI(MG@)~iY$RAnJt zu`ioyvR?Vws_tuK9hDqmel+)bP0kyxJV{7t=&3{b(@Hs1fs$9n45aq)IKknZa2H*7 z^P-ZDyOMdMj&-9{(-?dqo5I3Gy=K$!L%q>3^0N~o^2i0^_@^2nQv>S4B&=5_8^a^V zaY!NjyA5QgO&r#^CJcp&=!))MZ*CC&hvLEzWU*!IO=aYo{_yG+53H$XOAIQWnG`uD zLuuwTY6e8N^m5^AHQa}Y5Z#SdbEY;+x{oW?g;ie4CNYomRyQd2mv^L}T!>a5<*wTh>@>Qtwp~nejn`~DcZJI+QC-xU zoxz=5z0k%1;jBrGI%Th~FQElrAPr?E-Fv9|o09dPk=?>f)jFKL8PK|;w(cVDq>YWP zEfL7RGBv|<>f4IccND3wCi*V8`>#a$FPZu&a{V`W`me+Kuf_CJ)%IV%?5ByL^#3Q{ z&uBM5|34IKI>0_Tz{5OngXe#6w*N6;;5PH%9n%56%RaWA{wJ4%515Apdj`a62bp<> zM12OuV+QZ^55ATkViO(UWgg}%9C}kb^r~=BiDyWIXZWM&kb>Q?dd$#W`4KU|2#4qh zz;sZ>ZqS5h#Kdk$&1c9AHmDUdtmHE)CqH0RIAZEE;t(^+RXF+*FlJyk;?6Vn{&MsO zZ0HwY)b4Va!F1#s^N5$-s9(&mPa*Lu4>4SxXm~l|3?PR2jB1J!Q|(4#0i$lFME^-r zA~Q(2O+PHOdcVN((R8zqi>%+yx4PA5u&+jI zZ?)Fm8m-+`n!Bnrx0PvZE7!Q)Z+NTE@K(R!nO40sZF(n~bq_b_9H`UYU#q>pPJ3UC z_UeU>J7qcy%%`ks9)BNcS^GDOn z?oKkjHNoWO1e2?M#vd12e^_AscAnLnc~-CISiYWX`D%{k^H~<37unpMYJYdSv=Om2vbAM@`Qp{{SI=yP zj6WN*eEt0G$9EPX6FU%)-ho>hWTW!yzXBIo73<0umM-=@eG&niY^` zlG(|vuCl_x(X^Fob@=i{8+M5vWf7Bz=#aHGTNA;fZQyfbfueI8Z^639n`(DI%w^-^ zl`=@!u)r~Xf920-xd$Ab+S&PJY%K0H8a_J8uN3^_!K1_NV$*e#*Y*6|)XpiW=9H`*`Xx7W%v@7{XDma1?v0a%(K6rI&1!a YpWXKgmku8Vj|K)Vje`mzEKCg608Q#dYybcN literal 0 HcmV?d00001 diff --git a/docs/stylesheet.css b/docs/stylesheet.css new file mode 100644 index 0000000..0aeaa97 --- /dev/null +++ b/docs/stylesheet.css @@ -0,0 +1,474 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ +body { + background-color:#ffffff; + color:#353833; + font-family:Arial, Helvetica, sans-serif; + font-size:76%; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4c6b87; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4c6b87; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-size:1.3em; +} +h1 { + font-size:1.8em; +} +h2 { + font-size:1.5em; +} +h3 { + font-size:1.4em; +} +h4 { + font-size:1.3em; +} +h5 { + font-size:1.2em; +} +h6 { + font-size:1.1em; +} +ul { + list-style-type:disc; +} +code, tt { + font-size:1.2em; +} +dt code { + font-size:1.2em; +} +table tr td dt code { + font-size:1.2em; + vertical-align:top; +} +sup { + font-size:.6em; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:.8em; + z-index:200; + margin-top:-7px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + background-image:url(resources/titlebar.gif); + background-position:left top; + background-repeat:no-repeat; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:1em; + margin:0; +} +.topNav { + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; +} +.bottomNav { + margin-top:10px; + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; +} +.subNav { + background-color:#dee3e9; + border-bottom:1px solid #9eadc0; + float:left; + width:100%; + overflow:hidden; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding:3px 6px; +} +ul.subNavList li{ + list-style:none; + float:left; + font-size:90%; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; +} +.navBarCell1Rev { + background-image:url(resources/tab.gif); + background-color:#a88834; + color:#FFFFFF; + margin: auto 5px; + border:1px solid #c9aa44; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader h1 { + font-size:1.3em; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 25px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:1.2em; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + margin:0 0 6px -8px; + padding:2px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + margin:0 0 6px -8px; + padding:2px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:1.0em; +} +.indexContainer h2 { + font-size:1.1em; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:1.1em; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:10px 0 10px 20px; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:25px; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #9eadc0; + background-color:#f9f9f9; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:1px solid #9eadc0; + border-top:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; + border-bottom:1px solid #9eadc0; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.contentContainer table, .classUseContainer table, .constantValuesContainer table { + border-bottom:1px solid #9eadc0; + width:100%; +} +.contentContainer ul li table, .classUseContainer ul li table, .constantValuesContainer ul li table { + width:100%; +} +.contentContainer .description table, .contentContainer .details table { + border-bottom:none; +} +.contentContainer ul li table th.colOne, .contentContainer ul li table th.colFirst, .contentContainer ul li table th.colLast, .classUseContainer ul li table th, .constantValuesContainer ul li table th, .contentContainer ul li table td.colOne, .contentContainer ul li table td.colFirst, .contentContainer ul li table td.colLast, .classUseContainer ul li table td, .constantValuesContainer ul li table td{ + vertical-align:top; + padding-right:20px; +} +.contentContainer ul li table th.colLast, .classUseContainer ul li table th.colLast,.constantValuesContainer ul li table th.colLast, +.contentContainer ul li table td.colLast, .classUseContainer ul li table td.colLast,.constantValuesContainer ul li table td.colLast, +.contentContainer ul li table th.colOne, .classUseContainer ul li table th.colOne, +.contentContainer ul li table td.colOne, .classUseContainer ul li table td.colOne { + padding-right:3px; +} +.overviewSummary caption, .packageSummary caption, .contentContainer ul.blockList li.blockList caption, .summary caption, .classUseContainer caption, .constantValuesContainer caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#FFFFFF; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + margin:0px; +} +caption a:link, caption a:hover, caption a:active, caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .packageSummary caption span, .contentContainer ul.blockList li.blockList caption span, .summary caption span, .classUseContainer caption span, .constantValuesContainer caption span { + white-space:nowrap; + padding-top:8px; + padding-left:8px; + display:block; + float:left; + background-image:url(resources/titlebar.gif); + height:18px; +} +.overviewSummary .tabEnd, .packageSummary .tabEnd, .contentContainer ul.blockList li.blockList .tabEnd, .summary .tabEnd, .classUseContainer .tabEnd, .constantValuesContainer .tabEnd { + width:10px; + background-image:url(resources/titlebar_end.gif); + background-repeat:no-repeat; + background-position:top right; + position:relative; + float:left; +} +ul.blockList ul.blockList li.blockList table { + margin:0 0 12px 0px; + width:100%; +} +.tableSubHeadingColor { + background-color: #EEEEFF; +} +.altColor { + background-color:#eeeeef; +} +.rowColor { + background-color:#ffffff; +} +.overviewSummary td, .packageSummary td, .contentContainer ul.blockList li.blockList td, .summary td, .classUseContainer td, .constantValuesContainer td { + text-align:left; + padding:3px 3px 3px 7px; +} +th.colFirst, th.colLast, th.colOne, .constantValuesContainer th { + background:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + text-align:left; + padding:3px 3px 3px 7px; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +td.colFirst, th.colFirst { + border-left:1px solid #9eadc0; + white-space:nowrap; +} +td.colLast, th.colLast { + border-right:1px solid #9eadc0; +} +td.colOne, th.colOne { + border-right:1px solid #9eadc0; + border-left:1px solid #9eadc0; +} +table.overviewSummary { + padding:0px; + margin-left:0px; +} +table.overviewSummary td.colFirst, table.overviewSummary th.colFirst, +table.overviewSummary td.colOne, table.overviewSummary th.colOne { + width:25%; + vertical-align:middle; +} +table.packageSummary td.colFirst, table.overviewSummary th.colFirst { + width:25%; + vertical-align:middle; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:.9em; +} +.block { + display:block; + margin:3px 0 0 0; +} +.strong { + font-weight:bold; +} diff --git a/docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html new file mode 100644 index 0000000..ac34ebe --- /dev/null +++ b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Action.html @@ -0,0 +1,382 @@ + + + + + +DecodedControlAction.Action + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
ve.ucv.ciens.icaro.libnxtarcontrol
+

Enum DecodedControlAction.Action

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static DecodedControlAction.ActionvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static DecodedControlAction.Action[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static DecodedControlAction.Action[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (DecodedControlAction.Action c : DecodedControlAction.Action.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static DecodedControlAction.Action valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html new file mode 100644 index 0000000..c077135 --- /dev/null +++ b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.Motor.html @@ -0,0 +1,382 @@ + + + + + +DecodedControlAction.Motor + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
ve.ucv.ciens.icaro.libnxtarcontrol
+

Enum DecodedControlAction.Motor

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static DecodedControlAction.MotorvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static DecodedControlAction.Motor[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static DecodedControlAction.Motor[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (DecodedControlAction.Motor c : DecodedControlAction.Motor.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static DecodedControlAction.Motor valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html new file mode 100644 index 0000000..fc8f34d --- /dev/null +++ b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/DecodedControlAction.html @@ -0,0 +1,380 @@ + + + + + +DecodedControlAction + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
ve.ucv.ciens.icaro.libnxtarcontrol
+

Class DecodedControlAction

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • ve.ucv.ciens.icaro.libnxtarcontrol.DecodedControlAction
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class DecodedControlAction
+extends java.lang.Object
    +

    An immutable and pure data class that represents an action decoded from a protocol + data message.

    +
    Since:
    +
    December 15, 2014
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DecodedControlAction

        +
        public DecodedControlAction()
        +

        Create a new ControlAction object using DecodedControlAction#STOP as + the default action, DecodedControlAction#MOTOR_ABC as motor flag, and + 0 as default speed.

        +
        • +
      + + + +
        +
      • +

        DecodedControlAction

        +
        public DecodedControlAction(DecodedControlAction.Action action)
        +

        Create a new ControlAction object using the specified action. The motor + flag is set to DecodedControlAction#MOTOR_ABC and the speed is set to 100.

        +
        Parameters:
        action - The action flag to set.
        +
        • +
      + + + +
        +
      • +

        DecodedControlAction

        +
        public DecodedControlAction(DecodedControlAction.Action action,
+                    DecodedControlAction.Motor motor)
        +

        Create a new ControlAction object using the specified action and motor flag. The + speed is set to 100.

        +
        Parameters:
        action - The action flag to set.
        motor - The motor flag to set.
        +
        • +
      + + + +
        +
      • +

        DecodedControlAction

        +
        public DecodedControlAction(DecodedControlAction.Action action,
+                    DecodedControlAction.Motor motor,
+                    int speed)
        +

        Create a new ControlAction object using the specified action, motor flag and speed.

        +
        Parameters:
        action - The action flag to set.
        motor - The motor flag to set.
        speed - The speed to set. Will be clamped to the range [-100, 100].
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html new file mode 100644 index 0000000..fda2a0f --- /dev/null +++ b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/NxtARControlProtocol.html @@ -0,0 +1,508 @@ + + + + + +NxtARControlProtocol + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
ve.ucv.ciens.icaro.libnxtarcontrol
+

Class NxtARControlProtocol

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • ve.ucv.ciens.icaro.libnxtarcontrol.NxtARControlProtocol
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NxtARControlProtocol

        +
        public NxtARControlProtocol(java.io.DataInputStream inputStream,
+                    java.io.DataOutputStream outputStream)
        +

        Create a new ARControl object.

        +
        Parameters:
        inputStream - A DataInputStream used to read protocol messages from. Can be null.
        outputStream - An DataOutputStream used to write protocol messages to. Can be null.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setOutputStream

        +
        public void setOutputStream(java.io.DataOutputStream outputStream)
+                     throws java.io.IOException
        +

        Changes the DataOutputStream associated with this ARControl to the output stream passed as + parameter. The currently set output stream is flushed and closed before replacing it.

        +
        Parameters:
        outpuStream - An opened output stream. Can be null.
        +
        Throws:
        +
        java.io.IOException - If an error happened while closing the previous output stream.
        +
        • +
      + + + +
        +
      • +

        writeRawControlMessage

        +
        public void writeRawControlMessage(byte[] message)
+                            throws java.io.IOException,
+                                   java.lang.IllegalArgumentException
        +

        Attempts to write a 2-byte message to the associated DataOutputStream if any.

        + +

        Returns immediately if no DataOutputStream has been set with + setOutputStream(DataOutputStream) or if the message is null. If the + message is longer than two bytes only the first two bytes are written to the output stream.

        +
        Throws:
        +
        java.io.IOException - If writing the message fails. It is the same IOException + as thrown by DataOutput.write(byte[], int, int).
        +
        java.lang.IllegalArgumentException - If the message lenght is less than two.
        +
        • +
      + + + +
        +
      • +

        encodeControlAction

        +
        public byte[] encodeControlAction(DecodedControlAction action)
        +

        Encodes a given DecodedControlAction into a two byte array.

        +
        Parameters:
        action - the action to encode.
        +
        Returns:
        The encoded action. Null if said action is null.
        +
        • +
      + + + +
        +
      • +

        writeMessage

        +
        public boolean writeMessage(DecodedControlAction action)
+                     throws java.io.IOException
        +

        Encodes and writes a DecodedControlAction into the associated DataOutputStream if any.

        +
        Parameters:
        action - The action to write.
        +
        Returns:
        True if writing the action succeded. False if either the action or the DataOutputStream are null.
        +
        Throws:
        +
        java.io.IOException - If writing the message fails.
        +
        • +
      + + + +
        +
      • +

        setInputStream

        +
        public void setInputStream(java.io.DataInputStream inputStream)
+                    throws java.io.IOException
        +

        Changes the input stream associated with this ARControl to the input stream passed as + parameter. The currently set input stream is closed before replacing it.

        +
        Parameters:
        inputStream - An opened input stream. Can be null.
        +
        Throws:
        +
        java.io.IOException - If an error happened while closing the previous input stream.
        +
        • +
      + + + +
        +
      • +

        readRawControlMessage

        +
        public byte[] readRawControlMessage()
+                             throws java.io.IOException
        +

        Attempts to read a 2-byte message and returns it as is.

        + +

        Returns null if no DataInputStream has been set with + setInputStream(DataInputStream).

        +
        Returns:
        The two bytes read from the associated connection as an array.
        +
        Throws:
        +
        java.io.IOException - If reading the message fails. It is the same IOException + as thrown by DataInput.readByte().
        +
        • +
      + + + +
        +
      • +

        readAndExecuteMessage

        +
        public boolean readAndExecuteMessage()
+                              throws java.io.IOException
        +

        Attempts to read, decode and execute a message, calling the user operation + listeners if needed.

        +
        Returns:
        True if a message could be read, decoded and executed successfully. False otherwise.
        +
        Throws:
        +
        java.io.IOException - If reading the message fails. It is the same IOException + as thrown by DataInput.readByte() if any.
        +
        • +
      + + + +
        +
      • +

        decodeMessage

        +
        public DecodedControlAction decodeMessage(byte[] message)
+                                   throws java.lang.IllegalArgumentException
        +

        Decodes a protocol message encoded as a byte array of two elements as specified + in the package definition.

        + +

        User actions have precedence over motor recentering and + this in turn has precedence over other movement actions. + User actions have precedence in decreasing order; that is, user action 1 has + precedence over user actions 2 and 3, etc.

        + +

        If the message indicates a movement (forward or backward) with all motors off, + then it is interpreted as a request to stop all motors. A recenter or user action + with all motors off will be decoded as is and must be interpreted by the user.

        +
        Parameters:
        message - A byte array of size two encoding a message recognized by the protocol. If the array + has 3 or more elements then only the first 2 are used during the decoding process.
        +
        Returns:
        A DecodedControlAction instance containing the decoded message.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If the array is null or has less than 2 elements.
        +
        • +
      + + + +
        +
      • +

        executeControlAction

        +
        public boolean executeControlAction(DecodedControlAction controlAction)
+                             throws java.lang.IllegalArgumentException
        +

        Executes an already decoded DecodedControlAction, calling the user operation + listeners if needed.

        +
        Parameters:
        controlAction - The action to execute.
        +
        Returns:
        True if the action could be executed successfully. False otherwise.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If controlAction is null.
        +
        • +
      + + + +
        +
      • +

        registerUserActionListener

        +
        public void registerUserActionListener(UserActionListener listener)
+                                throws java.lang.IllegalArgumentException
        +

        Adds an UserActionListener to this object's listeners list calling it's + UserActionListener.onListenerRegistered() method. Adding a listener that + is already registered does nothing.

        +
        Parameters:
        listener - The listener to add.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If listener is null.
        +
        • +
      + + + +
        +
      • +

        removeUserActionListener

        +
        public void removeUserActionListener(UserActionListener listener)
+                              throws java.lang.IllegalArgumentException
        +

        Removes an UserActionListener from this object's listeners list calling it's + UserActionListener.onListenerRemoved() method. Removing a listener that + is NOT on the list does nothing.

        +
        Parameters:
        listener - The listener to remove.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If listener is null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html new file mode 100644 index 0000000..f976bd5 --- /dev/null +++ b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/UserActionListener.html @@ -0,0 +1,278 @@ + + + + + +UserActionListener + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
ve.ucv.ciens.icaro.libnxtarcontrol
+

Interface UserActionListener

+
+
+
+
    +
  • +
    +
    +
    public interface UserActionListener
    +

    An object to be notified when an user action has been received in a protocol message.

    +
    Since:
    +
    December 16, 2014
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-frame.html b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-frame.html new file mode 100644 index 0000000..cb765da --- /dev/null +++ b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-frame.html @@ -0,0 +1,29 @@ + + + + + +ve.ucv.ciens.icaro.libnxtarcontrol + + + + +

ve.ucv.ciens.icaro.libnxtarcontrol

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html new file mode 100644 index 0000000..63ebc4d --- /dev/null +++ b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-summary.html @@ -0,0 +1,214 @@ + + + + + +ve.ucv.ciens.icaro.libnxtarcontrol + + + + + + + +
+ + + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ +
+

Package ve.ucv.ciens.icaro.libnxtarcontrol

+
+
This package contains a wrapper library and reference implementation of the NxtAR + robot control protocol for the LejOS operating system.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    UserActionListener +
    An object to be notified when an user action has been received in a protocol message.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    DecodedControlAction +
    An immutable and pure data class that represents an action decoded from a protocol + data message.
    +
    NxtARControlProtocol +
    A wrapper around the NxtAR robot control protocol for the LejOS operating system.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    DecodedControlAction.Action +
    All recognized actions.
    +
    DecodedControlAction.Motor +
    All motor ports and possible combinations without repetitions.
    +
    +
    • +
+ + + +

Package ve.ucv.ciens.icaro.libnxtarcontrol Description

+

This package contains a wrapper library and reference implementation of the NxtAR + robot control protocol for the LejOS operating system.

+ +

The protocol is based on 2 byte long data messages that encode a set of motor ports, actions + on those motors and the speed of the motors. The first byte encodes a set actions and motors, while the + second byte contains an integer number representing the speed to set to the enabled motors. The first + byte's bits encode the following data (from least significant to most significant bit):

+ +
    +
  • Motor port A enabled.
    • +
  • Motor port B enabled.
    • +
  • Motor port C enabled.
    • +
  • Direction of movement. 0 for backward movement, 1 for forward movement.
    • +
  • Request to return the enabled motors to their initial positions.
    • +
  • Customizable user action 1.
    • +
  • Customizable user action 2.
    • +
  • Customizable user action 3.
    • +
+ +

This bits are decoded using the binary masks defined in NxtARControlProtocol. + This mechanism allows to set the state or execute an action on multiple motors simultaneously. The user actions are + executed using callback objects registered with the aforementioned class.

+ +

The NxtARControlProtocol class includes methods to + read, decode and execute a protocol message, independently of how those messages are generated. An example + would be messages read from a Bluetooth or USB stream, as well as messages generated by the application + that is using the library.

+
+ +
+ + + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-tree.html b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-tree.html new file mode 100644 index 0000000..2542c2d --- /dev/null +++ b/docs/ve/ucv/ciens/icaro/libnxtarcontrol/package-tree.html @@ -0,0 +1,138 @@ + + + + + +ve.ucv.ciens.icaro.libnxtarcontrol Class Hierarchy + + + + + + + +
+ + + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For Package ve.ucv.ciens.icaro.libnxtarcontrol

+
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + +