zeus.concepts
Class Goal

java.lang.Object
  zeus.concepts.Goal

public class Goal

extends java.lang.Object

The Goal class is an important agent-level conceptual data structure. Goals describe objectives, namely the achievement of the Fact object that it contains, subject to the constraints that are its other variables.

This class contains many methods that allow the attributes of goal objects to be set and modified, although typically developers will only call one of the constructors.

Field Summary

protected Time	confirmTime
protected java.util.Vector	consumer_records
protected ResolutionContext	context
static boolean	CONTINUOUS
protected double	cost
static int	DEFAULT_PRIORITY
protected java.lang.String	desired_by
static boolean	DISCRETE
protected int	end_time
protected Fact	fact The fact description whose achievement is the objective of the goal
protected SuppliedDb	given
protected java.lang.String	id
protected java.lang.String	image
protected int	invocations
static int	MAX_PRIORITY
protected java.lang.String[]	media
static int	MIN_PRIORITY
protected int	priority
protected java.util.Vector	producer_records
protected Time	replyTime
protected java.lang.String	root_id
protected int	start_time
protected boolean	type
protected java.lang.Object	user_data
protected java.lang.String	user_data_type

Constructor Summary

Goal(boolean type, java.lang.String id, Fact fact, java.lang.String desired_by)

Goal(Goal goal)

Goal(java.lang.String id, Fact fact, int time, double cost, int priority, java.lang.String agent, Time replyTime, Time confirmTime)

Goal(java.lang.String id, Fact fact, int end_time, double cost, java.lang.String agent, double confirm)

Goal(java.lang.String id, Fact fact, int startTime, int endTime, double cost, int priority, int invocations, java.lang.String agent, Time replyTime, Time confirmTime)

Method Summary

void	addConsumer(ConsumerRecord entry)
void	addConsumer(java.lang.String producer, java.lang.String producer_id, java.lang.String consumer, java.lang.String consumer_id, java.lang.String use_ref, java.lang.String comms_key, int start, int amount, boolean consumed)
void	addProducer(ProducerRecord entry)
void	addProducer(java.lang.String supply_ref, java.lang.String use_ref, java.lang.String comms_key, java.lang.String producer, java.lang.String producer_id, java.lang.String consumer, java.lang.String consumer_id)
boolean	constrain(Bindings bindings)
Goal	duplicate(DuplicationTable table)
Goal	duplicate(java.lang.String name, GenSym genSym)
boolean	equals(Goal goal)
AbilitySpec	getAbility()
Time	getConfirmTime()
java.util.Vector	getConsumerRecords()
double	getCost()
java.lang.String	getDesiredBy()
int	getEndTime()
Fact	getFact()
java.lang.String	getFactId()
java.lang.String	getFactType()
java.lang.String	getId()
java.lang.String	getImage()
int	getInvocations()
int	getPriority()
java.util.Vector	getProducerRecords()
Time	getReplyTime()
ResolutionContext	getResolutionContext()
java.lang.String	getRootId()
int	getStartTime()
SuppliedDb	getSuppliedDb()
java.lang.String[]	getTargetMedia()
java.lang.String	getType()
java.lang.Object	getUserData()
java.lang.String	getUserDataType()
boolean	isContinuous()
boolean	isDiscrete()
void	setConfirmTime(double value)
void	setConfirmTime(Time value)
void	setConsumerRecords(java.util.Vector records)
void	setCost(double cost)
void	setDesiredBy(java.lang.String person)
void	setEndTime(int time)
void	setFact(Fact fact)
void	setFactType(java.lang.String type)
void	setId(java.lang.String id)
void	setImage(java.lang.String image)
void	setInvocations(int invocations)
void	setPriority(int priority)
void	setProducerRecords(java.util.Vector records)
void	setReplyTime(double value)
void	setReplyTime(Time value)
void	setResolutionContext(ResolutionContext context)
void	setRootId(java.lang.String rootId)
void	setStartTime(int time)
void	setSuppliedDb(SuppliedDb given)
void	setTargetMedia(java.lang.String[] media)
void	setUserData(java.lang.Object data)
void	setUserDataType(java.lang.String data_type)
java.lang.String	toSL()
java.lang.String	toString()
boolean	whichType()

Methods inherited from class java.lang.Object

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

Field Detail

DISCRETE

public static final boolean DISCRETE

See Also:

Constant Field Values

CONTINUOUS

public static final boolean CONTINUOUS

See Also:

Constant Field Values

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

MIN_PRIORITY

public static final int MIN_PRIORITY

See Also:

Constant Field Values

MAX_PRIORITY

public static final int MAX_PRIORITY

See Also:

Constant Field Values

fact

protected Fact fact

The fact description whose achievement is the objective of the goal

start_time

protected int start_time

end_time

protected int end_time

cost

