MDSplus

Class Tree

java.lang.Object

MDSplus.Tree

public class Tree
extends Object

Class Tree brings all the tree-wide information.

Version:

1.0

Author:

manduchi

Field Summary

Fields

Modifier and Type	Field and Description
protected long	ctx
static String	OPEN_EDIT
static String	OPEN_NEW
static String	OPEN_NORMAL
static String	OPEN_READONLY
protected Vector<MDSplus.Tree.TreeCtxInfo>	treeCtxInfoV
static int	TreeUSAGE_ACTION
static int	TreeUSAGE_ANY
static int	TreeUSAGE_AXIS
static int	TreeUSAGE_COMPOUND_DATA
static int	TreeUSAGE_DEVICE
static int	TreeUSAGE_DISPATCH
static int	TreeUSAGE_NONE
static int	TreeUSAGE_NUMERIC
static int	TreeUSAGE_SIGNAL
static int	TreeUSAGE_STRUCTURE
static int	TreeUSAGE_SUBTREE
static int	TreeUSAGE_TASK
static int	TreeUSAGE_TEXT
static int	TreeUSAGE_WINDOW

Constructor Summary

Constructors

Constructor and Description
Tree(String name, int shot)
Tree(String name, int shot, String mode)

Method Summary

Modifier and Type	Method and Description
void	addDevice(String name, String type) Add a new device instance to the tree open for edit.
TreeNode	addNode(String name, String usage) Add a new node to the tree open for edit.
void	close()
void	createPulse(int pulseShot) Create a new pulse file
void	deleteNode(String name) Delete the node and its descendants from the tree open for edit.
void	deletePulse(int pulseShot) Delete a pulse file.
void	edit()
String[]	findTags(String wild) Returns the list of tags matching the specified wild name.
static Tree	getActiveTree()
protected long	getCtx()
int	getCurrent() Return the current shot for that tree.
long	getDatafileSize()
TreeNode	getDefault() Get the TreeNode for the default node.
String	getMode()
String	getName() Returns the currently opened and active tree
TreeNode	getNode(int nid) Returns the TreeNode for the data item whose internal address (nid) is passed as argument.
TreeNode	getNode(String path) Return TreeNode for the data item corresponding to the passed pathname
TreeNode	getNode(TreePath path) Return the TreeNode for the data itemspecified by the passed TreePath instance.
TreeNodeArray	getNodeWild(String path) Return the TreeNode array for all the successor nodes of the specified usage with respect of the passed path.
TreeNodeArray	getNodeWild(String path, int usage)
TreeNodeArray	getNodeWild(String path, String usage)
int	getShot()
boolean	isModified()
boolean	isOpen()
boolean	isOpenForEdit()
boolean	isReadOnly()
void	normal() Open the tree for editing.
void	quit() quit editing session.
void	readonly()
void	removeTag(String tag)
static void	setActiveTree(Tree tree) Set the oassed tree as the active one
void	setCurrent() Set the current tree and shot.
static void	setCurrent(String name, int shot)
void	setDefault(TreeNode node) Set the default position in the tree.
void	setTimeContext(Data start, Data end, Data delta) Set the current time context.
void	setVersionsInModel(boolean enabled)
void	setVersionsInPulse(boolean enabled)
void	setViewDate(Date date) Set the version date: all read data will refer to the version active to that date.
Data	tdiCompile(String expr, Data... args)
Data	tdiData(Data data)
Data	tdiEvaluate(Data data)
Data	tdiExecute(String expr, Data... args)
String	toString()
boolean	versionsInModelEnabled() Returns true if the tree supports versioning in model.
boolean	versionsInPulseEnabled() Returns true if the tree supports versioning in pulse.
void	write() Write the tree under edit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TreeUSAGE_ANY

public static final int TreeUSAGE_ANY

See Also:

Constant Field Values

TreeUSAGE_NONE

public static final int TreeUSAGE_NONE

See Also:

Constant Field Values

TreeUSAGE_STRUCTURE

public static final int TreeUSAGE_STRUCTURE

See Also:

Constant Field Values

TreeUSAGE_ACTION

public static final int TreeUSAGE_ACTION

See Also:

Constant Field Values

TreeUSAGE_DEVICE

public static final int TreeUSAGE_DEVICE

See Also:

Constant Field Values

TreeUSAGE_DISPATCH

public static final int TreeUSAGE_DISPATCH

See Also:

Constant Field Values

TreeUSAGE_NUMERIC

public static final int TreeUSAGE_NUMERIC

See Also:

Constant Field Values

TreeUSAGE_SIGNAL

public static final int TreeUSAGE_SIGNAL

See Also:

Constant Field Values

TreeUSAGE_TASK

public static final int TreeUSAGE_TASK

See Also:

Constant Field Values

TreeUSAGE_TEXT

public static final int TreeUSAGE_TEXT

See Also:

Constant Field Values

TreeUSAGE_WINDOW

public static final int TreeUSAGE_WINDOW

See Also:

Constant Field Values

TreeUSAGE_AXIS

public static final int TreeUSAGE_AXIS

See Also:

Constant Field Values

TreeUSAGE_SUBTREE

public static final int TreeUSAGE_SUBTREE

See Also:

Constant Field Values

TreeUSAGE_COMPOUND_DATA

public static final int TreeUSAGE_COMPOUND_DATA

See Also:

Constant Field Values

treeCtxInfoV

protected Vector<MDSplus.Tree.TreeCtxInfo> treeCtxInfoV

ctx

protected long ctx

OPEN_NORMAL

public static final String OPEN_NORMAL

See Also:

Constant Field Values

OPEN_READONLY

public static final String OPEN_READONLY

See Also:

Constant Field Values

OPEN_NEW

public static final String OPEN_NEW

