org.objectweb.proactive.core.group.topology
Class Cube

java.lang.Object
  |
  +--org.objectweb.proactive.core.body.proxy.AbstractProxy
        |
        +--org.objectweb.proactive.core.group.ProxyForGroup
              |
              +--org.objectweb.proactive.core.group.topology.TopologyGroup
                    |
                    +--org.objectweb.proactive.core.group.topology.Line
                          |
                          +--org.objectweb.proactive.core.group.topology.Plan
                                |
                                +--org.objectweb.proactive.core.group.topology.Cube
All Implemented Interfaces:
java.util.Collection, Group, Proxy, java.io.Serializable

public class Cube
extends Plan

This class represents a group by a three-dimensional topology.

Author:
Laurent Baduel
See Also:
Serialized Form

Field Summary
protected  int depth
          depth of the three-dimensional topology group
 
Fields inherited from class org.objectweb.proactive.core.group.topology.Plan
height
 
Fields inherited from class org.objectweb.proactive.core.group.topology.Line
width
 
Fields inherited from class org.objectweb.proactive.core.group.ProxyForGroup
className, dispatching, logger, memberList, stub, uniqueSerialization, waited
 
Constructor Summary
Cube(Group g, int height, int width, int depth)
          Construtor.
 
Method Summary
 java.lang.Object ahead(java.lang.Object o)
          Returns the object ahead the specified object in the three-dimensional topology group
 java.lang.Object behind(java.lang.Object o)
          Returns the object behind the specified object in the three-dimensional topology group
 java.lang.Object down(java.lang.Object o)
          Returns the object at the down of the specified object in the three-dimensional topology group
 int getDepth()
          Returns the height of the three-dimensional topology group (number of lines)
 int getHeight()
          Returns the height of the three-dimensional topology group (number of lines)
 int getWidth()
          Returns the width of the three-dimensional topology group (number of cloumns)
 java.lang.Object left(java.lang.Object o)
          Returns the object at the left of the specified object in the three-dimensional topology group
 Line lineX(java.lang.Object o)
          Returns the horizontal line (one-dimensional topology group) that contains the object
 Line lineY(java.lang.Object o)
          Returns the vertical line (kind of column)(one-dimensional topology group) that contains the object
 Line lineZ(java.lang.Object o)
          Returns the line in depth (one-dimensional topology group) that contains the object
 Plan planX(java.lang.Object o)
          Returns the plan in X (two-dimensional topology group) that contains the object
 Plan planY(java.lang.Object o)
          Returns the plan in Y (two-dimensional topology group) that contains the object
 Plan planZ(java.lang.Object o)
          Returns the plan in Z (two-dimensional topology group) that contains the object
 java.lang.Object right(java.lang.Object o)
          Returns the object at the right of the specified object in the three-dimensional topology group
 java.lang.Object up(java.lang.Object o)
          Returns the object at the up of the specified object in the three-dimensional topology group
 
Methods inherited from class org.objectweb.proactive.core.group.topology.Plan
column, column, getX, getY, line, line
 
Methods inherited from class org.objectweb.proactive.core.group.ProxyForGroup
add, addAll, addMerge, addToListOfResult, allArrived, allAwaited, asynchronousCallOnGroup, barrier, clear, contains, containsAll, createMemberWithMultithread, difference, display, equals, exclude, get, getExceptionList, getGroupByType, getType, getTypeName, hashCode, indexOf, intersection, isDispatchingOn, isEmpty, iterator, listIterator, oneWayCallOnGroup, purgeExceptionAndNull, range, reify, remove, remove, removeAll, retainAll, set, setDispatchingOff, setDispatchingOn, setRatioNemberToThread, setSPMDGroup, setUniqueSerializationOff, setUniqueSerializationOn, size, toArray, toArray, union, waitAll, waitAndGetOne, waitAndGetTheNth, waitN, waitOne, waitOneAndGetIndex, waitTheNth
 
Methods inherited from class org.objectweb.proactive.core.body.proxy.AbstractProxy
isAsynchronousCall, isOneWayCall
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

depth

