com.luciad.fusion.engine.replication

Tiling EngineClass TLfnReplicationAreaOfInterest

java.lang.Object

com.luciad.fusion.engine.replication.TLfnReplicationAreaOfInterest

All Implemented Interfaces:

ILcdInvalidateable

public final class TLfnReplicationAreaOfInterest
extends Object
implements ILcdInvalidateable

Class representing a replication area of interest, used to limit the replicated data to a geographic region. Consult the class javadoc of TLfnReplication for more information.

Since:

2015.0

Method Summary

Modifier and Type	Method and Description
ILcdGeoReference	getGeoReference() Returns the geo reference in which the shape of the area is defined.
String	getName() Returns the name of this area
ILcdShape	getShape() Returns the shape of this area.
void	invalidateObject() This method must be called each time a change has been made to the getShape() or the getGeoReference() of this area.
void	setName(String aName) Sets the name of this area
void	setShape(ILcdShape aShape, ILcdGeoReference aGeoReference) Sets the shape of this area.

Methods inherited from class java.lang.Object

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

Method Detail

getShape

public ILcdShape getShape()

Returns the shape of this area.

Warning: if you make modifications to the returned ILcdShape instance, you must call invalidateObject(). Forgetting to do this will result in undefined behavior. The changes may or may not be picked up correctly.

Returns:

The shape of this area.

getGeoReference

public ILcdGeoReference getGeoReference()

Returns the geo reference in which the shape of the area is defined.

Warning: if you make modifications to the returned ILcdGeoReference instance, you must call invalidateObject(). Forgetting to do this will result in undefined behavior. The changes may or may not be picked up correctly.

Returns:

the geo reference in which the shape of the area is defined.

getName

public String getName()

Returns the name of this area

Returns:

the name of this area

setName

public void setName(String aName)

Sets the name of this area

Parameters:

aName - the new name for this area

setShape

public void setShape(ILcdShape aShape,
                     ILcdGeoReference aGeoReference)

Sets the shape of this area. The change of this area will affect all resources using this area for replication.

Warning: changes made to the aShape or aGeoReference instances after this method has been called will only be picked up correctly if the invalidateObject() method is called after making the changes. Forgetting to do this will result in undefined behavior. The changes may or may not be picked up correctly.

The following snippet illustrates how to correctly update the shape:

     AreaOfInterest area = ...;
     ILcdShape shape = ...;
     ILcdGeoReference ref = ...;

     area.setShape( shape, ref );

     // Make some external changes, e.g. using a TLspEditController
     modifyShape( shape );

     // Inform the AreaOfInterest instance about those changes
     area.invalidateObject();
   

Parameters:

aShape - The shape

aGeoReference - The geo reference in which the shape is defined. Currently, only WGS 84 is supported.

invalidateObject

public void invalidateObject()

This method must be called each time a change has been made to the getShape() or the getGeoReference() of this area. Forgetting to do this will result in undefined behavior. The changes may or may not be picked up correctly.

Specified by:

invalidateObject in interface ILcdInvalidateable