Author: bugman
Date: Thu May 10 13:09:20 2012
New Revision: 16185
URL: http://svn.gna.org/viewcvs/relax?rev=16185&view=rev
Log:
Converted the 'size' uf arg arg to 'dim'.
The name 'dim' better reflects what this is!
Modified:
branches/uf_redesign/user_functions/align_tensor.py
branches/uf_redesign/user_functions/diffusion_tensor.py
branches/uf_redesign/user_functions/frame_order.py
branches/uf_redesign/user_functions/molmol.py
branches/uf_redesign/user_functions/n_state_model.py
branches/uf_redesign/user_functions/objects.py
branches/uf_redesign/user_functions/paramag.py
branches/uf_redesign/user_functions/pymol_control.py
Modified: branches/uf_redesign/user_functions/align_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/align_tensor.py?rev=16185&r1=16184&r2=16185&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/align_tensor.py (original)
+++ branches/uf_redesign/user_functions/align_tensor.py Thu May 10 13:09:20
2012
@@ -207,7 +207,7 @@
name = "params",
py_type = "num_tuple",
desc_short = "alignment tensor parameters",
- size = 5,
+ dim = 5,
desc = "The alignment tensor data.",
wiz_read_only = False
)
Modified: branches/uf_redesign/user_functions/diffusion_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/diffusion_tensor.py?rev=16185&r1=16184&r2=16185&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/diffusion_tensor.py (original)
+++ branches/uf_redesign/user_functions/diffusion_tensor.py Thu May 10
13:09:20 2012
@@ -124,7 +124,7 @@
uf.add_keyarg(
name = "params",
py_type = "num_or_num_tuple",
- size = [4, 6],
+ dim = [4, 6],
desc_short = "diffusion tensor parameters",
desc = "The diffusion tensor data."
)
Modified: branches/uf_redesign/user_functions/frame_order.py
URL:
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/frame_order.py?rev=16185&r1=16184&r2=16185&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/frame_order.py (original)
+++ branches/uf_redesign/user_functions/frame_order.py Thu May 10 13:09:20
2012
@@ -130,7 +130,7 @@
uf.add_keyarg(
name = "pivot",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "pivot point",
desc = "The pivot point for the motion (e.g. the position between the 2
domains in PDB coordinates)."
)
Modified: branches/uf_redesign/user_functions/molmol.py
URL:
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/molmol.py?rev=16185&r1=16184&r2=16185&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/molmol.py (original)
+++ branches/uf_redesign/user_functions/molmol.py Thu May 10 13:09:20 2012
@@ -111,7 +111,7 @@
uf.add_keyarg(
name = "colour_start_rgb",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "starting colour (RGB colour array)",
desc = "The starting colour of the linear colour gradient. This is an
RGB colour array with values ranging from 0 to 1. If this is set, then the
starting colour name cannot be given.",
can_be_none = True
@@ -126,7 +126,7 @@
uf.add_keyarg(
name = "colour_end_rgb",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "ending colour (RGB colour array)",
desc = "The ending colour of the linear colour gradient. This is an RGB
colour array with values ranging from 0 to 1. If this is set, then the
ending colour name cannot be given.",
can_be_none = True
@@ -232,7 +232,7 @@
uf.add_keyarg(
name = "colour_start_rgb",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "starting colour (RGB colour array)",
desc = "The starting colour of the linear colour gradient. This is an
RGB colour array with values ranging from 0 to 1. If this is set, then the
starting colour name cannot be given.",
can_be_none = True
@@ -247,7 +247,7 @@
uf.add_keyarg(
name = "colour_end_rgb",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "ending colour (RGB colour array)",
desc = "The ending colour of the linear colour gradient. This is an RGB
colour array with values ranging from 0 to 1. If this is set, then the
ending colour name cannot be given.",
can_be_none = True
Modified: branches/uf_redesign/user_functions/n_state_model.py
URL:
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/n_state_model.py?rev=16185&r1=16184&r2=16185&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/n_state_model.py (original)
+++ branches/uf_redesign/user_functions/n_state_model.py Thu May 10 13:09:20
2012
@@ -44,14 +44,14 @@
name = "pivot_point",
default = [0.0, 0.0, 0.0],
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "pivot point",
desc = "The pivot point of the motions between the two domains."
)
uf.add_keyarg(
name = "centre",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "centre of mass",
desc = "The optional argument for manually specifying the CoM of the
initial position prior to the N rotations to the positions of the N states.",
can_be_none = True
Modified: branches/uf_redesign/user_functions/objects.py
URL:
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/objects.py?rev=16185&r1=16184&r2=16185&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/objects.py (original)
+++ branches/uf_redesign/user_functions/objects.py Thu May 10 13:09:20 2012
@@ -181,7 +181,7 @@
self.__dict__[name] = value
- def add_keyarg(self, name=None, default=None, py_type=None,
arg_type=None, size=None, min=0, max=1000, desc_short=None, desc=None,
list_titles=None, wiz_element_type='default', wiz_combo_choices=[],
wiz_combo_data=None, wiz_combo_iter=None, wiz_combo_list_size=None,
wiz_read_only=None, can_be_none=False, can_be_empty=False,
none_elements=False):
+ def add_keyarg(self, name=None, default=None, py_type=None,
arg_type=None, dim=None, min=0, max=1000, desc_short=None, desc=None,
list_titles=None, wiz_element_type='default', wiz_combo_choices=[],
wiz_combo_data=None, wiz_combo_iter=None, wiz_combo_list_size=None,
wiz_read_only=None, can_be_none=False, can_be_empty=False,
none_elements=False):
"""Wrapper method for adding keyword argument information to the
container.
@keyword name: The name of the argument.
@@ -195,8 +195,8 @@
- 'dir' will cause the argument
to not be shown in certain UIs, as this indicates that the user function
already has a 'file sel' type argument and hence a directory is not required.
- 'dir sel' will indicate to
certain UIs that a dir selection dialog is required.
@type arg_type: str
- @keyword size: The dimensions that a list or tuple
must conform to. For a 1D sequence, this can be a single value or a tuple of
possible sizes. For a 2D sequence (a numpy matrix or list of lists), this
must be a tuple of the fixed dimension sizes, e.g. a 3x5 matrix should be
specified as (3, 5).
- @type size: int, tuple of int or None
+ @keyword dim: The fixed dimensions that a list or
tuple must conform to. For a 1D sequence, this can be a single value or a
tuple of possible sizes. For a 2D sequence (a numpy matrix or list of
lists), this must be a tuple of the fixed dimension sizes, e.g. a 3x5 matrix
should be specified as (3, 5).
+ @type dim: int, tuple of int or None
@keyword min: The minimum value allowed for
integer types. This is used in the wx.SpinCtrl for example.
@type min: int
@keyword max: The maximum value allowed for
integer types. This is used in the wx.SpinCtrl for example.
@@ -246,7 +246,7 @@
arg['default'] = default
arg['py_type'] = py_type
arg['arg_type'] = arg_type
- arg['size'] = size
+ arg['dim'] = dim
arg['min'] = min
arg['max'] = max
arg['desc_short'] = desc_short
Modified: branches/uf_redesign/user_functions/paramag.py
URL:
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/paramag.py?rev=16185&r1=16184&r2=16185&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/paramag.py (original)
+++ branches/uf_redesign/user_functions/paramag.py Thu May 10 13:09:20 2012
@@ -43,7 +43,7 @@
uf.add_keyarg(
name = "pos",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "atomic position",
desc = "The atomic position of the paramagnetic centre.",
can_be_none = True
Modified: branches/uf_redesign/user_functions/pymol_control.py
URL:
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/pymol_control.py?rev=16185&r1=16184&r2=16185&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/pymol_control.py (original)
+++ branches/uf_redesign/user_functions/pymol_control.py Thu May 10 13:09:20
2012
@@ -175,7 +175,7 @@
uf.add_keyarg(
name = "colour_start_rgb",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "starting colour (RGB colour array)",
desc = "The starting colour of the linear colour gradient. This is an
RGB colour array with values ranging from 0 to 1. If this is set, then the
starting colour name cannot be given.",
can_be_none = True
@@ -190,7 +190,7 @@
uf.add_keyarg(
name = "colour_end_rgb",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "ending colour (RGB colour array)",
desc = "The ending colour of the linear colour gradient. This is an RGB
colour array with values ranging from 0 to 1. If this is set, then the
ending colour name cannot be given.",
can_be_none = True
@@ -296,7 +296,7 @@
uf.add_keyarg(
name = "colour_start_rgb",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "starting colour (RGB colour array)",
desc = "The starting colour of the linear colour gradient. This is an
RGB colour array with values ranging from 0 to 1. If this is set, then the
starting colour name cannot be given.",
can_be_none = True
@@ -311,7 +311,7 @@
uf.add_keyarg(
name = "colour_end_rgb",
py_type = "num_list",
- size = 3,
+ dim = 3,
desc_short = "ending colour (RGB colour array)",
desc = "The ending colour of the linear colour gradient. This is an RGB
colour array with values ranging from 0 to 1. If this is set, then the
ending colour name cannot be given.",
can_be_none = True
r16185 - /branches/uf_redesign/user_functions/