ParamChangeNtf (UnetStack 3.4.0 API)

Summary:
Field
Property
Constructor
Method

org.arl.unet.ParamChangeNtf

Notification message of changed parameters by any agent.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`index`
`protected Map<Parameter, Object>`	`paramValues`

Properties Summary

Properties
Type	Name and description
`int`	`index`

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`clear()` Clears the values.
	`Object`	`get(Parameter param)` Gets the parameter value.
	`int`	`getIndex()` Gets the index of parameter.
	`Map<Parameter, Object>`	`getParamValues()` Gets the parameter and values map.
	`Set<Parameter>`	`parameters()` Gets set of all requested parameters.
	`void`	`set(Parameter param, Object value)` Sets the changed parameter and value.
	`void`	`setIndex(int index)` Sets the index.
	`String`	`toString()` Gets the string representation of notification message.

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 int index
  - protected Map<Parameter, Object> paramValues
- Property Detail
  - int index
- Constructor Detail
  - public ParamChangeNtf()
  - public ParamChangeNtf(AgentID recipient)
- Method Detail
  - public void clear()
    
    Clears the values.
  - public Object get(Parameter param)
    
    Gets the parameter value.
    Parameters:
    param - Parameter
    Returns:
    value of requested parameter
  - public int getIndex()
    
    Gets the index of parameter.
    Returns:
    index index or channel
  - public Map<Parameter, Object> getParamValues()
    
    Gets the parameter and values map.
    Returns:
    Parameter value map
  - public Set<Parameter> parameters()
    
    Gets set of all requested parameters.
    Returns:
    the parameter values set
  - public void set(Parameter param, Object value)
    
    Sets the changed parameter and value.
    Parameters:
    param - Parameter
    value - parameter value
  - public void setIndex(int index)
    
    Sets the index.
    Parameters:
    index - index or channel
  - @Override public String toString()
    
    Gets the string representation of notification message.
    Returns:
    String representation.

Summary:
Field
Property
Constructor
Method

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