Documentacao do codigo

Edmar Moretti
1 parent 57342379
Showing 1 changed file with 58 additions and 24 deletions Show diff stats
ferramentas/metaestat/analise.php
@@ -71,7 +71,7 @@ $retorno = &quot;&quot;;
  * Cada rotina recebe parametros especificos
  * A documentacao de cada rotina encontra-se no programa PHP que e executado
  * $map_file e obtido da variavel session e corresponde ao mapa que esta sendo usado
- * 
+ *
  * Quando um layer original do sistema METAESTAT e alterado, isso e indicado pelo metadata METAESTAT_DERIVADO
  * que passa a ser marcado com "sim"
  */
@@ -142,7 +142,7 @@ else
 /**
  * Adiciona ao mapa atual um novo layer para a representacao de uma regiao
  * Se o layer ja existir, sera removido e criado outro
- * 
+ *
  * @param arquivo mapfile do mapa atual
  * @param codigo da regiao no cadastro
  * @param cor do contorno
@@ -208,7 +208,7 @@ function mapaDeCalor($map_file,$tema){
 }
 /**
  * Altera as caracteristicas de representacao de um layer
- * 
+ *
  * @param mapfile do mapa atual
  * @param nome do layer que sera processado
  * @param tipo de processamento pponto|hachurea|opacidade
@@ -485,6 +485,16 @@ function analise_listaCamadasFiltroTempo($map_file){
 	}
 	return $camadas;
 }
+/**
+ * Aplica um filtro de tempo em uma camada
+ * @param arquivo mapfile do mapa atual
+ * @param nome do layer que sera processado
+ * @param lista com os ids dos parametros de tempo inicial
+ * @param lista com os valores dos parametros de pari
+ * @param lista com os ids dos parametros de tempo final
+ * @param lista com os valores dos parametros de parf
+ * @return string
+ */
 function analise_aplicaFiltroTempo($map_file,$tema,$pari,$vali,$parf,$valf){
 	$mapa = ms_newMapObj($map_file);
 	$layer = $mapa->getlayerbyname($tema);
@@ -516,6 +526,12 @@ function analise_aplicaFiltroTempo($map_file,$tema,$pari,$vali,$parf,$valf){
 	$mapa->save($map_file);
 	return "ok";
 }
+/**
+ * Remove o filtro de tempo
+ * @param arquivo mapfile do mapa atual
+ * @param nome do layer que sera processado
+ * @return string
+ */
 function analise_removeFiltroTempo($map_file,$tema){
 	$mapa = ms_newMapObj($map_file);
 	$layer = $mapa->getlayerbyname($tema);
@@ -527,6 +543,11 @@ function analise_removeFiltroTempo($map_file,$tema){
 	$mapa->save($map_file);
 	return "ok";
 }
+/**
+ * Lista os nomes das camadas do mapa atual que sao originarias do sistema de metadados
+ * @param arquivo mapfile do mapa atual
+ * @return Array com o nome dos layers
+ */
 function analise_listaCamadasMetaestat($map_file){
 	$mapa = ms_newMapObj($map_file);
 	$layers = analise_listaLayersMetaestat($mapa);
@@ -536,7 +557,40 @@ function analise_listaCamadasMetaestat($map_file){
 	}
 	return $camadas;
 }
-//se $tipo for igual a "" remove os filtros
+/**
+ * Lista os objetos layers do mapa atual que sao originarias do sistema de metadados
+ * @param arquivo mapfile do mapa atual
+ * @return Array com os layers
+ */
+function analise_listaLayersMetaestat($mapa){
+	$c = $mapa->numlayers;
+	$layers = array();
+	for ($i=0;$i < $c;++$i){
+		$l = $mapa->getlayer($i);
+		if($l->getmetadata("METAESTAT") == "SIM"){
+			$layers[] = $l;
+		}
+	}
+	return $layers;
+}
+function analise_listaLayersRegiao($layers,$codigo_tipo_regiao){
+	$final = array();
+	foreach($layers as $l){
+		if($l->getmetadata("METAESTAT_CODIGO_TIPO_REGIAO") == $codigo_tipo_regiao){
+			$final[] = $l;
+		}
+	}
+	return $final;
+}
+/**
+ * Aplica um filtro para mostrar apenas uma regiao escolhida pelo usuario
+ * Altera todos os layers com o mesmo codigo_tipo_regiao
+ * Se codigo_tipo_regiao for vazio, remove os filtros de todos os layers
+ * @param arquivo mapfile do mapa atual
+ * @param codigo da regiao
+ * @param valor da regiao (id)
+ * @return string
+ */
 function analise_aplicafiltroregiao($map_file,$codigo_tipo_regiao,$codigo_regiao){
 	//echo $codigo_tipo_regiao;exit;
 	$m = new Metaestat();
@@ -576,25 +630,5 @@ function analise_aplicafiltroregiao($map_file,$codigo_tipo_regiao,$codigo_regiao
 	}
 	$mapa->save($map_file);
 	return "ok";
-}
-function analise_listaLayersMetaestat($mapa){
-	$c = $mapa->numlayers;
-	$layers = array();
-	for ($i=0;$i < $c;++$i){
-		$l = $mapa->getlayer($i);
-		if($l->getmetadata("METAESTAT") == "SIM"){
-			$layers[] = $l;
-		}
-	}
-	return $layers;
-}
-function analise_listaLayersRegiao($layers,$codigo_tipo_regiao){
-	$final = array();
-	foreach($layers as $l){
-		if($l->getmetadata("METAESTAT_CODIGO_TIPO_REGIAO") == $codigo_tipo_regiao){
-			$final[] = $l;
-		}
-	}
-	return $final;
 }
 ?>
	@@ -71,7 +71,7 @@ $retorno = "";		@@ -71,7 +71,7 @@ $retorno = "";
71	* Cada rotina recebe parametros especificos	71	* Cada rotina recebe parametros especificos
72	* A documentacao de cada rotina encontra-se no programa PHP que e executado	72	* A documentacao de cada rotina encontra-se no programa PHP que e executado
73	* $map_file e obtido da variavel session e corresponde ao mapa que esta sendo usado	73	* $map_file e obtido da variavel session e corresponde ao mapa que esta sendo usado
74	- *	74	+ *
75	* Quando um layer original do sistema METAESTAT e alterado, isso e indicado pelo metadata METAESTAT_DERIVADO	75	* Quando um layer original do sistema METAESTAT e alterado, isso e indicado pelo metadata METAESTAT_DERIVADO
76	* que passa a ser marcado com "sim"	76	* que passa a ser marcado com "sim"
77	*/	77	*/
	@@ -142,7 +142,7 @@ else		@@ -142,7 +142,7 @@ else
142	/**	142	/**
143	* Adiciona ao mapa atual um novo layer para a representacao de uma regiao	143	* Adiciona ao mapa atual um novo layer para a representacao de uma regiao
144	* Se o layer ja existir, sera removido e criado outro	144	* Se o layer ja existir, sera removido e criado outro
145	- *	145	+ *
146	* @param arquivo mapfile do mapa atual	146	* @param arquivo mapfile do mapa atual
147	* @param codigo da regiao no cadastro	147	* @param codigo da regiao no cadastro
148	* @param cor do contorno	148	* @param cor do contorno
	@@ -208,7 +208,7 @@ function mapaDeCalor($map_file,$tema){		@@ -208,7 +208,7 @@ function mapaDeCalor($map_file,$tema){
208	}	208	}
209	/**	209	/**
210	* Altera as caracteristicas de representacao de um layer	210	* Altera as caracteristicas de representacao de um layer
211	- *	211	+ *
212	* @param mapfile do mapa atual	212	* @param mapfile do mapa atual
213	* @param nome do layer que sera processado	213	* @param nome do layer que sera processado
214	* @param tipo de processamento pponto\|hachurea\|opacidade	214	* @param tipo de processamento pponto\|hachurea\|opacidade
	@@ -485,6 +485,16 @@ function analise_listaCamadasFiltroTempo($map_file){		@@ -485,6 +485,16 @@ function analise_listaCamadasFiltroTempo($map_file){
485	}	485	}
486	return $camadas;	486	return $camadas;
487	}	487	}
		488	+/**
		489	+ * Aplica um filtro de tempo em uma camada
		490	+ * @param arquivo mapfile do mapa atual
		491	+ * @param nome do layer que sera processado
		492	+ * @param lista com os ids dos parametros de tempo inicial
		493	+ * @param lista com os valores dos parametros de pari
		494	+ * @param lista com os ids dos parametros de tempo final
		495	+ * @param lista com os valores dos parametros de parf
		496	+ * @return string
		497	+ */
488	function analise_aplicaFiltroTempo($map_file,$tema,$pari,$vali,$parf,$valf){	498	function analise_aplicaFiltroTempo($map_file,$tema,$pari,$vali,$parf,$valf){
489	$mapa = ms_newMapObj($map_file);	499	$mapa = ms_newMapObj($map_file);
490	$layer = $mapa->getlayerbyname($tema);	500	$layer = $mapa->getlayerbyname($tema);
	@@ -516,6 +526,12 @@ function analise_aplicaFiltroTempo($map_file,$tema,$pari,$vali,$parf,$valf){		@@ -516,6 +526,12 @@ function analise_aplicaFiltroTempo($map_file,$tema,$pari,$vali,$parf,$valf){
516	$mapa->save($map_file);	526	$mapa->save($map_file);
517	return "ok";	527	return "ok";
518	}	528	}
		529	+/**
		530	+ * Remove o filtro de tempo
		531	+ * @param arquivo mapfile do mapa atual
		532	+ * @param nome do layer que sera processado
		533	+ * @return string
		534	+ */
519	function analise_removeFiltroTempo($map_file,$tema){	535	function analise_removeFiltroTempo($map_file,$tema){
520	$mapa = ms_newMapObj($map_file);	536	$mapa = ms_newMapObj($map_file);
521	$layer = $mapa->getlayerbyname($tema);	537	$layer = $mapa->getlayerbyname($tema);
	@@ -527,6 +543,11 @@ function analise_removeFiltroTempo($map_file,$tema){		@@ -527,6 +543,11 @@ function analise_removeFiltroTempo($map_file,$tema){
527	$mapa->save($map_file);	543	$mapa->save($map_file);
528	return "ok";	544	return "ok";
529	}	545	}
		546	+/**
		547	+ * Lista os nomes das camadas do mapa atual que sao originarias do sistema de metadados
		548	+ * @param arquivo mapfile do mapa atual
		549	+ * @return Array com o nome dos layers
		550	+ */
530	function analise_listaCamadasMetaestat($map_file){	551	function analise_listaCamadasMetaestat($map_file){
531	$mapa = ms_newMapObj($map_file);	552	$mapa = ms_newMapObj($map_file);
532	$layers = analise_listaLayersMetaestat($mapa);	553	$layers = analise_listaLayersMetaestat($mapa);
	@@ -536,7 +557,40 @@ function analise_listaCamadasMetaestat($map_file){		@@ -536,7 +557,40 @@ function analise_listaCamadasMetaestat($map_file){
536	}	557	}
537	return $camadas;	558	return $camadas;
538	}	559	}
539	-//se $tipo for igual a "" remove os filtros	560	+/**
		561	+ * Lista os objetos layers do mapa atual que sao originarias do sistema de metadados
		562	+ * @param arquivo mapfile do mapa atual
		563	+ * @return Array com os layers
		564	+ */
		565	+function analise_listaLayersMetaestat($mapa){
		566	+ $c = $mapa->numlayers;
		567	+ $layers = array();
		568	+ for ($i=0;$i < $c;++$i){
		569	+ $l = $mapa->getlayer($i);
		570	+ if($l->getmetadata("METAESTAT") == "SIM"){
		571	+ $layers[] = $l;
		572	+ }
		573	+ }
		574	+ return $layers;
		575	+}
		576	+function analise_listaLayersRegiao($layers,$codigo_tipo_regiao){
		577	+ $final = array();
		578	+ foreach($layers as $l){
		579	+ if($l->getmetadata("METAESTAT_CODIGO_TIPO_REGIAO") == $codigo_tipo_regiao){
		580	+ $final[] = $l;
		581	+ }
		582	+ }
		583	+ return $final;
		584	+}
		585	+/**
		586	+ * Aplica um filtro para mostrar apenas uma regiao escolhida pelo usuario
		587	+ * Altera todos os layers com o mesmo codigo_tipo_regiao
		588	+ * Se codigo_tipo_regiao for vazio, remove os filtros de todos os layers
		589	+ * @param arquivo mapfile do mapa atual
		590	+ * @param codigo da regiao
		591	+ * @param valor da regiao (id)
		592	+ * @return string
		593	+ */
540	function analise_aplicafiltroregiao($map_file,$codigo_tipo_regiao,$codigo_regiao){	594	function analise_aplicafiltroregiao($map_file,$codigo_tipo_regiao,$codigo_regiao){
541	//echo $codigo_tipo_regiao;exit;	595	//echo $codigo_tipo_regiao;exit;
542	$m = new Metaestat();	596	$m = new Metaestat();
	@@ -576,25 +630,5 @@ function analise_aplicafiltroregiao($map_file,$codigo_tipo_regiao,$codigo_regiao		@@ -576,25 +630,5 @@ function analise_aplicafiltroregiao($map_file,$codigo_tipo_regiao,$codigo_regiao
576	}	630	}
577	$mapa->save($map_file);	631	$mapa->save($map_file);
578	return "ok";	632	return "ok";
579	-}
580	-function analise_listaLayersMetaestat($mapa){
581	- $c = $mapa->numlayers;
582	- $layers = array();
583	- for ($i=0;$i < $c;++$i){
584	- $l = $mapa->getlayer($i);
585	- if($l->getmetadata("METAESTAT") == "SIM"){
586	- $layers[] = $l;
587	- }
588	- }
589	- return $layers;
590	-}
591	-function analise_listaLayersRegiao($layers,$codigo_tipo_regiao){
592	- $final = array();
593	- foreach($layers as $l){
594	- if($l->getmetadata("METAESTAT_CODIGO_TIPO_REGIAO") == $codigo_tipo_regiao){
595	- $final[] = $l;
596	- }
597	- }
598	- return $final;
599	}	633	}
600	?>	634	?>