Package pulse.problem.laser

Class TrapezoidalPulse

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.laser.PulseTemporalShape

pulse.problem.laser.TrapezoidalPulse

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

public class TrapezoidalPulse
extends PulseTemporalShape

A trapezoidal pulse shape, which combines a rise segment, a constant-power segment, and a fall segment. The rise and fall ratios can be changed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TrapezoidalPulse()	Constructs a trapezoidal pulse using a default segmentation principle.
TrapezoidalPulse(TrapezoidalPulse another)

Method Summary

Modifier and Type	Method	Description
PulseTemporalShape	copy()
double	evaluateAt(double time)	Calculates power using a piecewise function, which corresponds to either a linearly changing, a constant laser power or zero.
int	getRequiredDiscretisation()
NumericProperty	getTrapezoidalFall()
NumericProperty	getTrapezoidalRise()
Set<NumericPropertyKeyword>	listedKeywords()	By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.
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	setTrapezoidalFall(NumericProperty p)
void	setTrapezoidalRise(NumericProperty p)

Methods inherited from class pulse.problem.laser.PulseTemporalShape

getPrefix, getPulseWidth, init, setPulseWidth, toString

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getDescriptor, getListeners, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, listedTypes, 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

TrapezoidalPulse

public TrapezoidalPulse()

Constructs a trapezoidal pulse using a default segmentation principle. The reader is referred to the .xml file containing the default values of TRAPEZOIDAL_RISE_PERCENTAGE and TRAPEZOIDAL_FALL_PERCENTAGE. The maximum laser power is adjusted to ensure the area of the shape is equal to unity.

TrapezoidalPulse

public TrapezoidalPulse(TrapezoidalPulse another)

Method Detail

evaluateAt

public double evaluateAt(double time)

Calculates power using a piecewise function, which corresponds to either a linearly changing, a constant laser power or zero.

Specified by:

evaluateAt in class PulseTemporalShape

Parameters:

time - the time measured from the start of the laser pulse.

Returns:

a double value, representing the pulse function at time

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: PropertyHolder

By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.

Overrides:

listedKeywords in class PropertyHolder

Returns:

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

getTrapezoidalRise

public NumericProperty getTrapezoidalRise()

getTrapezoidalFall

public NumericProperty getTrapezoidalFall()

setTrapezoidalRise

public void setTrapezoidalRise(NumericProperty p)

setTrapezoidalFall

public void setTrapezoidalFall(NumericProperty p)

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.

copy

public PulseTemporalShape copy()

Specified by:

copy in class PulseTemporalShape

getRequiredDiscretisation

public int getRequiredDiscretisation()

Specified by:

getRequiredDiscretisation in class PulseTemporalShape