ACRUSalinity.Processes.ChannelSaltMovement
Class PChannelSaltMovement

java.lang.Object
  ACRU.Components.CNode
      ACRU.Processes.PProcess
          ACRUSalinity.Processes.ChannelSaltMovement.PChannelSaltMovement

All Implemented Interfaces:

ACRU.Interfaces.ISaltFlow

Direct Known Subclasses:

PCatchmentSalinity

public abstract class PChannelSaltMovement

extends ACRU.Processes.PProcess

implements ACRU.Interfaces.ISaltFlow

This super class has got methods that assist during the transport of salt from one component to another.

Author:

Aynom Teweldebrhan

Field Summary

Fields inherited from class ACRU.Processes.PProcess

CURRENT_DATE, END_SIMULATION_DATE, initialised, START_SIMULATION_DATE

Fields inherited from class ACRU.Components.CNode

Constructor Summary

PChannelSaltMovement()

Method Summary

abstract void	flowSalt() The method in which the salt flow behaviour is implemented .
void	runProcess() This is a general method used to "run" every process.
void	transportSalt(java.lang.Class saltFluxRecordClass, ACRU.Components.CComponent saltSource, double quantity, ACRU.Components.CComponent saltDestination) Transports a specified quantity of salt from a source to a destination component.

Methods inherited from class ACRU.Processes.PProcess

initialise, isInitialised, setCurrentDate, setEndDate, setStartDate, toString

Methods inherited from class ACRU.Components.CNode

getNext, getNext, getNext, getNext, getNextCount, getNextCount, getNexts, getNexts, getTypeOfNexts, getTypeOfNexts, setNext, setNext, setNext, setNext, setNext, setNexts, setNexts, setNexts

Methods inherited from class java.lang.Object

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

Constructor Detail

PChannelSaltMovement

public PChannelSaltMovement()

Method Detail

runProcess

public void runProcess()
                throws java.lang.Exception,
                       ACRU.Exceptions.EException

Description copied from class: ACRU.Processes.PProcess

This is a general method used to "run" every process.

This method acts as an adaptor and usually calls other methods.

This abstract method must be implemented by all non-abstract subclasses of PProcess.

Throws:

ACRU.Exceptions.EException - EExceptions not dealt with internally.

java.lang.Exception - Exceptions not dealt with internally.

flowSalt

public abstract void flowSalt()
                       throws java.lang.Exception,
                              ACRU.Exceptions.EException

Description copied from interface: ACRU.Interfaces.ISaltFlow

The method in which the salt flow behaviour is implemented .

Specified by:

flowSalt in interface ACRU.Interfaces.ISaltFlow

Throws:

java.lang.Exception

ACRU.Exceptions.EException

transportSalt

public void transportSalt(java.lang.Class saltFluxRecordClass,
                          ACRU.Components.CComponent saltSource,
                          double quantity,
                          ACRU.Components.CComponent saltDestination)
                   throws java.lang.Exception,
                          ACRU.Exceptions.EException,
                          ACRU.Exceptions.ENullFoundException

Transports a specified quantity of salt from a source to a destination component.

Throws:

java.lang.Exception

ACRU.Exceptions.EException

ACRU.Exceptions.ENullFoundException