ParameterReq (UnetStack 3.0.2 API)

org.arl.unet.ParameterReq

Request one or more parameters of an agent.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`ParameterReq.Entry`	Representation for parameter and value.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`index`
`protected Parameter`	`param`
`protected List<Entry>`	`requests`
`protected GenericValue`	`value`

Constructor Summary

Constructors
Constructor and description
`ParameterReq ()`
`ParameterReq (AgentID recipient)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`clear()` clears all parameter requests.
	`ParameterReq`	`get(Parameter param)` Requests a parameter.
	`ParameterReq`	`get(List<Parameter> param)` Requests a list of parameters.
	`int`	`getIndex()` Gets the index for index based parameters.
	`List<Entry>`	`requests()` Gets a list of requests to be made.
	`ParameterReq`	`set(Parameter param, Object value)` Sets a parameter value.
	`void`	`setIndex(int index)` Sets the index for index based parameter.
	`String`	`toString()`

Inherited Methods Summary

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

- Field Detail
  - protected int index
  - protected Parameter param
  - protected List<Entry> requests
  - protected GenericValue value
- Constructor Detail
  - public ParameterReq()
  - public ParameterReq(AgentID recipient)
- Method Detail
  - public void clear()
    
    clears all parameter requests.
  - public ParameterReq get(Parameter param)
    
    Requests a parameter.
    Parameters:
    param - parameter to be requested
    Returns:
    this object, to allow multiple gets to be concatenated
  - public ParameterReq get(List<Parameter> param)
    
    Requests a list of parameters.
    Parameters:
    param - parameter list to be requested
    Returns:
    this object, to allow multiple gets to be concatenated
  - public int getIndex()
    
    Gets the index for index based parameters.
    Returns:
    the index, -1 if the request has not indexed
  - public List<Entry> requests()
    
    Gets a list of requests to be made.
    Returns:
    requests
  - public ParameterReq set(Parameter param, Object value)
    
    Sets a parameter value.
    Parameters:
    param - parameter to be set
    value - value of parameter
    Returns:
    this object, to allow multiple sets to be concatenated
  - public void setIndex(int index)
    
    Sets the index for index based parameter. Examples of indexed parameters include channel in phy layer or scheme in modem layer.
    Parameters:
    index - index or channel, -1 if the request has not indexed
  - @Override public String toString()

| Detail:
Field
Constructor
Method

[Java] Class ParameterReq

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int index

protected Parameter param

protected List<Entry> requests

protected GenericValue value

Constructor Detail

public ParameterReq()

public ParameterReq(AgentID recipient)

Method Detail

public void clear()

public ParameterReq get(Parameter param)

public ParameterReq get(List<Parameter> param)

public int getIndex()

public List<Entry> requests()

public ParameterReq set(Parameter param, Object value)

public void setIndex(int index)

@Override public String toString()