jip
Class JIPParameter

java.lang.Object
  |
  +--jip.JIPParameter

public class JIPParameter
extends java.lang.Object

Descripción:
Clase que define el objeto parámetro. Un parámetro contiene información adicional que será utilizada por una función y que condicionará la forma en que la función procesa la imagen de entrada para obtener la imagen de salida. Un parámetro puede ser de 5 tipos: pBOOL, pINT, pREAL, pSTRING y pIMAGE. Estos tipos se definen en la clase JIP. Además un parámetro puede ser requerido o no. En caso de no ser requerido el parámetro podrá tener un valor asignado por defecto. El constructor básico de un parámetro debe especificar su nombre, tipo y si es o no requerido. Estas características no variarán durante la vida del objeto. También podremos asignar a un parámetro una descripción que indicará su funcionamiento. Podremos acceder al valor del parámetro o asignarlo. Si un parámetro no tiene valor asignado y no es requerido, al acceder a su valor obtendremos el valor que tenga asignado por defecto.

See Also:
JIP.pBOOL, JIP.pINT, JIP.pREAL, JIP.pSTRING, JIP.pIMAGE

Field Summary
(package private)  boolean asigned
          Indica si el parámetro está asignado
(package private)  boolean defvalbool
          Valor por defecto Booleano
(package private)  JIPImage defvalimg
          Valor por defecto de Imagen
(package private)  int defvalint
          Valor por defecto Entero
(package private)  float defvalreal
          Valor por defecto Real
(package private)  java.lang.String defvalstr
          Valor por defecto de Cadena de Texto
(package private)  java.lang.String description
          Descripcción del parámetro
(package private)  java.lang.String name
          Nombre del Parámetro
(package private)  boolean required
          Indica si el parámetro es requerido
(package private)  int type
          Tipo del Parámetro
(package private)  boolean valbool
          Indica si el parámetro es Booleano
(package private)  JIPImage valimg
          Indica si el parámetro es una imagen
(package private)  int valint
          Indica si el parámetro es Entero
(package private)  float valreal
          Indica si el parámetro es Real
(package private)  java.lang.String valstr
          Indica si el parámetro es una Cadena de Texto
 
Constructor Summary
JIPParameter(java.lang.String n, int t, boolean req)
           Descripción:
Constructor de un parámetro.
 
Method Summary
 boolean getDefaultBool()
           Descripción:
Obtiene el valor por defecto booleano asignado al parámetro.
 JIPImage getDefaultImg()
           Descripción:
Obtiene el valor por defecto imagen asignado al parámetro.
 int getDefaultInt()
           Descripción:
Obtiene el valor por defecto entero asignado al parámetro.
 float getDefaultReal()
           Descripción:
Obtiene el valor por defecto real asignado al parámetro.
 java.lang.String getDefaultStr()
           Descripción:
Obtiene el valor por defecto string asignado al parámetro.
 java.lang.String getDescription()
           Descripción:
Obtiene la descripción asignada al parámetro.
 java.lang.String getName()
           Descripción:
Obtiene el nombre del parámetro.
 int getType()
           Descripción:
Obtiene el tipo del parámetro.
 boolean getValueBool()
           Descripción:
Obtiene el valor booleano asignado al parámetro.
 JIPImage getValueImg()
           Descripción:
Obtiene el valor imagen asignado al parámetro.
 int getValueInt()
           Descripción:
Obtiene el valor entero asignado al parámetro.
 float getValueReal()
           Descripción:
Obtiene el valor real asignado al parámetro.
 java.lang.String getValueStr()
           Descripción:
Obtiene el valor string asignado al parámetro.
 boolean isAsigned()
           Descripción:
Nos dice si el valor del parámetro está ya asignado o no.
 boolean isRequired()
           Descripción:
Nos dice si el parámetro es o no requerido.
 void setDefault(boolean d)
           Descripción:
Asigna al parámetro un valor por defecto booleano.
 void setDefault(float d)
           Descripción:
Asigna al parámetro un valor por defecto real.
 void setDefault(int d)
           Descripción:
