From 433de3f4c9fb26b3bd50bfb4653cfa49aa73b729 Mon Sep 17 00:00:00 2001 From: Ed Brown Date: Tue, 12 Jul 2016 16:17:46 -0700 Subject: [PATCH] manageElements done. Working on boxfill. --- Packages/vcs/vcs/boxfill.py | 132 ++++++++++++++++++++++++----- Packages/vcs/vcs/manageElements.py | 52 +++++++----- 2 files changed, 144 insertions(+), 40 deletions(-) diff --git a/Packages/vcs/vcs/boxfill.py b/Packages/vcs/vcs/boxfill.py index b403895fca..21af17c135 100755 --- a/Packages/vcs/vcs/boxfill.py +++ b/Packages/vcs/vcs/boxfill.py @@ -690,50 +690,137 @@ def _setdatawc_y2(self, value): datawc_y2 = property(_getdatawc_y2, _setdatawc_y2) def colors(self, color1=16, color2=239): + """ + Sets the color_1 and color_2 properties of the object. + +:param color1: Sets the color_1 value on the object +:type color1: int + +:param color2: Sets the color_2 value on the object +:type color2: int + +""" self.color_1 = color1 self.color_2 = color2 - colors.__doc__ = xmldocs.colorsdoc + #colors.__doc__ = xmldocs.colorsdoc def exts(self, ext1='n', ext2='y'): + """ + Sets the ext_1 and ext_2 values on the object. + +:param ext1: Sets the ext_1 value on the object. 'y' sets it to True, 'n' sets it to False. +:type ext1: str + +:param ext2: Sets the ext_2 value on the object. 'y' sets it to True, 'n' sets it to False. +:type ext2: str + +""" self.ext_1 = ext1 self.ext_2 = ext2 - exts.__doc__ = xmldocs.extsdoc + #exts.__doc__ = xmldocs.extsdoc # # Doesn't make sense to inherit. This would mean more coding in C. # I put this code back. # def xticlabels(self, xtl1='', xtl2=''): + """ + Sets xticlabels1 and xticlabels2 properties of the object. + +:param xtl1: Sets the xticlabels1 property of the object. +:type xtl1: str + +:param xtl2: Sets the xticlabels2 property of the object. +:type xtl2: str + +""" self.xticlabels1 = xtl1 self.xticlabels2 = xtl2 - xticlabels.__doc__ = xmldocs.xticlabelsdoc + #xticlabels.__doc__ = xmldocs.xticlabelsdoc def xmtics(self, xmt1='', xmt2=''): + """ + Sets xmtics1 and xmtics2 properties of the object. + +:param xmt1: Sets the xmtics1 property of the object. +:type xmt1: str + +:param xmt2: Sets the xmtics1 property of the object. +:type xmt2: str + +""" self.xmtics1 = xmt1 self.xmtics2 = xmt2 - xmtics.__doc__ = xmldocs.xmticsdoc + #xmtics.__doc__ = xmldocs.xmticsdoc def yticlabels(self, ytl1='', ytl2=''): + """ + Sets yticlabels1 and yticlabels2 properties of the object. + +:param ytl1: Sets yticlabels1 property of the object. +:type ytl1: str + +:param ytl2: Sets yticlabels2 property of the object. +:type ytl2: str + +""" self.yticlabels1 = ytl1 self.yticlabels2 = ytl2 yticlabels.__doc__ = xmldocs.yticlabelsdoc def ymtics(self, ymt1='', ymt2=''): + """ + Sets ymtics1 and ymtics2 properties of the object. + +:param ymt1: Sets ymtics1 property of the object. +:type ymt1: str + +:param ymt2: Sets ymtics2 property of the object. +:type ymt2: str +""" self.ymtics1 = ymt1 self.ymtics2 = ymt2 - ymtics.__doc__ = xmldocs.ymticsdoc + #ymtics.__doc__ = xmldocs.ymticsdoc def datawc(self, dsp1=1e20, dsp2=1e20, dsp3=1e20, dsp4=1e20): + """ + Sets datawc properties of the object. + +:param dsp1: Sets the datawc_y1 property of the object. +:type dsp1: ??? + +:param dsp2: Sets the datawc_y2 property of the object. +:type dsp2: ??? + +:param dsp3: Sets the datawc_x1 property of the object. +:type dsp3: ??? + +:param dsp4: Sets the datawc_x2 property of the object. +:type dsp4: ??? + +""" self.datawc_y1 = dsp1 self.datawc_y2 = dsp2 self.datawc_x1 = dsp3 self.datawc_x2 = dsp4 - datawc.__doc__ = xmldocs.datawcdoc + #datawc.__doc__ = xmldocs.datawcdoc def xyscale(self, xat='linear', yat='linear'): + """ + Sets xaxisconvert and yaxisconvert properties of the object. + +:param xat: +:type xat: + +:param yat: +:type yat: + +:returns: +:rtype: + """ self.xaxisconvert = xat self.yaxisconvert = yat - xyscale.__doc__ = xmldocs.xyscaledoc + #xyscale.__doc__ = xmldocs.xyscaledoc def getlevels(self, varmin, varmax): if self.boxfill_type == "custom": @@ -858,27 +945,34 @@ def list(self): def script(self, script_filename, mode='a'): """ %s - Function: script # Calls _vcs.scriptGfb - - Description of Function: - Saves out a boxfill graphics method in Python or VCS script form to a - designated file. - - Example of Use: - script(scriptfile_name, mode) - where: scriptfile_name is the output name of the script file. - mode is either "w" for replace or "a" for append. + Saves out a boxfill graphics method in Python or VCS script form to a + designated file. Note: If the the filename has a ".py" at the end, it will produce a Python script. If the filename has a ".scr" at the end, it will produce a VCS script. If neither extensions are give, then by default a Python script will be produced. + :Example: + +:: + a=vcs.init() box=a.createboxfill('temp') - box.script('filename.py') # Append to a Python file "filename.py" - box.script('filename.scr') # Append to a VCS file "filename.scr" + # Append to a Python script named "filename.py" + box.script('filename.py') + # Append to a VCS script named "filename.scr" + box.script('filename.scr') box.script('filename','w') + +:param script_filename: Output name of the script file. If no extension is specified, a .json object is created. +:type script_filename: str + +:param mode: Either 'w' for replace, or 'a' for append. Defaults to 'a', if not specified. +:type mode: str + +:returns: +:rtype: """ if (script_filename is None): raise ValueError( diff --git a/Packages/vcs/vcs/manageElements.py b/Packages/vcs/vcs/manageElements.py index e8475d6346..fc3083534c 100644 --- a/Packages/vcs/vcs/manageElements.py +++ b/Packages/vcs/vcs/manageElements.py @@ -2666,27 +2666,37 @@ def removeP(obj): def removeobject(obj): """ -Function: remove - -Description of Function: -The user has the ability to create primary and secondary class -objects. The function allows the user to remove these objects -from the appropriate class list. - -Note, To remove the object completely from Python, remember to -use the "del" function. - -Also note, The user is not allowed to remove a "default" class -object. - -:Example: -a=vcs.init() -line=a.getline('red') # To Modify an existing line object -iso=x.createisoline('dean') # Create an instance of an isoline object -... -x.remove(line) # Removes line object from VCS list -x.remove(iso) # Remove isoline object from VCS list -""" + The user has the ability to create primary and secondary class + objects. The function allows the user to remove these objects + from the appropriate class list. + + Note, To remove the object completely from Python, remember to + use the "del" function. + + Also note, The user is not allowed to remove a "default" class + object. + + :Example: + +:: + + a=vcs.init() + # To Modify an existing line object + line=a.getline('red') + # Create an instance of an isoline object + iso=a.createisoline('dean') + #... + # Removes line object from VCS list + a.remove(line) + # Remove isoline object from VCS list + a.remove(iso) + +:param obj: Any VCS primary or secondary object +:type obj: VCS object + +:returns: String indicating the specified object was removed +:rtype: str + """ if vcs.istemplate(obj): msg = vcs.removeP(obj.name) elif vcs.isgraphicsmethod(obj):