ParamChangeNtf (unet-framework 7.0.0 API)

org.arl.unet.ParamChangeNtf

Notification message of changed parameters by any agent.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`index`
`protected java.util.Map<org.arl.fjage.param.Parameter, org.arl.fjage.GenericValue>`	`paramValues`
`protected java.util.Set<org.arl.fjage.param.Parameter>`	`readonly`

Properties Summary

Properties
Type	Name and description
`int`	`index`

Constructor Summary

Constructors
Constructor and description
`ParamChangeNtf ()`
`ParamChangeNtf (org.arl.fjage.AgentID recipient)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`clear()` Clears the values.
	`java.lang.Object`	`get(org.arl.fjage.param.Parameter param)` Gets the parameter value.
	`int`	`getIndex()` Gets the index of parameter.
	`java.util.Map<org.arl.fjage.param.Parameter, org.arl.fjage.GenericValue>`	`getParamValues()` Gets the parameter and values map.
	`boolean`	`isReadonly(org.arl.fjage.param.Parameter param)` Checks if a parameter is read-only.
	`java.util.Set<org.arl.fjage.param.Parameter>`	`parameters()` Gets set of all requested parameters.
	`protected org.arl.fjage.param.Parameter`	`resolve(org.arl.fjage.param.Parameter param)` Convert named parameters to qualified parameters, if they match.
	`void`	`set(org.arl.fjage.param.Parameter param, java.lang.Object value)` Sets the changed parameter and value.
	`void`	`set(org.arl.fjage.param.Parameter param, java.lang.Object value, boolean readonly)` Sets the changed parameter and value.
	`void`	`setIndex(int index)` Sets the index.
	`java.lang.String`	`toString()` Gets the string representation of notification message.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.arl.fjage.Message`	org.arl.fjage.Message#toString(), org.arl.fjage.Message#setPerformative(org.arl.fjage.Performative), org.arl.fjage.Message#getPerformative(), org.arl.fjage.Message#setRecipient(org.arl.fjage.AgentID), org.arl.fjage.Message#getRecipient(), org.arl.fjage.Message#setSender(org.arl.fjage.AgentID), org.arl.fjage.Message#getSender(), org.arl.fjage.Message#setMessageID(java.lang.String), org.arl.fjage.Message#getMessageID(), org.arl.fjage.Message#setInReplyTo(java.lang.String), org.arl.fjage.Message#getInReplyTo(), org.arl.fjage.Message#setSentAt(long), org.arl.fjage.Message#getSentAt(), org.arl.fjage.Message#getJsonCache(), org.arl.fjage.Message#setJsonCache(java.lang.String), org.arl.fjage.Message#wait(long, int), org.arl.fjage.Message#wait(long), org.arl.fjage.Message#wait(), org.arl.fjage.Message#equals(java.lang.Object), org.arl.fjage.Message#hashCode(), org.arl.fjage.Message#getClass(), org.arl.fjage.Message#notify(), org.arl.fjage.Message#notifyAll()

- Field Detail
  - protected int index
  - protected java.util.Map<org.arl.fjage.param.Parameter, org.arl.fjage.GenericValue> paramValues
  - protected java.util.Set<org.arl.fjage.param.Parameter> readonly
- Property Detail
  - int index
- Constructor Detail
  - public ParamChangeNtf()
  - public ParamChangeNtf(org.arl.fjage.AgentID recipient)
- Method Detail
  - public void clear()
    
    Clears the values.
  - public java.lang.Object get(org.arl.fjage.param.Parameter param)
    
    Gets the parameter value.
    Parameters:
    param - org.arl.fjage.param.Parameter
    Returns:
    value of requested parameter
  - public int getIndex()
    
    Gets the index of parameter.
    Returns:
    index index or channel
  - public java.util.Map<org.arl.fjage.param.Parameter, org.arl.fjage.GenericValue> getParamValues()
    
    Gets the parameter and values map.
    Returns:
    Parameter value map
  - public boolean isReadonly(org.arl.fjage.param.Parameter param)
    
    Checks if a parameter is read-only.
    Parameters:
    param - org.arl.fjage.param.Parameter
    Returns:
    true if parameter is read-only, false if read-write
  - public java.util.Set<org.arl.fjage.param.Parameter> parameters()
    
    Gets set of all requested parameters.
    Returns:
    the parameter values set
  - protected org.arl.fjage.param.Parameter resolve(org.arl.fjage.param.Parameter param)
    
    Convert named parameters to qualified parameters, if they match.
    Parameters:
    param - parameter to resolve
    Returns:
    resolved parameter
  - public void set(org.arl.fjage.param.Parameter param, java.lang.Object value)
    
    Sets the changed parameter and value.
    Parameters:
    param - org.arl.fjage.param.Parameter
    value - parameter value
  - public void set(org.arl.fjage.param.Parameter param, java.lang.Object value, boolean readonly)
    
    Sets the changed parameter and value.
    Parameters:
    param - org.arl.fjage.param.Parameter
    value - parameter value
  - public void setIndex(int index)
    
    Sets the index.
    Parameters:
    index - index or channel
  - @java.lang.Override public java.lang.String toString()
    
    Gets the string representation of notification message.
    Returns:
    String representation.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class ParamChangeNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int index

protected java.util.Map<org.arl.fjage.param.Parameter, org.arl.fjage.GenericValue> paramValues

protected java.util.Set<org.arl.fjage.param.Parameter> readonly

Property Detail

int index

Constructor Detail

public ParamChangeNtf()

public ParamChangeNtf(org.arl.fjage.AgentID recipient)

Method Detail

public void clear()

public java.lang.Object get(org.arl.fjage.param.Parameter param)

public int getIndex()

public java.util.Map<org.arl.fjage.param.Parameter, org.arl.fjage.GenericValue> getParamValues()

public boolean isReadonly(org.arl.fjage.param.Parameter param)

public java.util.Set<org.arl.fjage.param.Parameter> parameters()

protected org.arl.fjage.param.Parameter resolve(org.arl.fjage.param.Parameter param)

public void set(org.arl.fjage.param.Parameter param, java.lang.Object value)

public void set(org.arl.fjage.param.Parameter param, java.lang.Object value, boolean readonly)

public void setIndex(int index)

@java.lang.Override public java.lang.String toString()