Module simpa.core

Package simpa.core.api

Class GlobalSourceArrangement

java.lang.Object

simpa.core.api.GlobalSourceArrangement

public class GlobalSourceArrangement
extends Object

Class containing the source arrangements that make up a region of the field that will be evaluated.

Constructor Summary

Constructors

Constructor	Description
GlobalSourceArrangement(String name, List<SourceArrangement> list, double scaling)	Construct a global source arrangement with the given name, list of SourceArrangement objects and scaling.

Method Summary

Modifier and Type	Method	Description
List<SourceArrangement>	getElements()	Gets the list of SourceArrangement objects.
String	getName()	Gets the name of the global source arrangement.
double	getScaling()	Gets the global scaling.
void	setScaling(double sc)	Method to set/update the global scaling.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GlobalSourceArrangement

public GlobalSourceArrangement(String name,
 List<SourceArrangement> list,
 double scaling)

Construct a global source arrangement with the given name, list of SourceArrangement objects and scaling.

Parameters:

name - Name for the global source arrangement.

list - List of SourceArrangement objects.

scaling - Global scaling.

Method Details

getElements

public List<SourceArrangement> getElements()

Gets the list of SourceArrangement objects.

Returns:

List of SourceArrangement objects.

getScaling

public double getScaling()

Gets the global scaling.

Returns:

The global scaling.

setScaling

public void setScaling(double sc)

Method to set/update the global scaling.

Parameters:

sc - Scaling value (double).

getName

public String getName()

Gets the name of the global source arrangement.

Returns:

The name of the global source arrangement.