Package pulse.problem.statements

Class Pulse

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.statements.Pulse

All Implemented Interfaces:

Serializable, Descriptive

Direct Known Subclasses:

Pulse2D

public class Pulse
extends PropertyHolder

A Pulse stores the parameters of the laser pulse, but does not provide the calculation facilities.

See Also:

DiscretePulse, Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Pulse	copy()
NumericProperty	getLaserEnergy()
InstanceDescriptor<? extends PulseTemporalShape>	getPulseDescriptor()
PulseTemporalShape	getPulseShape()
NumericProperty	getPulseWidth()
void	initFrom(Pulse pulse)
void	initListeners()
Set<NumericPropertyKeyword>	listedKeywords()	The listed parameters for Pulse are: PulseShape, PULSE_WIDTH, SPOT_DIAMETER.
List<Property>	listedTypes()	By default, collects a list of default properties corresponding to types defined by listedKeywords().
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	setLaserEnergy(NumericProperty laserEnergy)
void	setPulseDescriptor(InstanceDescriptor<? extends PulseTemporalShape> shapeDescriptor)
void	setPulseShape(PulseTemporalShape pulseShape)
void	setPulseWidth(NumericProperty pulseWidth)
String	toString()

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

Pulse

public Pulse()

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

Pulse

public Pulse(Pulse p)

Copy constructor

Parameters:

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

Method Detail

initListeners

public void initListeners()

Overrides:

initListeners in class PropertyHolder

copy

public Pulse copy()

initFrom

public void initFrom(Pulse pulse)

getPulseWidth

public NumericProperty getPulseWidth()

setPulseWidth

public void setPulseWidth(NumericProperty pulseWidth)

getLaserEnergy

public NumericProperty getLaserEnergy()

setLaserEnergy

public void setLaserEnergy(NumericProperty laserEnergy)

toString

public String toString()

Overrides:

toString in class Object

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

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

Overrides:

listedKeywords in class PropertyHolder

Returns:

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

listedTypes

public List<Property> listedTypes()

Description copied from class: PropertyHolder

By default, collects a list of default properties corresponding to types defined by listedKeywords(). However, this method is overridable to include non-numeric properties.

Overrides:

listedTypes in class PropertyHolder

Returns:

a list of Property 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.

Specified by:

set in class Accessible

Parameters:

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

property - the property, which contains new information.

getPulseDescriptor

public InstanceDescriptor<? extends PulseTemporalShape> getPulseDescriptor()

setPulseDescriptor

public void setPulseDescriptor(InstanceDescriptor<? extends PulseTemporalShape> shapeDescriptor)

getPulseShape

public PulseTemporalShape getPulseShape()

setPulseShape

public void setPulseShape(PulseTemporalShape pulseShape)