The SUMO toolbox  2018a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Classes | Public Member Functions | Static Public Member Functions | List of all members
OutputDescription Class Reference

Class that describes one input dimension This object represents a task for the DataSource: for each given set of input parameters, the DataSource has to calculate the output parameters. More...

Classes

enum  Type
 

Public Member Functions

 OutputDescription (OutputDescription other)
 Copy constructor. More...
 
 OutputDescription (NodeConfig config)
 Initializes a parameter description, increments the output select counter. More...
 
boolean equals (OutputDescription other)
 Implements the equals function for parameter descriptions, same name = equal. More...
 
boolean isComplex ()
 Is this a complex parameter? More...
 
boolean isReal ()
 Is this a real parameter? More...
 
void setName (String name)
 Change the name of the parameter. More...
 
String getName ()
 The name of the parameter. More...
 
String getType ()
 The type of the parameter. More...
 
double getMinimum ()
 Get the minimum value this output can have. More...
 
double getMaximum ()
 Get the maximum value this output can have. More...
 
boolean ignoreNaN ()
 Ignore NaN samples for this output? More...
 
boolean ignoreInf ()
 Ignore Inf samples for this output? More...
 
String toString ()
 Produce a readable text description for this parameter. More...
 
OutputDescription convertToReal ()
 Interpret the REAL part of this COMPLEX parameter as a REAL parameter, ignore the IMAG part. More...
 
OutputDescription convertToImag ()
 Interpret the IMAG part of this COMPLEX parameter as a REAL parameter, ignore the REAL part. More...
 
OutputDescription convertToModulus ()
 Interpret the MODULUS of this COMPLEX parameter as a REAL parameter. More...
 
OutputDescription convertToPhase ()
 Interpret the PHASE of this COMPLEX parameter as a REAL parameter. More...
 
int[] getOutputSelect ()
 Which outputs from the simulator are used by this parameter? More...
 
List< Node > getComponents ()
 Get a list of the components that are used to model this output. More...
 
List< NodeConfiggetMeasures ()
 Get a list of all measures that are used to evaluate models for this output. More...
 
List< NodeConfiggetGlobalMeasures ()
 Get a list of the global measures, measures that were defined for all outputs. More...
 
List< NodeConfiggetLocalMeasures ()
 Get a list of the local measures, measures that were defined for this output tag only. More...
 
List< NodeConfiggetModifiers ()
 Get a list of modifiers that are used to modify the output. More...
 

Static Public Member Functions

static void resetCounter ()
 Reset the counter that keeps track of the parameters in the simulator. More...
 
static int getCounter ()
 Get the total amount of outputs that have been initialized to be read from the simulator so far. More...
 

Detailed Description

Class that describes one input dimension This object represents a task for the DataSource: for each given set of input parameters, the DataSource has to calculate the output parameters.

Constructor & Destructor Documentation

Copy constructor.

Parameters
otherThe other description to copy from.
OutputDescription ( NodeConfig  config)
inline

Initializes a parameter description, increments the output select counter.

Parameters
nameName of the parameter (does not have to be unique)
typeType of the parameter, one of REAL, COMPLEX (COMPLEX parameters are formed out of 2 reals read from the simulator)

Member Function Documentation

OutputDescription convertToImag ( )
inline

Interpret the IMAG part of this COMPLEX parameter as a REAL parameter, ignore the REAL part.

OutputDescription convertToModulus ( )
inline

Interpret the MODULUS of this COMPLEX parameter as a REAL parameter.

Returns
OutputDescription convertToPhase ( )
inline

Interpret the PHASE of this COMPLEX parameter as a REAL parameter.

Returns
OutputDescription convertToReal ( )
inline

Interpret the REAL part of this COMPLEX parameter as a REAL parameter, ignore the IMAG part.

boolean equals ( OutputDescription  other)
inline

Implements the equals function for parameter descriptions, same name = equal.

List<Node> getComponents ( )
inline

Get a list of the components that are used to model this output.

static int getCounter ( )
inlinestatic

Get the total amount of outputs that have been initialized to be read from the simulator so far.

List<NodeConfig> getGlobalMeasures ( )
inline

Get a list of the global measures, measures that were defined for all outputs.

List<NodeConfig> getLocalMeasures ( )
inline

Get a list of the local measures, measures that were defined for this output tag only.

double getMaximum ( )
inline

Get the maximum value this output can have.

List<NodeConfig> getMeasures ( )
inline

Get a list of all measures that are used to evaluate models for this output.

This includes local and global measures

double getMinimum ( )
inline

Get the minimum value this output can have.

List<NodeConfig> getModifiers ( )
inline

Get a list of modifiers that are used to modify the output.

String getName ( )
inline

The name of the parameter.

int [] getOutputSelect ( )
inline

Which outputs from the simulator are used by this parameter?

String getType ( )
inline

The type of the parameter.

boolean ignoreInf ( )
inline

Ignore Inf samples for this output?

boolean ignoreNaN ( )
inline

Ignore NaN samples for this output?

boolean isComplex ( )
inline

Is this a complex parameter?

boolean isReal ( )
inline

Is this a real parameter?

static void resetCounter ( )
inlinestatic

Reset the counter that keeps track of the parameters in the simulator.

void setName ( String  name)
inline

Change the name of the parameter.

String toString ( )
inline

Produce a readable text description for this parameter.


The documentation for this class was generated from the following file: