Commit 99019058 authored by Daniel Lima Freixo's avatar Daniel Lima Freixo
Browse files

Documentação de Biblioteca de Controle de Flotador

-revisão bloco_media: método validar retornar booleano
-revisão bloco_media: descrições
-revisão bloco_media: método somatório apenas quando há amostras válidas
-revisão bloco_media: método média apenas quando há amostras válidas
-revisão bloco_media: método menor apenas quando há amostras válidas
-revisão bloco_media: método maior apenas quando há amostras válidas

INSTMPA-979
parent 069eb782
......@@ -55,7 +55,7 @@ class{ id = "bloco_calculo", group = "Classes Abstratas",
if (not (self._t_ret and self.intervalo) )
or (t_atual - self._t_ret >= self.intervalo )
then
self._ret = self:calcular(valor)
self._ret = self:calcular(valor)
self._t_ret = t_atual
end
return self._ret
......@@ -88,7 +88,7 @@ class{ id = "bloco_filtro", name = "Bloco Filtro", group = "Blocos de C
},
},
code = [====[
function _CLASS:init()
function _CLASS:init()
end
]====],
methods = {
......@@ -196,11 +196,11 @@ class{ id = "bloco_media", name = "Bloco M
results = {
},
code = [===[ function(self)
return self.amostras:validar(self.periodo)
return self.amostras:validar(self.periodo) and true or false
end ]===],
},
{ id = "iniciar", name = "Iniciar",
description = [[Iniciar a execução do filtro.]],
description = [[Iniciar a execução da média.]],
parameters = {
},
results = {
......@@ -247,9 +247,13 @@ class{ id = "bloco_media", name = "Bloco M
},
code = [===[ function(self, n)
local historico = self.amostras:obter_historico(self.periodo)
local truncado = truncate(historico, n)
return average(truncado)
if historico then
local truncado = truncate(historico, n)
if truncado then
return average(truncado)
end
end
return 0, 1, 1
end ]===],
},
{ id = "calcular_somatorio", name = "Calcular Somatório", description =
......@@ -262,8 +266,13 @@ class{ id = "bloco_media", name = "Bloco M
},
code = [===[ function(self, n)
local historico = self.amostras:obter_historico(self.periodo)
return sum(truncado)
if historico then
local truncado = truncate(historico, n)
if truncado then
return sum(truncado)
end
end
return 0, 1, 0
end ]===],
},
{ id = "menor", name = "Avaliar Menor", description =
......@@ -275,8 +284,10 @@ class{ id = "bloco_media", name = "Bloco M
},
code = [===[ function(self, valor)
local historico = self.amostras:obter_historico(self.periodo)
return minimo(historico)
if historico then
return minimo(historico)
end
return nil, 1, 0
end ]===],
},
{ id = "maior", name = "Avaliar Maior", description =
......@@ -288,8 +299,10 @@ class{ id = "bloco_media", name = "Bloco M
},
code = [===[ function(self, valor)
local historico = self.amostras:obter_historico(self.periodo)
return maximo(historico)
if historico then
return maximo(historico)
end
return nil, 1, 0
end ]===],
},
},
......@@ -320,7 +333,7 @@ class{ id = "bloco_tempo_morto", name = "Bloco Tempo Morto", group = "Blocos de
self:apagar()
end ]===],
},
{ id = "calcular", name = "Calcular", description =
{ id = "calcular", name = "Calcular", description =
[[Aplica o tempo morto ao valor de entrada.
Esta função cria uma defasagem nos valores fornecidos, retornando a referência
......@@ -328,10 +341,10 @@ class{ id = "bloco_tempo_morto", name = "Bloco Tempo Morto", group = "Blocos de
Após passado o tempo morto definido, os valores fornecidos anteriormente
começam a ser retornados. O valor retornado é o valor cujo momento de
inclusão tenha sido o mais próximo, mas não menor, que o tempo morto.
Todos os valores armazenados associados a tempos anteriores ao valor
retornado são automaticamente descartados.
Dado esse critério, caso a execução desta função seja feita em uma
freqüência variável, valores armazenados podem ser descartados sem
nunca serem retornados.]],
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment