ActionSignature (CZT Corejava Circus 1.6-SNAPSHOT API)

All Superinterfaces:

CircusSignature, Term

All Known Implementing Classes:

ActionSignatureImpl
```
public interface ActionSignature
extends CircusSignature
```
An action signature consists of the action name, formal parameters, the channels used, the communications, channel sets and name sets used.
- Signature getFormalParams() = getSignatureList().get(0)
- Signature getLocalVars() = getSignatureList().get(1)
- Signature getUsedChannels() = getSignatureList().get(2)
One can also access the communication list containing all the communications involved in this action. That is, all the channel uses with resolved generic types and communication pattern. Note the communication pattern collective type may differ (and may be non-unifiable) from the channel declared type (e.g., c: X x Y x Z, c?x?w).
Author:

GnAST version 1.6-SNAPSHOT

Field Summary

Fields
Modifier and Type Field and Description

static int FORMAL_PARAMS_INDEX

static int LOCAL_VARS_INDEX

static int USED_CHANNELS_INDEX

Fields
Modifier and Type	Field and Description
`static int`	`FORMAL_PARAMS_INDEX`
`static int`	`LOCAL_VARS_INDEX`
`static int`	`USED_CHANNELS_INDEX`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Name`	`getActionName()` This is a convenience method for getName.
`ZName`	`getActionZName()` This is a convenience method.
`ChannelSetList`	`getChannelSetList()` Returns the ChannelSetList element.
`CommunicationList`	`getCommunicationList()` Returns the CommunicationList element.
`Signature`	`getFormalParams()` This is a convenience method.
`Signature`	`getLocalVars()` This is a convenience method.
`NameSetList`	`getNameSetList()` Returns the NameSetList element.
`SignatureList`	`getSignatureList()` Returns the SignatureList element.
`Signature`	`getUsedChannels()` This is a convenience method.
`CircusChannelSetList`	`getUsedChannelSets()` This is a convenience method.
`CircusCommunicationList`	`getUsedCommunications()` This is a convenience method.
`CircusNameSetList`	`getUsedNameSets()` This is a convenience method.
`ZSignatureList`	`getZSignatureList()` This is a convenience method.
`boolean`	`isParamAction()` Returns whether or not this is a signature for parameterised action or not (i.e.
`void`	`setActionName(Name name)` This is a convenience method for setName.
`void`	`setChannelSetList(ChannelSetList channelSetList)` Sets the ChannelSetList element.
`void`	`setCommunicationList(CommunicationList communicationList)` Sets the CommunicationList element.
`Signature`	`setFormalParams(Signature sig)` This is a convenience method.
`Signature`	`setLocalVars(Signature sig)` This is a convenience method.
`void`	`setNameSetList(NameSetList nameSetList)` Sets the NameSetList element.
`void`	`setSignatureList(SignatureList signatureList)` Sets the SignatureList element.
`Signature`	`setUsedChannels(Signature sig)` This is a convenience method.

Methods inherited from interface net.sourceforge.czt.circus.ast.CircusSignature
getName, getZName, setName

Methods inherited from interface net.sourceforge.czt.base.ast.Term
accept, annsSize, create, getAnn, getAnns, getChildren, hasAnn, hasAnn, removeAnn, removeAnn

- Field Detail
  - FORMAL_PARAMS_INDEX
```
static final int FORMAL_PARAMS_INDEX
```
    See Also:
    
    Constant Field Values
  - LOCAL_VARS_INDEX
```
static final int LOCAL_VARS_INDEX
```
    See Also:
    
    Constant Field Values
  - USED_CHANNELS_INDEX
```
static final int USED_CHANNELS_INDEX
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getSignatureList
```
SignatureList getSignatureList()
```
    Returns the SignatureList element.
    
    Returns:
    
    the SignatureList element.
  - setSignatureList
```
void setSignatureList(SignatureList signatureList)
```
    Sets the SignatureList element.
    
    Parameters:
    
    signatureList - the SignatureList element.
    
    See Also:
    
    getSignatureList()
  - getCommunicationList
```
CommunicationList getCommunicationList()
```
    Returns the CommunicationList element.
    
    Returns:
    
    the CommunicationList element.
  - setCommunicationList
```
void setCommunicationList(CommunicationList communicationList)
```
    Sets the CommunicationList element.
    
    Parameters:
    
    communicationList - the CommunicationList element.
    
    See Also:
    
    getCommunicationList()
  - getChannelSetList
```
ChannelSetList getChannelSetList()
```
    Returns the ChannelSetList element.
    
    Returns:
    
    the ChannelSetList element.
  - setChannelSetList
```
void setChannelSetList(ChannelSetList channelSetList)
```
    Sets the ChannelSetList element.
    
    Parameters:
    
    channelSetList - the ChannelSetList element.
    
    See Also:
    
    getChannelSetList()
  - getNameSetList
