com.luciad.realtime

LuciadFusionClass TLcdTimeFilteredSimulatorModel

java.lang.Object

com.luciad.realtime.TLcdTimeFilteredSimulatorModel

All Implemented Interfaces:

ILcdSimulatorModel, ILcdPropertyChangeSource

public class TLcdTimeFilteredSimulatorModel
extends Object
implements ILcdSimulatorModel

Decorator for an ILcdSimulatorModel which allows to limit the exposed available time interval of the ILcdSimulatorModel.

Graphically, it can be seen as (where I stands for the inner ILcdSimulatorModel and O for the outer):

   |            |               |                |                    |
   | -----------|---------------|----------------|--------------------|
   |            |               |                |                    |
 I#getBeginDate             I#getDate                              I#getEndDate
         O#getBeginDate     O#getDate        O#getEndDate
 

The setFilterBeginDate and setFilterEndDate methods allow to specify where the begin date and end date of this ILcdSimulatorModel are located. They must be in the valid interval of the inner simulator model, or they will be adjusted when invalid.

Constructor Summary

Constructors

Constructor and Description
TLcdTimeFilteredSimulatorModel()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener l) Registers the given PropertyChangeListener to be notified when this object's properties change.
Date	getBeginDate() Returns the begin Date of the simulation.
Date	getDate() Gets the Date corresponding to the current state of the domain objects (tracks) this ILcdSimulatorModel contains.
Date	getEndDate() Returns the end Date of the simulation.
ILcdSimulatorModel	getSimulatorModelToFilterOnTime() Returns the ILcdSimulatorModel currently being filtered.
ILcdModel[]	getTrackModels() Returns the array of ILcdModels holding the simulated domain data.
void	removePropertyChangeListener(PropertyChangeListener l) De-registers the given PropertyChangeListener from receiving property change events for this object.
void	setBeginDate(Date aBeginDate) Sets the begin date to consider.
void	setDate(Date aDate) Asks this ILcdSimulatorModel to update the domain objects (tracks) of the simulation it contains, in order to be in the state in which they were or should be at the given Date.
void	setEndDate(Date aEndDate) Sets the end date to consider.
void	setSimulatorModelToFilterOnTime(ILcdSimulatorModel aSimulatorModelToFilterOnTime) Sets the ILcdSimulatorModel to filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdTimeFilteredSimulatorModel

public TLcdTimeFilteredSimulatorModel()

Method Detail

setSimulatorModelToFilterOnTime

public void setSimulatorModelToFilterOnTime(ILcdSimulatorModel aSimulatorModelToFilterOnTime)

Sets the ILcdSimulatorModel to filter.

Parameters:

aSimulatorModelToFilterOnTime - The ILcdSimulatorModel to filter.

See Also:

getSimulatorModelToFilterOnTime()

getSimulatorModelToFilterOnTime

public ILcdSimulatorModel getSimulatorModelToFilterOnTime()

Returns the ILcdSimulatorModel currently being filtered.

Returns:

The ILcdSimulatorModel currently being filtered.

See Also:

setSimulatorModelToFilterOnTime(ILcdSimulatorModel)

getTrackModels

public ILcdModel[] getTrackModels()

Description copied from interface: ILcdSimulatorModel

Returns the array of ILcdModels holding the simulated domain data. The state of the domain objects in these models is updated when setDate is called.

A property change event must be fired whenever the return value of this method changes.

Specified by:

getTrackModels in interface ILcdSimulatorModel

Returns:

The array of ILcdModels holding the simulated domain data. This must not be null.

See Also:

ILcdSimulatorModel.setDate(java.util.Date)

setBeginDate

public void setBeginDate(Date aBeginDate)

Sets the begin date to consider. The begin date shall be after the begin date of the wrapped ILcdSimulatorModel.

Parameters:

aBeginDate - The begin date to set.

See Also:

getBeginDate()

setEndDate

public void setEndDate(Date aEndDate)

Sets the end date to consider. The end date shall be before the end date of the wrapped ILcdSimulatorModel.

Parameters:

aEndDate - The end date to set.

See Also:

getEndDate()

setDate

public void setDate(Date aDate)

Description copied from interface: ILcdSimulatorModel

Asks this ILcdSimulatorModel to update the domain objects (tracks) of the simulation it contains, in order to be in the state in which they were or should be at the given Date. This state might include location, feature values, etc.

The TLcdSimulator always calls this method on the AWT Event Dispatch Thread

Implementations of this method should respect the threading rules of LuciadLightspeed. Specifically, implementations should take a write lock on the track models they update when creating a multithreaded application.

Specified by:

setDate in interface ILcdSimulatorModel

Parameters:

aDate - The Date to update to. This is never null.

See Also:

ILcdSimulatorModel.getTrackModels(), ILcdSimulatorModel.getDate(), TLcdLockUtil.writeLock(Object)

getDate

public Date getDate()

Description copied from interface: ILcdSimulatorModel

Gets the Date corresponding to the current state of the domain objects (tracks) this ILcdSimulatorModel contains.

Specified by:

getDate in interface ILcdSimulatorModel

Returns:

The Date of the current state.

See Also:

ILcdSimulatorModel.setDate(Date)

getBeginDate

public Date getBeginDate()

Description copied from interface: ILcdSimulatorModel

Returns the begin Date of the simulation.

A property change event must be fired whenever the return value of this method changes.

Specified by:

getBeginDate in interface ILcdSimulatorModel

Returns:

The begin Date of the simulation. This must not be null.

getEndDate

public Date getEndDate()

Description copied from interface: ILcdSimulatorModel

Returns the end Date of the simulation.

A property change event must be fired whenever the return value of this method changes.

Specified by:

getEndDate in interface ILcdSimulatorModel

Returns:

The end Date of the simulation. This must not be null.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: ILcdPropertyChangeSource

Registers the given PropertyChangeListener to be notified when this object's properties change.

In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a ALcdWeakPropertyChangeListener instance as property change listener.

Specified by:

addPropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

l - The listener to be notified

See Also:

ALcdWeakPropertyChangeListener, ILcdPropertyChangeSource.removePropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Description copied from interface: ILcdPropertyChangeSource

De-registers the given PropertyChangeListener from receiving property change events for this object.

If the listener was added more than once, it will be notified one less time after being removed. If the listener is null, or was never added, no exception is thrown and no action is taken.

Specified by:

removePropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

l - the listener that should no longer be notified of changes of this object's properties

See Also:

ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)