Inheritance diagram for __casac__.utils.utils:

Public Member Functions
def	__init__
def	verify
def	setconstraints
def	verifyparam
def	expandparam
def	torecord
def	toxml
def	getrc
def	removetable
def	tableinfo
def	lockedtables
def	hostinfo
def	c_exception
def	c_exception_clear
Public Attributes
	this
Static Private Attributes
dictionary	__swig_setmethods__
tuple	__setattr__
dictionary	__swig_getmethods__
tuple	__getattr__
	__repr__
	__swig_destroy__
	__del__

Detailed Description

Proxy of C++ casac::utils class

Definition at line 70 of file utils.py.

Constructor & Destructor Documentation

def __casac__.utils.utils.__init__ ( self )

__init__(self) -> utils

Definition at line 77 of file utils.py.

Member Function Documentation

def __casac__.utils.utils.c_exception ( self )

c_exception(self) -> string

Summary
Returns detailed information about last C-level exception
--------------------------------------------------------------------------------

Definition at line 240 of file utils.py.

def __casac__.utils.utils.c_exception_clear ( self )

c_exception_clear(self)

Summary
Clears information about last C-level exception
--------------------------------------------------------------------------------

Definition at line 251 of file utils.py.

def __casac__.utils.utils.expandparam	(	self,
		args,
		kwargs
	)

expandparam(self, name=string(""), value=initialize_variant("")) -> variant *

Summary
If a param is an enum it will minmatch the enum value and return the full value otherwise it just returns the value

Input Parameters:
name             Parameter name to expand 
value            Value of the parameter 

--------------------------------------------------------------------------------

Definition at line 131 of file utils.py.

def __casac__.utils.utils.getrc	(	self,
		args,
		kwargs
	)

getrc(self, rcvar=string("")) -> string

Input Parameters:
rcvar            Returns the value of the rc variable given. If no value is give it returns the root directory of CASA. 

--------------------------------------------------------------------------------

Definition at line 179 of file utils.py.

def __casac__.utils.utils.hostinfo ( self )

hostinfo(self) -> record *

Summary
returns host information
--------------------------------------------------------------------------------

Definition at line 229 of file utils.py.

def __casac__.utils.utils.lockedtables ( self )

lockedtables(self) -> std::vector< std::string >

Summary
get the tables locked by this process
--------------------------------------------------------------------------------

Definition at line 218 of file utils.py.

def __casac__.utils.utils.removetable	(	self,
		args,
		kwargs
	)

removetable(self, tablenames=std::vector< string >(1, "")) -> bool

Input Parameters:
tablenames       Removes tables safely 

--------------------------------------------------------------------------------

Definition at line 191 of file utils.py.

def __casac__.utils.utils.setconstraints	(	self,
		args,
		kwargs
	)

setconstraints(self, xmldescriptor=initialize_variant("")) -> bool

Summary
Sets the internal contraints records from an XML file

Input Parameters:
xmldescriptor    XML description, either record or url 

--------------------------------------------------------------------------------

Definition at line 101 of file utils.py.

def __casac__.utils.utils.tableinfo	(	self,
		args,
		kwargs
	)

tableinfo(self, tablename=string("")) -> record *

Summary
Get information about a particular table

Input Parameters:
tablename        path to table 

--------------------------------------------------------------------------------

Definition at line 203 of file utils.py.

def __casac__.utils.utils.torecord	(	self,
		args,
		kwargs
	)

torecord(self, input) -> record *

Summary
Transforms an XML string into a record

Input Parameters:
input            XML string, maybe a URL 

--------------------------------------------------------------------------------

Definition at line 147 of file utils.py.

def __casac__.utils.utils.toxml	(	self,
		args,
		kwargs
	)

toxml(self, input=initialize_record(""), asfile=False, filename=string("recordas.xml")) -> string

Summary
Turns a record into an xml string

Input Parameters:
input            name of thing to viewe 
asfile           write the xml as a file false 
filename         if asfile is true then output filename recordas.xml 

--------------------------------------------------------------------------------

Definition at line 162 of file utils.py.

def __casac__.utils.utils.verify	(	self,
		args,
		kwargs
	)

verify(self, input=initialize_record(""), xmldescriptor=initialize_variant(""), throwexecpt=False) -> bool

Summary
Verifies an input record against an XML interface description of took or task

Input Parameters:
input            The input record to verify 
xmldescriptor    XML description, either record or url 
throwexecpt      Throw an exception if the verification fails false 

--------------------------------------------------------------------------------

Definition at line 84 of file utils.py.

def __casac__.utils.utils.verifyparam	(	self,
		args,
		kwargs
	)

verifyparam(self, param=initialize_record("")) -> bool

Summary
Verifies an individual parameter against a prespecified constraints record

Input Parameters:
param            Parameter name:value pair to verify 

--------------------------------------------------------------------------------

Definition at line 116 of file utils.py.