```
NameSetList getNameSetList()
```
    Returns the NameSetList element.
    
    Returns:
    
    the NameSetList element.
  - setNameSetList
```
void setNameSetList(NameSetList nameSetList)
```
    Sets the NameSetList element.
    
    Parameters:
    
    nameSetList - the NameSetList element.
    
    See Also:
    
    getNameSetList()
  - getActionName
```
Name getActionName()
```
    This is a convenience method for getName.
  - isParamAction
```
boolean isParamAction()
```
    Returns whether or not this is a signature for parameterised action or not (i.e. it has a non-empty list of formal parameters).
  - getActionZName
```
ZName getActionZName()
```
    This is a convenience method. It returns the ZName if getName is an instance of ZName and throws an UnsupportedAstClassException otherwise.
  - setActionName
```
void setActionName(Name name)
```
    This is a convenience method for setName.
  - getZSignatureList
```
ZSignatureList getZSignatureList()
```
    This is a convenience method. It returns the ZSignatureList if getSignatureList() is an instance of ZSignatureList and throws a UnsupportedAstClassException otherwise.
  - getFormalParams
```
Signature getFormalParams()
```
    This is a convenience method. It represents the non-null (possibly empty) signature of arguments for this action signature (i.e. its declared formal parameters). It returns the Signature from getZSignatureList().get(FORMAL_PARAMS_INDEX). It may throw a a UnsupportedAstClassException from getZSignatureList().
  - setFormalParams
```
Signature setFormalParams(Signature sig)
```
    This is a convenience method. It sets the given non-null (possibly empty) signature of the formal parameters signature of this action. It is the same as getZSignatureList().set(FORMAL_PARAMS_INDEX, sig). It may throw a a UnsupportedAstClassException from getMainSignatures(). The result is the old value previously stored (if any).
  - getLocalVars
```
Signature getLocalVars()
```
    This is a convenience method. It represents the non-null (possibly empty) signature of locally declared variables for this action signature (i.e. circvar commands). It returns the Signature from getZSignatureList().get(LOCAL_VARS_INDEX). It may throw a a UnsupportedAstClassException from getZSignatureList().
  - setLocalVars
```
Signature setLocalVars(Signature sig)
```
    This is a convenience method. It sets the given non-null (possibly empty) signature of the local variables signature of this action. It is the same as getZSignatureList().set(LOCAL_VARS_INDEX, sig). It may throw a a UnsupportedAstClassException from getMainSignatures(). The result is the old value previously stored (if any).
  - getUsedChannels
```
Signature getUsedChannels()
```
    This is a convenience method. It represents the non-null (possibly empty) signature of used channels for this action signature. This contains the channel name and its declared type It returns the Signature from getZSignatureList().get(USED_CHANNELS_INDEX). It may throw a a UnsupportedAstClassException from getZSignatureList().
  - setUsedChannels
```
Signature setUsedChannels(Signature sig)
```
    This is a convenience method. It sets the given non-null (possibly empty) signature of used channels for this action signature. This contains the channel name and its declared type It is the same as getZSignatureList().set(USED_CHANNELS_INDEX, sig). The result is the old value previously stored (if any).
  - getUsedCommunications
```
CircusCommunicationList getUsedCommunications()
```
    This is a convenience method. It represents the non-null (possibly empty) list of used channels within the communications of this action. This includes generic, implicit, or normal communications. It may throw a UnsupportedAstClassException from getCommunicationList().
  - getUsedNameSets
```
CircusNameSetList getUsedNameSets()
```
    This is a convenience method. It represents the non-null (possibly empty) list of used name sets within the name sets of this action. It may throw a UnsupportedAstClassException from getNameSetListList().
  - getUsedChannelSets
```
CircusChannelSetList getUsedChannelSets()
```
    This is a convenience method. It represents the non-null (possibly empty) list of used channel sets within the name sets of this action. It may throw a UnsupportedAstClassException from getChannelSetListList().

Interface ActionSignature

Field Summary

Method Summary

Methods inherited from interface net.sourceforge.czt.circus.ast.CircusSignature

Methods inherited from interface net.sourceforge.czt.base.ast.Term

Field Detail

FORMAL_PARAMS_INDEX

LOCAL_VARS_INDEX

USED_CHANNELS_INDEX

Method Detail

getSignatureList

setSignatureList

getCommunicationList

setCommunicationList

getChannelSetList

setChannelSetList

getNameSetList

setNameSetList

getActionName

isParamAction

getActionZName

setActionName

getZSignatureList

getFormalParams

setFormalParams

getLocalVars

setLocalVars

getUsedChannels

setUsedChannels

getUsedCommunications

getUsedNameSets

getUsedChannelSets