protected double cost

invocations

protected int invocations

type

protected boolean type

priority

protected int priority

id

protected java.lang.String id

image

protected java.lang.String image

desired_by

protected java.lang.String desired_by

root_id

protected java.lang.String root_id

media

protected java.lang.String[] media

replyTime

protected Time replyTime

confirmTime

protected Time confirmTime

user_data_type

protected java.lang.String user_data_type

user_data

protected java.lang.Object user_data

context

protected ResolutionContext context

given

protected SuppliedDb given

producer_records

protected java.util.Vector producer_records

consumer_records

protected java.util.Vector consumer_records

Constructor Detail

Goal

public Goal(boolean type,
            java.lang.String id,
            Fact fact,
            java.lang.String desired_by)

Goal

public Goal(java.lang.String id,
            Fact fact,
            int end_time,
            double cost,
            java.lang.String agent,
            double confirm)

Goal

public Goal(java.lang.String id,
            Fact fact,
            int time,
            double cost,
            int priority,
            java.lang.String agent,
            Time replyTime,
            Time confirmTime)

Goal

public Goal(java.lang.String id,
            Fact fact,
            int startTime,
            int endTime,
            double cost,
            int priority,
            int invocations,
            java.lang.String agent,
            Time replyTime,
            Time confirmTime)

Goal

public Goal(Goal goal)

Method Detail

duplicate

public Goal duplicate(java.lang.String name,
                      GenSym genSym)

duplicate

public Goal duplicate(DuplicationTable table)

getType

public java.lang.String getType()

whichType

public boolean whichType()

setId

public void setId(java.lang.String id)

getId

public java.lang.String getId()

getImage

public java.lang.String getImage()

getFact

public Fact getFact()

getFactType

public java.lang.String getFactType()

getFactId

public java.lang.String getFactId()

getEndTime

public int getEndTime()

getCost

public double getCost()

getPriority

public int getPriority()

getDesiredBy

public java.lang.String getDesiredBy()

getUserDataType

public java.lang.String getUserDataType()

getUserData

public java.lang.Object getUserData()

isDiscrete

public boolean isDiscrete()

isContinuous

public boolean isContinuous()

setProducerRecords

public void setProducerRecords(java.util.Vector records)

setConsumerRecords

public void setConsumerRecords(java.util.Vector records)

addProducer

public void addProducer(java.lang.String supply_ref,
                        java.lang.String use_ref,
                        java.lang.String comms_key,
                        java.lang.String producer,
                        java.lang.String producer_id,
                        java.lang.String consumer,
                        java.lang.String consumer_id)

addProducer

public void addProducer(ProducerRecord entry)

addConsumer

public void addConsumer(java.lang.String producer,
                        java.lang.String producer_id,
                        java.lang.String consumer,
                        java.lang.String consumer_id,
                        java.lang.String use_ref,
                        java.lang.String comms_key,
                        int start,
                        int amount,
                        boolean consumed)

addConsumer

public void addConsumer(ConsumerRecord entry)

setSuppliedDb

public void setSuppliedDb(SuppliedDb given)

setResolutionContext

public void setResolutionContext(ResolutionContext context)

setUserDataType

public void setUserDataType(java.lang.String data_type)

setUserData

public void setUserData(java.lang.Object data)

setImage

public void setImage(java.lang.String image)

setFact

public void setFact(Fact fact)

setFactType

public void setFactType(java.lang.String type)

setStartTime

public void setStartTime(int time)

setInvocations

public void setInvocations(int invocations)

setEndTime

public void setEndTime(int time)

setCost

public void setCost(double cost)

setPriority

public void setPriority(int priority)

setDesiredBy

public void setDesiredBy(java.lang.String person)

getProducerRecords

public java.util.Vector getProducerRecords()

getConsumerRecords

public java.util.Vector getConsumerRecords()

getSuppliedDb

public SuppliedDb getSuppliedDb()

getResolutionContext

public ResolutionContext getResolutionContext()

getStartTime

public int getStartTime()

getInvocations

public int getInvocations()

getRootId

public java.lang.String getRootId()

setRootId

public void setRootId(java.lang.String rootId)

setTargetMedia

public void setTargetMedia(java.lang.String[] media)

setReplyTime

public void setReplyTime(Time value)

setConfirmTime

public void setConfirmTime(Time value)

setReplyTime

public void setReplyTime(double value)

setConfirmTime

public void setConfirmTime(double value)

getReplyTime

public Time getReplyTime()

getConfirmTime

public Time getConfirmTime()

getTargetMedia

public java.lang.String[] getTargetMedia()

getAbility

public AbilitySpec getAbility()

constrain

public boolean constrain(Bindings bindings)

equals

public boolean equals(Goal goal)

toSL

public java.lang.String toSL()

toString

public java.lang.String toString()