See Also:

Constant Field Values

OPEN_EDIT

public static final String OPEN_EDIT

See Also:

Constant Field Values

Constructor Detail

Tree

public Tree(String name,
            int shot)
     throws MdsException

Throws:

MdsException

Tree

public Tree(String name,
            int shot,
            String mode)
     throws MdsException

Throws:

MdsException

Method Detail

close

public void close()
           throws MdsException

Throws:

MdsException

isOpen

public boolean isOpen()

toString

public String toString()

Overrides:

toString in class Object

setActiveTree

public static void setActiveTree(Tree tree)
                          throws MdsException

Set the oassed tree as the active one

Parameters:

tree -

Throws:

MdsException

getName

public String getName()

Returns the currently opened and active tree

getShot

public int getShot()

getMode

public String getMode()

setCurrent

public static void setCurrent(String name,
                              int shot)
                       throws MdsException

Throws:

MdsException

getNode

public TreeNode getNode(String path)
                 throws MdsException

Return TreeNode for the data item corresponding to the passed pathname

Parameters:

path -

Throws:

MdsException

getNode

public TreeNode getNode(int nid)
                 throws MdsException

Returns the TreeNode for the data item whose internal address (nid) is passed as argument.

Parameters:

nid -

Throws:

MdsException

getNode

public TreeNode getNode(TreePath path)
                 throws MdsException

Return the TreeNode for the data itemspecified by the passed TreePath instance.

Parameters:

path -

Throws:

MdsException

getNodeWild

public TreeNodeArray getNodeWild(String path)
                          throws MdsException

Return the TreeNode array for all the successor nodes of the specified usage with respect of the passed path.

Parameters:

path -

usage -

Throws:

MdsException

getNodeWild

public TreeNodeArray getNodeWild(String path,
                                 int usage)
                          throws MdsException

Throws:

MdsException

getNodeWild

public TreeNodeArray getNodeWild(String path,
                                 String usage)
                          throws MdsException

Throws:

MdsException

getDefault

public TreeNode getDefault()
                    throws MdsException

Get the TreeNode for the default node.

Throws:

MdsException

setDefault

public void setDefault(TreeNode node)
                throws MdsException

Set the default position in the tree.

Parameters:

node -

Throws:

MdsException

versionsInModelEnabled

public boolean versionsInModelEnabled()
                               throws MdsException

Returns true if the tree supports versioning in model.

Throws:

MdsException

versionsInPulseEnabled

public boolean versionsInPulseEnabled()
                               throws MdsException

Returns true if the tree supports versioning in pulse.

Throws:

MdsException

setVersionsInModel

public void setVersionsInModel(boolean enabled)
                        throws MdsException

Throws:

MdsException

setVersionsInPulse

public void setVersionsInPulse(boolean enabled)
                        throws MdsException

Throws:

MdsException

isModified

public boolean isModified()
                   throws MdsException

Throws:

MdsException

isOpenForEdit

public boolean isOpenForEdit()
                      throws MdsException

Throws:

MdsException

isReadOnly

public boolean isReadOnly()
                   throws MdsException

Throws:

MdsException

setViewDate

public void setViewDate(Date date)
                 throws MdsException

Set the version date: all read data will refer to the version active to that date.

Parameters:

date -

Throws:

MdsException

setTimeContext

public void setTimeContext(Data start,
                           Data end,
                           Data delta)
                    throws MdsException

Set the current time context. Only the specified portion of segmented data will be returned by TreeNode.getData() method

Parameters:

start -

end -

delta -

Throws:

MdsException

setCurrent

public void setCurrent()
                throws MdsException

Set the current tree and shot.

Parameters:

shot -

treename -

Throws:

MdsException

getCurrent

public int getCurrent()
               throws MdsException

Return the current shot for that tree.

Parameters:

treename -

Throws:

MdsException

createPulse

public void createPulse(int pulseShot)
                 throws MdsException

Create a new pulse file

Parameters:

shot -

Throws:

MdsException

deletePulse

public void deletePulse(int pulseShot)
                 throws MdsException

Delete a pulse file.

Parameters:

shot -

Throws:

MdsException

findTags

public String[] findTags(String wild)
                  throws MdsException

Returns the list of tags matching the specified wild name.

Parameters:

wild -

Throws:

MdsException

normal

public void normal()
            throws MdsException

Open the tree for editing.

Throws:

MdsException

readonly

public void readonly()
              throws MdsException

Throws:

MdsException

edit

public void edit()
          throws MdsException

Throws:

MdsException

getCtx

protected long getCtx()
               throws MdsException

Throws:

MdsException

write

public void write()
           throws MdsException

Write the tree under edit.

Throws:

MdsException

quit

public void quit()
          throws MdsException

quit editing session.

Throws:

MdsException

addNode

public TreeNode addNode(String name,
                        String usage)
                 throws MdsException

Add a new node to the tree open for edit.

Parameters:

name -

usage -

Throws:

MdsException

addDevice

public void addDevice(String name,
                      String type)
               throws MdsException

Add a new device instance to the tree open for edit.

Parameters:

name -

type -

Throws:

MdsException

deleteNode

public void deleteNode(String name)
                throws MdsException

Delete the node and its descendants from the tree open for edit.

Parameters:

name -

Throws:

MdsException

removeTag

public void removeTag(String tag)
               throws MdsException

Throws:

MdsException

getDatafileSize

public long getDatafileSize()
                     throws MdsException

Throws:

MdsException

tdiCompile

public Data tdiCompile(String expr,
                       Data... args)

tdiExecute

public Data tdiExecute(String expr,
                       Data... args)

tdiData

public Data tdiData(Data data)

tdiEvaluate

public Data tdiEvaluate(Data data)

getActiveTree

public static Tree getActiveTree()