brahms.communication
Class GetEnvelopePropertyActivity

java.lang.Object
  gov.nasa.arc.brahms.vm.api.jac.AbstractExternalActivity
      brahms.communication.GetCommunicativeActProperty
          brahms.communication.GetEnvelopePropertyActivity

All Implemented Interfaces:

IExternalActivity

public class GetEnvelopePropertyActivity
extends GetCommunicativeActProperty

The GetCommunicativeActProperty activity allows a model builder to retrieve the value of a property in the belief set of a communicative act by passing an unbound variable and having it be assigned the value of the property in the envelope map of the communicative act.

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

• CommunicativeAct communicativeAct (the communicative act from which to retrieve a property value)
• string key (the key for the property)
• an unbound variable

This activity will throw an ExternalException if:

• the value parameter is not an unbound variable.
• the type of the value keyed to the given key in the communicative acts belief set does not match the variable parameter type
• the communicative act has no belief in its envelope map for the given key.

Version:

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

Author:

Mike Scott

Field Summary

Fields inherited from class brahms.communication.GetCommunicativeActProperty

LOGGER

Constructor Summary

GetEnvelopePropertyActivity()

Method Summary

CommunicativeAct.MAP

getMap() Returns the CommunicativeAct.MAP constant indicating to which map the property being set belongs.

Methods inherited from class brahms.communication.GetCommunicativeActProperty

doActivity

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

Constructor Detail

GetEnvelopePropertyActivity

public GetEnvelopePropertyActivity()

Method Detail

getMap

public CommunicativeAct.MAP getMap()

Returns the CommunicativeAct.MAP constant indicating to which map the property being set belongs.

Specified by:

getMap in class GetCommunicativeActProperty

Returns:

MAP.ENVELOPE