triana.types

Class EmptyingType

java.lang.Object

triana.types.TrianaType

triana.types.EmptyingType

All Implemented Interfaces:

java.io.Serializable, SequenceInterface

public class EmptyingType
extends TrianaType

A EmptyingType is used by the monitor class to flush data out of the networks i.e. there maybe data to collect

See Also:

Serialized Form

Field Summary

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
EmptyingType()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyData(TrianaType source) Copies data held in dataContainer from the argument object to the current object.
TrianaType	copyMe() This is one of the most important methods of Triana data.

Methods inherited from class triana.types.TrianaType

containerSize, copyParameters, dataExists, deleteFromContainer, getDataContainer, getFromContainer, getSequenceNumber, insertIntoContainer, inspectDataContainer, setDataContainer, setSequenceNumber, updateObsoletePointers

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyingType

public EmptyingType()

Method Detail

copyMe

public TrianaType copyMe()

Description copied from class: TrianaType

This is one of the most important methods of Triana data. types. It returns a copy of the type invoking it. This must be overridden for every derived data type derived. If not, the data cannot be copied to be given to other units. Copying must be done by value, not by reference.

To override, the programmer should not invoke the super.copyMe method. Instead, create an object of the current type and call methods copyData and copyParameters. If these have been written correctly, then they will do the copying. The code should createTool, for type YourType:

 YourType y = null; try { y =
 (YourType)getClass().newInstance(); y.copyData( this ); y.copyParameters( this ); y.setLegend( this.getLegend()
 ); } catch (IllegalAccessException ee) { System.out.println("Illegal Access: " + ee.getMessage()); } catch
 (InstantiationException ee) { System.out.println("Couldn't be instantiated: " + ee.getMessage()); } return y;
 

The copied object's data should be identical to the original. The method here modifies only one item: a String indicating that the object was created as a copy is added to the description StringVector.

Specified by:

copyMe in class TrianaType

Returns:

a copy of a EmptyingType.

See Also:

TrianaType.copyMe()

copyData

protected void copyData(TrianaType source)

Description copied from class: TrianaType

Copies data held in dataContainer from the argument object to the current object. The copy must be by value, not by reference.

This method must be overridden if subclasses add more data to dataContainer, and the overriding method should invoke its super method. This method is called by copyMe().

Overrides:

copyData in class TrianaType

Parameters:

source - Object that contains the data to be copied.