SaveStateReq (UnetStack 3.4.0 API)

Summary:
Field
Property
Constructor
Method

org.arl.unet.state.SaveStateReq

Request message for storing the current state of agent(s).

Field Summary

Fields
Modifiers	Name	Description
`protected AgentID`	`agentID`
`protected List<Parameter>`	`ignore`
`protected String`	`stateName`

Properties Summary

Properties
Type	Name and description
`AgentID`	`agentID`
`List<Parameter>`	`ignore`
`String`	`stateName`

Constructor Summary

Constructors
Constructor and description
`SaveStateReq ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`AgentID`	`getAgentID()` Gets the agent ID.
	`List<Parameter>`	`getIgnore()` Gets the ignored parameters list.
	`String`	`getStateName()` Gets the state name.
	`void`	`setAgentID(AgentID agentID)` Sets the Agent ID.
	`void`	`setIgnore(List<Parameter> ignoreList)` Sets the parameters to be ignored from persisting.
	`void`	`setStateName(String stateName)` Sets the state name.
	`String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Message`	`setPerformative, toString, getSender, setMessageID, getSentAt, setRecipient, getInReplyTo, setSentAt, setSender, getPerformative, getRecipient, getMessageID, setInReplyTo, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected AgentID agentID
  - protected List<Parameter> ignore
  - protected String stateName
- Property Detail
  - AgentID agentID
  - List<Parameter> ignore
  - String stateName
- Constructor Detail
  - public SaveStateReq()
- Method Detail
  - public AgentID getAgentID()
    
    Gets the agent ID.
    Returns:
    AgentID
  - public List<Parameter> getIgnore()
    
    Gets the ignored parameters list.
    Returns:
    ignored parameters list
  - public String getStateName()
    
    Gets the state name.
    Returns:
    state name
  - public void setAgentID(AgentID agentID)
    
    Sets the Agent ID.
    Parameters:
    agentID - agent ID
  - public void setIgnore(List<Parameter> ignoreList)
    
    Sets the parameters to be ignored from persisting.
    Parameters:
    ignoreList - list of ignored parameters
  - public void setStateName(String stateName)
    
    Sets the state name.
    Parameters:
    stateName - string name of state
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

Copyright 2013-21, Acoustic Research Laboratory, National University of Singapore, and Subnero Pte Ltd