brahms.base.util
Class AddTimeActivity

java.lang.Object
  gov.nasa.arc.brahms.vm.api.jac.AbstractExternalActivity
      brahms.base.util.AddTimeActivity

All Implemented Interfaces:

IExternalActivity

public class AddTimeActivity
extends AbstractExternalActivity

The AddTimeActivity allows a model builder to add time to a Calendar to determine the new date/time.

This activity requires four parameters in the Brahms java activity declaration:

• Calendar in (the Calendar from which to base the date/time).
• symbol field (the time field of to add the amount to)
• int amount (the amount of time to be added)
• Calendar out (the variable to assign the new Calendar with adjusted time to)

Version:

$Revision: 1.1 $ $Date: 2007/10/10 14:02:55 $ $Author: rvhoof $

Author:

Ron van Hoof

Field Summary

static java.lang.String[]

TIME_FIELDS Valid time fields

Constructor Summary

AddTimeActivity()

Method Summary

void	doActivity() Executes the java activity action.
protected int	validField(java.lang.String field) Verifies whether the specified field is a valid field.

Methods inherited from class gov.nasa.arc.brahms.vm.api.jac.AbstractExternalActivity

assertBelief, assertFact, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, getContext, getModel, getName, getParameter, getParameterCount, getPerformedBy, getVMController, getWorldState, isValidTruthValue, retractBelief, retractFact, send, send, send, send, setActivity, setProperties, toString

Methods inherited from class java.lang.Object

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

Field Detail

TIME_FIELDS

public static final java.lang.String[] TIME_FIELDS

Valid time fields

Constructor Detail

AddTimeActivity

public AddTimeActivity()

Method Detail

doActivity

public void doActivity()
                throws ExternalException

Executes the java activity action.

Specified by:

doActivity in interface IExternalActivity

Specified by:

doActivity in class AbstractExternalActivity

Throws:

ExternalException - if an unrecoverable error occurs.

validField

protected int validField(java.lang.String field)

Verifies whether the specified field is a valid field.

Parameters:

field - the field to be validated

Returns:

int a Java Calendar constant if valid, -1 if not valid.