@@ -20,10 +20,15 @@ class Cnosos {
2020 #define SENSOR_CENTRO robot.SIGUELINEAS.readCentro()
2121 #define SENSOR_DCHA robot.SIGUELINEAS.readDcha()
2222
23- // / Se espera este tiempo en milisegundos para confirmar que se ha leido una marca.
23+ /* *
24+ * Se espera este tiempo en milisegundos
25+ * para confirmar que se ha leido una marca.
26+ */
2427 #define TIEMPO_CONFIRMACION 0
2528
26- // / Cada vez que tiene que procesar una entrada, el robot "pensara" (se quedara quieto) este numero de milisegundos.
29+ /* * Cada vez que tiene que procesar una entrada, el robot "pensara"
30+ * (se quedara quieto) este numero de milisegundos.
31+ */
2732 #define TIEMPO_PENSAR 300
2833 private:
2934 // / Guarda la configuracion del robot que se va a usar en este objeto.
@@ -34,76 +39,97 @@ class Cnosos {
3439 // Constructores
3540 /* *
3641 * Constructor de la libreria Cnosos.
37- * No necesita un metodo inicializar, dado que se supone que los parametros ya estan inicializados.
42+ * No necesita un metodo inicializar,
43+ * dado que se supone que los parametros ya estan inicializados.
3844 * @param Robot a controlar
3945 * Objeto Robot con el que se va a trabajar.
40- * Se espera que el Robot este inicializado, asi como su Siguelineas.
41- * Si se necesita debuggear o que el robot se comunique con el usuario,
42- * es necesario inicializar el modulo Morse o el modulo Bluetooth, o ambos.
46+ * Se espera que el Robot este inicializado,
47+ * asi como su Siguelineas.
48+ * Si se necesita debuggear o que el robot
49+ * se comunique con el usuario, es necesario inicializar
50+ * el modulo Morse o el modulo Bluetooth, o ambos.
4351 * @param Numero bits en las etiquetas
44- * Numero de bits que se usaran para identificar cada nodo del mapa.
45- * Se espera que el tamaño del parametro sea adecuado, dado que si se utiliza el valor maximo (255),
52+ * Numero de bits que se usaran para identificar
53+ * cada nodo del mapa.
54+ * Se espera que el tamaño del parametro sea adecuado,
55+ * dado que si se utiliza el valor maximo (255),
4656 * se podrian identificar 2^255 nodos, que son mas de 10^76 nodos.
47- * Por defecto, se utilizaran 3 marcas para el identificador de cada nodo.
57+ * Por defecto, se utilizaran 3 marcas
58+ * para el identificador de cada nodo.
4859 */
4960 Cnosos (Robot, byte = 3 );
5061 // Constructor por defecto
5162 /* *
52- * Constructor que no necesita argumentos, y que permite inicializar un objeto Cnosos.
53- * Las variables se inicializan a valores no recomendables como pines inaccesibles.
54- * IMPORTANTE: Sustituir todas las instancias no inicializadas o inicializadas de esta manera
55- * para que el objeto funcione correctamente.
63+ * Constructor que no necesita argumentos,
64+ * y que permite inicializar un objeto Cnosos.
65+ * Las variables se inicializan a valores no recomendables
66+ * como pines inaccesibles.
67+ * IMPORTANTE: Sustituir todas las instancias no inicializadas o
68+ * inicializadas de esta manera para que el objeto
69+ * funcione correctamente.
5670 */
5771 Cnosos ();
5872 // Destructor
5973
6074
6175 // Funciones
6276 /* *
63- * Avanza por la linea hasta encontrar un hueco en la cinta o una cinta atravesada. Sobrepasa el indicador.
64- * @return 0 si ha encontrado un hueco en la cinta, 1 si ha encontrado una cinta atravesada.
77+ * Avanza por la linea hasta encontrar un hueco en la cinta
78+ * o una cinta atravesada. Sobrepasa el indicador.
79+ * @return 0 si ha encontrado un hueco en la cinta,
80+ * 1 si ha encontrado una cinta atravesada.
6581 */
6682 byte siguiente ();
6783
6884 /* *
6985 * Lee un identificador de nodo.
70- * Este metodo supone que se acaba de cruzar el marcador de comienzo del identificador.
86+ * Este metodo supone que se acaba de cruzar
87+ * el marcador de comienzo del identificador.
7188 * Por defecto, ese marcador es un hueco en la cinta.
7289 */
7390 byte lee_numero ();
7491
7592 /* *
76- * Recorre dos veces el perimetro del nodo para obtener gran cantidad de datos.
77- * Al terminar el metodo, el robot estara situado despues del identificador del nodo.
93+ * Recorre dos veces el perimetro del nodo
94+ * para obtener gran cantidad de datos.
95+ * Al terminar el metodo, el robot estara situado
96+ * despues del identificador del nodo.
7897 * @param[out] Identificador del nodo
7998 * Devuelve el numero que identifica a este nodo.
8099 * @param[out] Grado del nodo
81- * Devuelve el grado (o el numero de cruces) que tiene este nodo.
100+ * Devuelve el grado (o el numero de cruces)
101+ * que tiene este nodo.
82102 * @param[out] Cruce por el que ha entrado el robot al nodo
83103 * Devuelve el numero del cruce por el que ha entrado el nodo.
84- * Si el robot empezo a recorrer el nodo justo detras del identificador, este numero sera 0,
85- * si se empezo detras del primer cruce sera 1...
86- * asi hasta 'grado', que significaria que el robot
104+ * Si el robot empezo a recorrer el nodo justo detras
105+ * del identificador, este numero sera 0,
106+ * si se empezo detras del primer cruce sera 1...
107+ * asi hasta 'grado', que significaria que el robot
87108 * ha empezado a recorrer el nodo antes del identificador.
88109 */
89110 void lee_nodo (byte&, byte&, byte&);
90111
91112 /* *
92- * En cuanto se encuentre un cruce, toma ese cruce y el robot pasa al siguiente nodo.
113+ * En cuanto se encuentre un cruce,
114+ * toma ese cruce y el robot pasa al siguiente nodo.
93115 */
94116 void sal_aqui ();
95117
96118 /* *
97- * Toma un cruce en concreto desde la posicion en la que este el robot.
119+ * Toma un cruce en concreto desde la posicion
120+ * en la que este el robot.
98121 * @param Cruce a tomar
99- * Numero del cruce que se quiere tomar, siendo 1 el primer cruce de la etiqueta.
122+ * Numero del cruce que se quiere tomar,
123+ * siendo 1 el primer cruce de la etiqueta.
100124 * @param Grado del nodo
101125 * Ultimo cruce que puede tomar el robot.
102- * Tambien representa el grado (o el numero de cruces) que hay en el nodo.
126+ * Tambien representa el grado (o el numero de cruces)
127+ * que hay en el nodo.
103128 * @param Cruce actual
104129 * Indica cual es el ultimo cruce que el robot se ha saltado.
105- * Por defecto, se considera que el robot esta justo detras de la etiqueta,
106- * por lo que no se ha saltado ningun cruce (este valor es 0).
130+ * Por defecto, se considera que el robot esta
131+ * justo detras de la etiqueta, por lo que
132+ * no se ha saltado ningun cruce (este valor es 0).
107133 */
108134 void sal (byte, byte, byte = 0 );
109135
@@ -114,15 +140,18 @@ class Cnosos {
114140
115141 /* *
116142 * Comunica un numero al usuario por medio de modulos.
117- * Necesita tener inicializado el modulo Morse o el modulo Bluetooth para comunicarse con el usuario.
143+ * Necesita tener inicializado el modulo Morse
144+ * o el modulo Bluetooth para comunicarse con el usuario.
118145 * @param Numero a comunicar
119- * Envia este numero, ya sea con el mismo numero de pitidos, o con un mensaje Bluetooth.
146+ * Envia este numero, ya sea con el mismo numero de pitidos,
147+ * o con un mensaje Bluetooth.
120148 */
121149 void luce_numero (byte);
122150
123151 /* *
124152 * Se ha encontrado un suceso inesperado. Se para y grita SOS.
125- * Necesita tener inicializado el modulo Morse o el modulo Bluetooth para comunicarse con el usuario.
153+ * Necesita tener inicializado el modulo Morse
154+ * o el modulo Bluetooth para comunicarse con el usuario.
126155 */
127156 void error ();
128157};
0 commit comments