Package MDSplus :: Module connection :: Class Connection
[frames | no frames]

Type Connection

object --+
         |
        Connection


Implements an MDSip connection to an MDSplus server
Method Summary
  __init__(self, hostspec)
  __getAnswer__(self)
  __inspect__(self, value)
Internal routine used in determining characteristics of the value
  __processGetMany__(cls)
(Class method)
  __processPutMany__(cls)
(Class method)
  __sendArg__(self, value, idx, num)
Internal routine to send argument to mdsip server
None closeAllTrees(self)
Close all open MDSplus trees
None closeTree(self, tree, shot)
Close an MDSplus tree on the remote server
Scalar or Array get(self, exp, *args, **kwargs)
Evaluate and expression on the remote server
  getMany(self)
Return instance of a Connection.GetMany class.
None openTree(self, tree, shot)
Open an MDSplus tree on a remote server
None put(self, node, exp, *args)
Put data into a node in an MDSplus tree
  putMany(self)
Return an instance of a Connection.PutMany class.
None setDefault(self, path)
Change the current default tree location on the remote server
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
dict dtype_to_scalar = {2: <class 'MDSplus.mdsscalar.Uint8'>,...
type GetMany = MDSplus.connection.GetMany
type PutMany = MDSplus.connection.PutMany

Instance Method Details

__inspect__(self, value)

Internal routine used in determining characteristics of the value

__sendArg__(self, value, idx, num)

Internal routine to send argument to mdsip server

closeAllTrees(self)

Close all open MDSplus trees
Returns:
None

closeTree(self, tree, shot)

Close an MDSplus tree on the remote server
Parameters:
tree - tree name
           (type=str)
shot - shot number
           (type=int)
Returns:
None

get(self, exp, *args, **kwargs)

Evaluate and expression on the remote server
Parameters:
exp - TDI expression to be evaluated
           (type=str)
args - optional arguments to be inserted for the placeholders in the expression.
           (type=Data)
kwargs - Used for internal purposes
Returns:
result of evaluating the expression on the remote server
           (type=Scalar or Array)

getMany(self)

Return instance of a Connection.GetMany class. See the Connection.GetMany documentation for further information.

openTree(self, tree, shot)

Open an MDSplus tree on a remote server
Parameters:
tree - Name of tree
           (type=str)
shot - shot number
           (type=int)
Returns:
None

put(self, node, exp, *args)

Put data into a node in an MDSplus tree
Parameters:
node - Node name, relative or full path. Include double backslashes in string if node name includes one.
           (type=str)
exp - TDI expression with placeholders for any optional args.
           (type=str)
args - optional arguments to be inserted for the placeholders in the expression.
           (type=Data)
Returns:
None

putMany(self)

Return an instance of a Connection.PutMany class. See the Connection.PutMany documentation for further information.

setDefault(self, path)

Change the current default tree location on the remote server
Parameters:
path - Tree node path to be the new default location.
           (type=str)
Returns:
None

Class Variable Details

dtype_to_scalar

Type:
dict
Value:
{2: <class 'MDSplus.mdsscalar.Uint8'>,
 3: <class 'MDSplus.mdsscalar.Uint16'>,
 4: <class 'MDSplus.mdsscalar.Uint32'>,
 5: <class 'MDSplus.mdsscalar.Uint64'>,
 6: <class 'MDSplus.mdsscalar.Int8'>,
 7: <class 'MDSplus.mdsscalar.Int16'>,
 8: <class 'MDSplus.mdsscalar.Int32'>,
 9: <class 'MDSplus.mdsscalar.Int64'>,
...                                                                    

Generated by Epydoc 2.1 on Wed Aug 18 13:35:30 2010 http://epydoc.sf.net