Package pulse.problem.statements

Class Pulse2D

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.statements.Pulse

pulse.problem.statements.Pulse2D

All Implemented Interfaces:

Serializable, Descriptive

public class Pulse2D
extends Pulse

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Pulse2D()	Creates a Pulse with default values of pulse width and laser spot diameter (as per XML specification).
Pulse2D(Pulse p)	Copy constructor

Method Summary

Modifier and Type	Method	Description
Pulse	copy()
NumericProperty	getSpotDiameter()
void	initFrom(Pulse pulse)
Set<NumericPropertyKeyword>	listedKeywords()	The listed parameters for Pulse are: PulseShape, PULSE_WIDTH, SPOT_DIAMETER.
void	set(NumericPropertyKeyword type, NumericProperty property)	An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible.
void	setSpotDiameter(NumericProperty spotDiameter)
String	toString()

Methods inherited from class pulse.problem.statements.Pulse

getLaserEnergy, getPulseDescriptor, getPulseShape, getPulseWidth, initListeners, listedTypes, setLaserEnergy, setPulseDescriptor, setPulseShape, setPulseWidth

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getDescriptor, getListeners, getPrefix, ignoreSiblings, isListedNumericType, isListedParameter, numericData, parameterListChanged, removeListeners, setPrefix, updateProperties, updateProperty

Methods inherited from class pulse.util.Accessible

accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, update, update

Methods inherited from class pulse.util.Group

access, children, contents, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable

addHierarchyListener, getHierarchyListeners, getParent, identify, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Pulse2D

public Pulse2D()

Creates a Pulse with default values of pulse width and laser spot diameter (as per XML specification).

Pulse2D

public Pulse2D(Pulse p)

Copy constructor

Parameters:

p - the pulse, parameters of which will be copied.

Method Detail

initFrom

public void initFrom(Pulse pulse)

Overrides:

initFrom in class Pulse

copy

public Pulse copy()

Overrides:

copy in class Pulse

getSpotDiameter

public NumericProperty getSpotDiameter()

setSpotDiameter

public void setSpotDiameter(NumericProperty spotDiameter)

toString

public String toString()

Overrides:

toString in class Pulse

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: Pulse

The listed parameters for Pulse are: PulseShape, PULSE_WIDTH, SPOT_DIAMETER.

Overrides:

listedKeywords in class Pulse

Returns:

a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

set

public void set(NumericPropertyKeyword type,
                NumericProperty property)

Description copied from class: Accessible

An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.

Overrides:

set in class Pulse

Parameters:

type - the type, which must be equal by definition to property.getType().

property - the property, which contains new information.