protected int depth
depth of the three-dimensional topology group

Constructor Detail

Cube

public Cube(Group g,
            int height,
            int width,
            int depth)
     throws ConstructionOfReifiedObjectFailedException
Construtor. The members of g are used to fill the topology group.

Parameters:
g - - the group used a base for the new group (topology)
height - - the heigth of the three-dimensional topology group
width - - the width of the three-dimensional topology group
depth - - the depth of the three-dimensional topology group
Throws:
ConstructionOfReifiedObjectFailedException
Method Detail

getWidth

public int getWidth()
Returns the width of the three-dimensional topology group (number of cloumns)

Overrides:
getWidth in class Plan
Returns:
the width of the three-dimensional topology group

getHeight

public int getHeight()
Returns the height of the three-dimensional topology group (number of lines)

Overrides:
getHeight in class Plan
Returns:
the height of the three-dimensional topology group

getDepth

public int getDepth()
Returns the height of the three-dimensional topology group (number of lines)

Returns:
the height of the three-dimensional topology group

left

public java.lang.Object left(java.lang.Object o)
Returns the object at the left of the specified object in the three-dimensional topology group

Overrides:
left in class Plan
Parameters:
o - - the specified object
Returns:
the object at the left of o. If there is no object at the left of o, return null

right

public java.lang.Object right(java.lang.Object o)
Returns the object at the right of the specified object in the three-dimensional topology group

Overrides:
right in class Plan
Parameters:
o - - the specified object
Returns:
the object at the right of o. If there is no object at the right of o, return null

up

public java.lang.Object up(java.lang.Object o)
Returns the object at the up of the specified object in the three-dimensional topology group

Overrides:
up in class Plan
Parameters:
o - - the specified object
Returns:
the object at the up of o. If there is no object at the up of o, return null

down

public java.lang.Object down(java.lang.Object o)
Returns the object at the down of the specified object in the three-dimensional topology group

Overrides:
down in class Plan
Parameters:
o - - the specified object
Returns:
the object at the down of o. If there is no object at the down of o, return null

ahead

public java.lang.Object ahead(java.lang.Object o)
Returns the object ahead the specified object in the three-dimensional topology group

Parameters:
o - - the specified object
Returns:
the object at the down of o. If there is no object at the down of o, return null

behind

public java.lang.Object behind(java.lang.Object o)
Returns the object behind the specified object in the three-dimensional topology group

Parameters:
o - - the specified object
Returns:
the object at the down of o. If there is no object at the down of o, return null

lineX

public Line lineX(java.lang.Object o)
Returns the horizontal line (one-dimensional topology group) that contains the object

Parameters:
o - - the object
Returns:
the one-dimensional topology group formed by the horizontal line that contains the object in the three-dimensional topology group

lineY

public Line lineY(java.lang.Object o)
Returns the vertical line (kind of column)(one-dimensional topology group) that contains the object

Parameters:
o - - the object
Returns:
the one-dimensional topology group formed by the vertical line that contains the object in the three-dimensional topology group

lineZ

public Line lineZ(java.lang.Object o)
Returns the line in depth (one-dimensional topology group) that contains the object

Parameters:
o - - the object
Returns:
the one-dimensional topology group formed by the line in depth that contains the object in the three-dimensional topology group

planX

public Plan planX(java.lang.Object o)
Returns the plan in X (two-dimensional topology group) that contains the object

Parameters:
o - - the object
Returns:
the two-dimensional topology group formed by the plan in X that contains the object in the three-dimensional topology group

planY

public Plan planY(java.lang.Object o)
Returns the plan in Y (two-dimensional topology group) that contains the object

Parameters:
o - - the object
Returns:
the two-dimensional topology group formed by the plan in Y that contains the object in the three-dimensional topology group

planZ

public Plan planZ(java.lang.Object o)
Returns the plan in Z (two-dimensional topology group) that contains the object

Parameters:
o - - the object
Returns:
the two-dimensional topology group formed by the plan in Z that contains the object in the three-dimensional topology group


Copyright © April 2004 INRIA All Rights Reserved.