Asigna al parámetro un valor por defecto entero.
 void setDefault(JIPImage img)
           Descripción:
Asigna al parámetro un valor por defecto imagen.
 void setDefault(java.lang.String d)
           Descripción:
Asigna al parámetro un valor por defecto string.
 void setDescription(java.lang.String d)
           Descripción:
Asigna una descripción al parámetro.
 void setValue(boolean v)
           Descripción:
Asigna al parámetro un valor booleano.
 void setValue(float v)
           Descripción:
Asigna al parámetro un valor real.
 void setValue(int v)
           Descripción:
Asigna al parámetro un valor entero.
 void setValue(JIPImage img)
           Descripción:
Asigna al parámetro un valor imagen.
 void setValue(java.lang.String v)
           Descripción:
Asigna al parámetro un valor string.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

name

java.lang.String name
Nombre del Parámetro

type

int type
Tipo del Parámetro

required

boolean required
Indica si el parámetro es requerido

asigned

boolean asigned
Indica si el parámetro está asignado

description

java.lang.String description
Descripcción del parámetro

valbool

boolean valbool
Indica si el parámetro es Booleano

valint

int valint
Indica si el parámetro es Entero

valreal

float valreal
Indica si el parámetro es Real

valstr

java.lang.String valstr
Indica si el parámetro es una Cadena de Texto

valimg

JIPImage valimg
Indica si el parámetro es una imagen

defvalbool

boolean defvalbool
Valor por defecto Booleano

defvalint

int defvalint
Valor por defecto Entero

defvalreal

float defvalreal
Valor por defecto Real

defvalstr

java.lang.String defvalstr
Valor por defecto de Cadena de Texto

defvalimg

JIPImage defvalimg
Valor por defecto de Imagen
Constructor Detail

JIPParameter

public JIPParameter(java.lang.String n,
                    int t,
                    boolean req)

Descripción:
Constructor de un parámetro.

Parameters:
n - Nombre del parámetro.
t - Tipo de parámetro.
req - Flag que indica si es requerido (true) o no (false).
Method Detail

getName

public java.lang.String getName()

Descripción:
Obtiene el nombre del parámetro.

Returns:
Nombre del parámetro.

getType

public int getType()

Descripción:
Obtiene el tipo del parámetro.

Returns:
Tipo del parámetro.
See Also:
JIP.pBOOL, JIP.pINT, JIP.pREAL, JIP.pSTRING, JIP.pIMAGE

isRequired

public boolean isRequired()

Descripción:
Nos dice si el parámetro es o no requerido.

Returns:
true si el parámetro es requerido, false en caso contrario.

isAsigned

public boolean isAsigned()

Descripción:
Nos dice si el valor del parámetro está ya asignado o no.

Returns:
true si el valor del parámetro está asignado, false en caso contrario.

setDescription

public void setDescription(java.lang.String d)

Descripción:
Asigna una descripción al parámetro.

Parameters:
d - Descripción a asignar al parámetro.

getDescription

public java.lang.String getDescription()

Descripción:
Obtiene la descripción asignada al parámetro.

Returns:
Descripción asignada al parámetro.

setDefault

public void setDefault(boolean d)

Descripción:
Asigna al parámetro un valor por defecto booleano. El parámetro no debe ser requerido y debe ser de tipo pBOOL.

Parameters:
d - Valor a asignar como valor por defecto.

setDefault

public void setDefault(int d)

Descripción:
Asigna al parámetro un valor por defecto entero. El parámetro no debe ser requerido y debe ser de tipo pINT.

Parameters:
d - Valor a asignar como valor por defecto.

setDefault

public void setDefault(float d)

Descripción:
Asigna al parámetro un valor por defecto real. El parámetro no debe ser requerido y debe ser de tipo pREAL.

Parameters:
d - Valor a asignar como valor por defecto.

setDefault

public void setDefault(java.lang.String d)

Descripción:
Asigna al parámetro un valor por defecto string. El parámetro no debe ser requerido y debe ser de tipo pSTRING.

Parameters:
d - Valor a asignar como valor por defecto.

setDefault

public void setDefault(JIPImage img)

