jCMPL
Class CmplParameter

java.lang.Object
  extended by jCMPL.CmplParameter

public class CmplParameter
extends java.lang.Object

Handling of CMPL parameters in jCMPL


Constructor Summary
CmplParameter(java.lang.String name)
          Constructor for a scalar parameter
CmplParameter(java.lang.String name, CmplSet... sets)
          Constructor for a parameter array
 
Method Summary
 long len()
          Length of the parameter array
 java.lang.String name()
          Name of the parameter
 long rank()
          Rank of the parameter
 java.util.List<CmplSet> setList()
          Returns a List of the invoked sets
 void setValues(java.lang.Integer val)
          Sets the value of a scaler Integer parameter
 void setValues(java.lang.Long val)
          Sets the value of a scaler Long parameter
 void setValues(java.lang.Object val)
          Defines the values of a parameter array
 void setValues(java.lang.String val)
          Sets the value of a scaler String parameter
 int valType()
          Returns whether the parameter is organized as list, array or single value
 java.lang.Object value()
          Value of a scalar parameter
 java.lang.Object values()
          List of the values of a parameter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmplParameter

public CmplParameter(java.lang.String name)
              throws CmplException
Constructor for a scalar parameter

Parameters:
name - Name of the set
Throws:
CmplException

CmplParameter

public CmplParameter(java.lang.String name,
                     CmplSet... sets)
              throws CmplException
Constructor for a parameter array

Parameters:
name - Name of the set
sets - CmplSets over that the parameter is defined
Throws:
CmplException
Method Detail

setValues

public void setValues(java.lang.Integer val)
               throws CmplException
Sets the value of a scaler Integer parameter

Parameters:
val - value
Throws:
CmplException

setValues

public void setValues(java.lang.Long val)
               throws CmplException
Sets the value of a scaler Long parameter

Parameters:
val - value
Throws:
CmplException

setValues

public void setValues(java.lang.String val)
               throws CmplException
Sets the value of a scaler String parameter

Parameters:
val - value
Throws:
CmplException

setValues

public void setValues(java.lang.Object val)
               throws CmplException
Defines the values of a parameter array

Parameters:
val - List or array of parameter values
Throws:
CmplException

setList

public java.util.List<CmplSet> setList()
Returns a List of the invoked sets

Returns:
set list

values

public java.lang.Object values()
List of the values of a parameter

Returns:
value list

value

public java.lang.Object value()
Value of a scalar parameter

Returns:
value of the scalar parameter

name

public java.lang.String name()
Name of the parameter

Returns:
name of the CMPL parameter (not the name of the CmplParameter object)

rank

public long rank()
Rank of the parameter

Returns:
rank of the CMPL parameter

len

public long len()
Length of the parameter array

Returns:
number of elements in the parameter array

valType

public int valType()
Returns whether the parameter is organized as list, array or single value

Returns:
valType