pt.lsts.imc

Class PlanSpecification

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.PlanSpecification

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage

public class PlanSpecification
extends IMCMessage

IMC Message Plan Specification (551)
Identity and description of a plan's general parameters,
associated with plan loading (i.e. load plan command in
PlanCommand).
A plan specification is defined by a plan identifier, a set of
maneuver specifications and a start maneuver from that set.
See the PlanManeuver message for details on maneuver
specification.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
PlanSpecification()
PlanSpecification(IMCDefinition defs)
PlanSpecification(IMCMessage msg)
PlanSpecification(java.lang.String plan_id, java.lang.String description, java.lang.String vnamespace, java.util.Collection<PlanVariable> variables, java.lang.String start_man_id, java.util.Collection<PlanManeuver> maneuvers, java.util.Collection<PlanTransition> transitions, java.util.Collection<IMCMessage> start_actions, java.util.Collection<IMCMessage> end_actions)

Method Summary

Modifier and Type	Method and Description
static PlanSpecification	clone(IMCMessage msg)
static PlanSpecification	create(java.lang.Object... values)
java.lang.String	getDescription()
java.util.Vector<IMCMessage>	getEndActions()
java.util.Vector<PlanManeuver>	getManeuvers()
java.lang.String	getPlanId()
java.util.Vector<IMCMessage>	getStartActions()
java.lang.String	getStartManId()
java.util.Vector<PlanTransition>	getTransitions()
java.util.Vector<PlanVariable>	getVariables()
java.lang.String	getVnamespace()
PlanSpecification	setDescription(java.lang.String description)
PlanSpecification	setEndActions(java.util.Collection<IMCMessage> end_actions)
PlanSpecification	setManeuvers(java.util.Collection<PlanManeuver> maneuvers)
PlanSpecification	setPlanId(java.lang.String plan_id)
PlanSpecification	setStartActions(java.util.Collection<IMCMessage> start_actions)
PlanSpecification	setStartManId(java.lang.String start_man_id)
PlanSpecification	setTransitions(java.util.Collection<PlanTransition> transitions)
PlanSpecification	setVariables(java.util.Collection<PlanVariable> variables)
PlanSpecification	setVnamespace(java.lang.String vnamespace)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAgeInSeconds, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getEntityName, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, getMessageInfo, getMessageList, getMessageList, getMessageType, getMgid, getPayloadSize, getProtocolFactory, getRawData, getSize, getSourceName, getSrc, getSrcEnt, getString, getString, getTimestamp, getTimestampMillis, getTupleList, getTypeOf, getUnitsOf, getValue, getValues, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseJson, parseXml, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toString, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

PlanSpecification

public PlanSpecification()

PlanSpecification

public PlanSpecification(IMCMessage msg)

PlanSpecification

public PlanSpecification(IMCDefinition defs)

PlanSpecification

public PlanSpecification(java.lang.String plan_id,
                         java.lang.String description,
                         java.lang.String vnamespace,
                         java.util.Collection<PlanVariable> variables,
                         java.lang.String start_man_id,
                         java.util.Collection<PlanManeuver> maneuvers,
                         java.util.Collection<PlanTransition> transitions,
                         java.util.Collection<IMCMessage> start_actions,
                         java.util.Collection<IMCMessage> end_actions)

Method Detail

create

public static PlanSpecification create(java.lang.Object... values)

clone

public static PlanSpecification clone(IMCMessage msg)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getPlanId

public java.lang.String getPlanId()

Returns:

Plan ID - plaintext

setPlanId

public PlanSpecification setPlanId(java.lang.String plan_id)

Parameters:

plan_id - Plan ID

getDescription

public java.lang.String getDescription()

Returns:

Plan Description - plaintext

setDescription

public PlanSpecification setDescription(java.lang.String description)

Parameters:

description - Plan Description

getVnamespace

public java.lang.String getVnamespace()

Returns:

Namespace - plaintext

setVnamespace

public PlanSpecification setVnamespace(java.lang.String vnamespace)

Parameters:

vnamespace - Namespace

getVariables

public java.util.Vector<PlanVariable> getVariables()

Returns:

Plan Variables - message-list

setVariables

public PlanSpecification setVariables(java.util.Collection<PlanVariable> variables)

Parameters:

variables - Plan Variables

getStartManId

public java.lang.String getStartManId()

Returns:

Starting maneuver - plaintext

setStartManId

public PlanSpecification setStartManId(java.lang.String start_man_id)

Parameters:

start_man_id - Starting maneuver

getManeuvers

public java.util.Vector<PlanManeuver> getManeuvers()

Returns:

Maneuvers - message-list

setManeuvers

public PlanSpecification setManeuvers(java.util.Collection<PlanManeuver> maneuvers)

Parameters:

maneuvers - Maneuvers

getTransitions

public java.util.Vector<PlanTransition> getTransitions()

Returns:

Transitions - message-list

setTransitions

public PlanSpecification setTransitions(java.util.Collection<PlanTransition> transitions)

Parameters:

transitions - Transitions

getStartActions

public java.util.Vector<IMCMessage> getStartActions()

Returns:

Start Actions - message-list

setStartActions

public PlanSpecification setStartActions(java.util.Collection<IMCMessage> start_actions)

Parameters:

start_actions - Start Actions

getEndActions

public java.util.Vector<IMCMessage> getEndActions()

Returns:

End Actions - message-list

setEndActions

public PlanSpecification setEndActions(java.util.Collection<IMCMessage> end_actions)

Parameters:

end_actions - End Actions