Descripción:
Asigna al parámetro un valor por defecto imagen. El parámetro no debe ser requerido y debe ser de tipo pIMAGE.

Parameters:
img - Imagen a asignar como valor por defecto.

getDefaultBool

public boolean getDefaultBool()

Descripción:
Obtiene el valor por defecto booleano asignado al parámetro. El parámetro no debe ser requerido y debe ser de tipo pBOOL.

Returns:
Valor por defecto asignado al parámetro.

getDefaultInt

public int getDefaultInt()

Descripción:
Obtiene el valor por defecto entero asignado al parámetro. El parámetro no debe ser requerido y debe ser de tipo pINT.

Returns:
Valor por defecto asignado al parámetro.

getDefaultReal

public float getDefaultReal()

Descripción:
Obtiene el valor por defecto real asignado al parámetro. El parámetro no debe ser requerido y debe ser de tipo pREAL.

Returns:
Valor por defecto asignado al parámetro.

getDefaultStr

public java.lang.String getDefaultStr()

Descripción:
Obtiene el valor por defecto string asignado al parámetro. El parámetro no debe ser requerido y debe ser de tipo pSTRING.

Returns:
Valor por defecto asignado al parámetro.

getDefaultImg

public JIPImage getDefaultImg()

Descripción:
Obtiene el valor por defecto imagen asignado al parámetro. El parámetro no debe ser requerido y debe ser de tipo pIMAGE.

Returns:
Valor por defecto asignado al parámetro.

setValue

public void setValue(boolean v)

Descripción:
Asigna al parámetro un valor booleano. El parámetro debe ser de tipo pBOOL.

Parameters:
v - Valor a asignar. Tras llamar a este método, el método isAsigned() devolverá true.

setValue

public void setValue(int v)

Descripción:
Asigna al parámetro un valor entero. El parámetro debe ser de tipo pINT.

Parameters:
v - Valor a asignar. Tras llamar a este método, el método isAsigned() devolverá true.

setValue

public void setValue(float v)

Descripción:
Asigna al parámetro un valor real. El parámetro debe ser de tipo pREAL.

Parameters:
v - Valor a asignar. Tras llamar a este método, el método isAsigned() devolverá true.

setValue

public void setValue(java.lang.String v)

Descripción:
Asigna al parámetro un valor string. El parámetro debe ser de tipo pSTRING.

Parameters:
v - Valor a asignar. Tras llamar a este método, el método isAsigned() devolverá true.

setValue

public void setValue(JIPImage img)

Descripción:
Asigna al parámetro un valor imagen. El parámetro debe ser de tipo pIMAGE.

Parameters:
img - Valor a asignar. Tras llamar a este método, el método isAsigned() devolverá true.

getValueBool

public boolean getValueBool()

Descripción:
Obtiene el valor booleano asignado al parámetro. El parámetro debe ser de tipo pBOOL.

Returns:
Valor asignado al parámetro. Si no está asignado y el parámetro no es requerido devolverá el valor asignado por defecto.

getValueInt

public int getValueInt()

Descripción:
Obtiene el valor entero asignado al parámetro. El parámetro debe ser de tipo pINT.

Returns:
Valor asignado al parámetro. Si no está asignado y el parámetro no es requerido devolverá el valor asignado por defecto.

getValueReal

public float getValueReal()

Descripción:
Obtiene el valor real asignado al parámetro. El parámetro debe ser de tipo pREAL.

Returns:
Valor asignado al parámetro. Si no está asignado y el parámetro no es requerido devolverá el valor asignado por defecto.

getValueStr

public java.lang.String getValueStr()

Descripción:
Obtiene el valor string asignado al parámetro. El parámetro debe ser de tipo pSTRING.

Returns:
Valor asignado al parámetro. Si no está asignado y el parámetro no es requerido devolverá el valor asignado por defecto.

getValueImg

public JIPImage getValueImg()

Descripción:
Obtiene el valor imagen asignado al parámetro. El parámetro debe ser de tipo pIMAGE.

Returns:
Valor asignado al parámetro. Si no está asignado y el parámetro no es requerido devolverá el valor asignado por defecto.