Group (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- de.sciss.jcollider.Node
- - de.sciss.jcollider.Group

All Implemented Interfaces:

Constants, TreeNode
```
public class Group
extends Node
```
Mimics SCLang's Group class, that is, it's a client side representation of a group in the synthesis graph

Version:

0.32, 25-Feb-08

Author:

Hanns Holger Rutz

Field Summary
- Fields inherited from interface de.sciss.jcollider.Constants
  kAddAfter, kAddBefore, kAddReplace, kAddToHead, kAddToTail, kAudioRate, kControlRate, kDemandRate, kDoneFree, kDoneFreeAll, kDoneFreeAllPred, kDoneFreeAllSucc, kDoneFreeGroup, kDoneFreePausePred, kDoneFreePauseSucc, kDoneFreePred, kDoneFreePredGroup, kDoneFreePredGroupDeep, kDoneFreeSucc, kDoneFreeSuccGroup, kDoneFreeSuccGroupDeep, kDoneNothing, kDonePause, kDumpBoth, kDumpHex, kDumpOff, kDumpText, kHeaderAIFF, kHeaderIRCAM, kHeaderNeXT, kHeaderRaw, kHeaderWAVE, kSampleALaw, kSampleDouble, kSampleFloat, kSampleInt16, kSampleInt24, kSampleInt32, kSampleInt8, kSampleMuLaw, kScalarRate

Constructor Summary

Constructors
Constructor and Description

Group(Group target)

Group(Node target, int addAction)

Constructors
Constructor and Description
`Group(Group target)`
`Group(Node target, int addAction)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`de.sciss.net.OSCMessage`	`addAfterMsg(Node aNode)`
`de.sciss.net.OSCMessage`	`addBeforeMsg(Node aNode)`
`de.sciss.net.OSCMessage`	`addReplaceMsg(Node aNode)`
`de.sciss.net.OSCMessage`	`addToHeadMsg(Group aGroup)`
`de.sciss.net.OSCMessage`	`addToTailMsg(Group aGroup)`
`static Group`	`after(Node aNode)`
`static Group`	`basicNew(Server server)`
`static Group`	`basicNew(Server server, int nodeID)`
`static Group`	`before(Node aNode)`
`Enumeration`	`children()`
`void`	`deepFree()`
`de.sciss.net.OSCMessage`	`deepFreeMsg()`
`void`	`freeAll()`
`de.sciss.net.OSCMessage`	`freeAllMsg()`
`boolean`	`getAllowsChildren()`
`TreeNode`	`getChildAt(int childIndex)`
`int`	`getChildCount()`
`Node`	`getHeadNode()`
`int`	`getIndex(TreeNode node)`
`Node`	`getTailNode()`
`static Group`	`head(Group aGroup)`
`boolean`	`isLeaf()`
`void`	`moveNodeToHead(Node aNode)`
`de.sciss.net.OSCMessage`	`moveNodeToHeadMsg(Node aNode)`
`void`	`moveNodeToTail(Node aNode)`
`de.sciss.net.OSCMessage`	`moveNodeToTailMsg(Node aNode)`
`de.sciss.net.OSCMessage`	`newMsg()`
`de.sciss.net.OSCMessage`	`newMsg(Group target)`
`de.sciss.net.OSCMessage`	`newMsg(Node target, int addAction)` Note: this sets the group!
`static Group`	`replace(Node nodeToReplace)`
`protected void`	`setHeadNode(Node headNode)`
`protected void`	`setTailNode(Node tailNode)`
`static Group`	`tail(Group aGroup)`
`String`	`toString()`

Methods inherited from class de.sciss.jcollider.Node
equals, fill, fill, fillMsg, fillMsg, free, freeMsg, getGroup, getName, getNodeID, getParent, getPredNode, getServer, getSuccNode, hashCode, isPlaying, isRunning, map, map, map, map, map, mapMsg, mapMsg, mapMsg, mapMsg, mapMsg, mapn, mapn, mapn, mapn, mapnMsg, mapnMsg, mapnMsg, mapnMsg, moveAfter, moveAfterMsg, moveBefore, moveBeforeMsg, moveToHead, moveToHeadMsg, moveToTail, moveToTailMsg, printOn, query, query, queryMsg, register, register, release, release, releaseMsg, releaseMsg, run, run, runMsg, runMsg, set, set, set, set, setGroup, setMsg, setMsg, setMsg, setMsg, setn, setn, setName, setnMsg, setnMsg, setPlaying, setPredNode, setRunning, setSuccNode, trace, traceMsg

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Group

public Group(Group target)
      throws IOException

Throws:: IOException

Group

public Group(Node target,
             int addAction)
      throws IOException

Throws:: IOException

Method Detail

getHeadNode
```
public Node getHeadNode()
```

getTailNode
```
public Node getTailNode()
```

setHeadNode

protected void setHeadNode(Node headNode)

setTailNode

protected void setTailNode(Node tailNode)

newMsg

public de.sciss.net.OSCMessage newMsg()

newMsg

public de.sciss.net.OSCMessage newMsg(Group target)

newMsg
```
public de.sciss.net.OSCMessage newMsg(Node target,
                                      int addAction)
```
Note: this sets the group!

Throws:

ClassCastException - if target is not a group and addAction is either kAddToHead or kAddToTail

basicNew

public static Group basicNew(Server server)

basicNew

public static Group basicNew(Server server,
                             int nodeID)

after

public static Group after(Node aNode)
                   throws IOException

Throws:: IOException

before

public static Group before(Node aNode)
                    throws IOException

Throws:: IOException

head

public static Group head(Group aGroup)
                  throws IOException

Throws:: IOException

tail

public static Group tail(Group aGroup)
                  throws IOException

Throws:: IOException

replace

public static Group replace(Node nodeToReplace)
                     throws IOException

Throws:: IOException

addToHeadMsg

public de.sciss.net.OSCMessage addToHeadMsg(Group aGroup)

addToTailMsg

public de.sciss.net.OSCMessage addToTailMsg(Group aGroup)

addAfterMsg

public de.sciss.net.OSCMessage addAfterMsg(Node aNode)

addBeforeMsg

public de.sciss.net.OSCMessage addBeforeMsg(Node aNode)

addReplaceMsg

public de.sciss.net.OSCMessage addReplaceMsg(Node aNode)

moveNodeToHead

public void moveNodeToHead(Node aNode)
                    throws IOException

Throws:: IOException

moveNodeToTail

public void moveNodeToTail(Node aNode)
                    throws IOException

Throws:: IOException

moveNodeToHeadMsg

public de.sciss.net.OSCMessage moveNodeToHeadMsg(Node aNode)

moveNodeToTailMsg

public de.sciss.net.OSCMessage moveNodeToTailMsg(Node aNode)

freeAll

public void freeAll()
             throws IOException

Throws:: IOException

freeAllMsg

public de.sciss.net.OSCMessage freeAllMsg()

deepFree

public void deepFree()
              throws IOException

Throws:: IOException

deepFreeMsg

public de.sciss.net.OSCMessage deepFreeMsg()

toString
```
public String toString()
```
Overrides:

toString in class Object

getChildAt

public TreeNode getChildAt(int childIndex)

getChildCount
```
public int getChildCount()
```

getIndex
```
public int getIndex(TreeNode node)
```

getAllowsChildren
```
public boolean getAllowsChildren()
```

isLeaf
```
public boolean isLeaf()
```

children
```
public Enumeration children()
```

Class Group

Field Summary

Fields inherited from interface de.sciss.jcollider.Constants

Constructor Summary

Method Summary

Methods inherited from class de.sciss.jcollider.Node

Methods inherited from class java.lang.Object

Constructor Detail

Group

Group

Method Detail

getHeadNode

getTailNode

setHeadNode

setTailNode

newMsg

newMsg

newMsg

basicNew

basicNew

after

before

head

tail

replace

addToHeadMsg

addToTailMsg

addAfterMsg

addBeforeMsg

addReplaceMsg

moveNodeToHead

moveNodeToTail

moveNodeToHeadMsg

moveNodeToTailMsg

freeAll

freeAllMsg

deepFree

deepFreeMsg

toString

getChildAt

getChildCount

getIndex

getAllowsChildren

isLeaf

children