brahms.base.system
Class PrintlnActivity

java.lang.Object
  gov.nasa.arc.brahms.vm.api.jac.AbstractExternalActivity
      brahms.base.system.PrintlnActivity

All Implemented Interfaces:

IExternalActivity

public class PrintlnActivity
extends AbstractExternalActivity

The PrintlnActivity allows a model builder to print a string to the virtual machine's log file as an info message. This activity supports an endless list of parameters that can be inserted in the string in the positions that start with a percentage symbol followed by a numeric value. The parameter names must start with 'p' followed by the numeric value for the variable in the string.

This activity requires one or more parameters in the Brahms java activity declaration:

• string message (the message string)
• p (a parameter for which its value is to be used in place of a variable in the message string that is marked by a percentage sign followed by the same number as the parameter number. The parameter names must be numbered sequentially starting with 1.
• string out (the variable in which to store the output string)

The out parameter is optional and can be used to store the results of the message string with its arguments inserted in the message string in the unbound variable specified for the out parameter. This will return the string instead of writing the results to the log file.

Examples of the use of this activity as used in the body of a workframe are:

• println("My message");
• println_c("Agent %1 is executing MyActivity", current);
• println_cn("Agent %1 is executing MyActivity with duration %2", current, 10);
• println_cno("Agent %1 is executing MyActivity with duration %2", current, 10, out);

The activities as shown in the examples above would have to be declared as:

• java println(string message) { class: "brahms.base.system.PrintlnActivity"; }
• java println_c(string message, Concept p1) { class: "brahms.base.system.PrintlnActivity"; }
• java println_cn(string message, Concept p1, int p2) { class: "brahms.base.system.PrintlnActivity"; }
• java println_cno(string message, Concept p1, int p2, string out) { class: "brahms.base.system.PrintlnActivity"; }

When a Concept is printed its fully qualified name is printed. When a variable is printed all of its binding values are printed in a comma delimited list. If a variable's binding is empty, null is printed.

Version:

$Revision: 1.4 $ $Date: 2009/11/29 21:52:52 $ $Author: rnado $

Author:

Ron van Hoof

Constructor Summary

PrintlnActivity()

Method Summary

void	doActivity() Executes the java activity action.

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

addBeliefRelationConcept, addFactRelationConcept, 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, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, conclude, convertCurrent, getBeliefAttributeBoolean, getBeliefAttributeBoolean, getBeliefAttributeBoolean, getBeliefAttributeByte, getBeliefAttributeByte, getBeliefAttributeByte, getBeliefAttributeChar, getBeliefAttributeChar, getBeliefAttributeChar, getBeliefAttributeConcept, getBeliefAttributeConcept, getBeliefAttributeConcept, getBeliefAttributeDouble, getBeliefAttributeDouble, getBeliefAttributeDouble, getBeliefAttributeFloat, getBeliefAttributeFloat, getBeliefAttributeFloat, getBeliefAttributeInt, getBeliefAttributeInt, getBeliefAttributeInt, getBeliefAttributeJava, getBeliefAttributeJava, getBeliefAttributeJava, getBeliefAttributeLong, getBeliefAttributeLong, getBeliefAttributeLong, getBeliefAttributeMap, getBeliefAttributeShort, getBeliefAttributeShort, getBeliefAttributeShort, getBeliefAttributeSortedMap, getBeliefAttributeString, getBeliefAttributeString, getBeliefAttributeString, getBeliefAttributeValue, getBeliefAttributeValue, getBeliefAttributeValue, getBeliefRelationConcepts, getContext, getFactAttributeBoolean, getFactAttributeBoolean, getFactAttributeBoolean, getFactAttributeByte, getFactAttributeByte, getFactAttributeByte, getFactAttributeChar, getFactAttributeChar, getFactAttributeChar, getFactAttributeConcept, getFactAttributeConcept, getFactAttributeConcept, getFactAttributeDouble, getFactAttributeDouble, getFactAttributeDouble, getFactAttributeFloat, getFactAttributeFloat, getFactAttributeFloat, getFactAttributeInt, getFactAttributeInt, getFactAttributeInt, getFactAttributeJava, getFactAttributeJava, getFactAttributeJava, getFactAttributeLong, getFactAttributeLong, getFactAttributeLong, getFactAttributeMap, getFactAttributeShort, getFactAttributeShort, getFactAttributeShort, getFactAttributeSortedMap, getFactAttributeString, getFactAttributeString, getFactAttributeString, getFactAttributeValue, getFactAttributeValue, getFactAttributeValue, getFactRelationConcepts, getModel, getName, getParameter, getParameterBoolean, getParameterByte, getParameterChar, getParameterConcept, getParameterCount, getParameterDouble, getParameterFloat, getParameterInt, getParameterJava, getParameterLong, getParameterShort, getParameterString, getParameterStringOrSymbol, getParameterSymbol, getParameterValue, getParameterValues, getPerformedBy, getVMController, getWorldState, hasBeliefAttributeAnyValue, hasBeliefAttributeAnyValue, hasBeliefAttributeAnyValue, hasBeliefAttributeValue, hasBeliefAttributeValue, hasBeliefAttributeValue, hasBeliefRelationAnyValue, hasBeliefRelationValue, hasFactAttributeAnyValue, hasFactAttributeAnyValue, hasFactAttributeAnyValue, hasFactAttributeValue, hasFactAttributeValue, hasFactAttributeValue, hasFactRelationAnyValue, hasFactRelationValue, hasMultipleParameterValues, isParameterUnbound, isParameterUnknown, isValidTruthValue, removeAllBeliefRelationValues, removeAllFactRelationValues, removeBeliefRelationConcept, removeFactRelationConcept, retractBelief, retractFact, send, send, send, send, setActivity, setBeliefAttributeBoolean, setBeliefAttributeBoolean, setBeliefAttributeBoolean, setBeliefAttributeByte, setBeliefAttributeByte, setBeliefAttributeByte, setBeliefAttributeChar, setBeliefAttributeChar, setBeliefAttributeChar, setBeliefAttributeConcept, setBeliefAttributeConcept, setBeliefAttributeConcept, setBeliefAttributeDouble, setBeliefAttributeDouble, setBeliefAttributeDouble, setBeliefAttributeFloat, setBeliefAttributeFloat, setBeliefAttributeFloat, setBeliefAttributeInt, setBeliefAttributeInt, setBeliefAttributeInt, setBeliefAttributeJava, setBeliefAttributeJava, setBeliefAttributeJava, setBeliefAttributeJava, setBeliefAttributeJava, setBeliefAttributeJava, setBeliefAttributeLong, setBeliefAttributeLong, setBeliefAttributeLong, setBeliefAttributeShort, setBeliefAttributeShort, setBeliefAttributeShort, setBeliefAttributeString, setBeliefAttributeString, setBeliefAttributeString, setBeliefAttributeSymbol, setBeliefAttributeSymbol, setBeliefAttributeSymbol, setBeliefAttributeUnknown, setBeliefAttributeUnknown, setBeliefAttributeUnknown, setBeliefRelationUnknown, setFactAttributeBoolean, setFactAttributeBoolean, setFactAttributeBoolean, setFactAttributeByte, setFactAttributeByte, setFactAttributeByte, setFactAttributeChar, setFactAttributeChar, setFactAttributeChar, setFactAttributeConcept, setFactAttributeConcept, setFactAttributeConcept, setFactAttributeDouble, setFactAttributeDouble, setFactAttributeDouble, setFactAttributeFloat, setFactAttributeFloat, setFactAttributeFloat, setFactAttributeInt, setFactAttributeInt, setFactAttributeInt, setFactAttributeJava, setFactAttributeJava, setFactAttributeJava, setFactAttributeJava, setFactAttributeJava, setFactAttributeJava, setFactAttributeLong, setFactAttributeLong, setFactAttributeLong, setFactAttributeShort, setFactAttributeShort, setFactAttributeShort, setFactAttributeString, setFactAttributeString, setFactAttributeString, setFactAttributeSymbol, setFactAttributeSymbol, setFactAttributeSymbol, setFactAttributeUnknown, setFactAttributeUnknown, setFactAttributeUnknown, setFactRelationUnknown, setParameterBoolean, setParameterByte, setParameterChar, setParameterConcept, setParameterDouble, setParameterFloat, setParameterInt, setParameterJava, setParameterJava, setParameterLong, setParameterShort, setParameterString, setParameterUnknown, setProperties, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintlnActivity

public PrintlnActivity()

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.