r24493 - /branches/frame_order_cleanup/specific_analyses/frame_order/checks.py -- July 09, 2014 - 14:59

Author: bugman
Date: Wed Jul  9 14:59:32 2014
New Revision: 24493

URL: http://svn.gna.org/viewcvs/relax?rev=24493&view=rev
Log:
Created the specific_analyses.frame_order.checks.check_pivot() function.

This is to check that the pivot point has been set.


Modified:
    branches/frame_order_cleanup/specific_analyses/frame_order/checks.py

Modified: branches/frame_order_cleanup/specific_analyses/frame_order/checks.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/frame_order_cleanup/specific_analyses/frame_order/checks.py?rev=24493&r1=24492&r2=24493&view=diff
==============================================================================
--- branches/frame_order_cleanup/specific_analyses/frame_order/checks.py      
  (original)
+++ branches/frame_order_cleanup/specific_analyses/frame_order/checks.py      
  Wed Jul  9 14:59:32 2014
@@ -25,3 +25,15 @@
 # relax module imports.
 from lib.errors import RelaxError
 
+
+def check_pivot():
+    """Check that the pivot point has been set.
+
+    @raises RelaxError: If the pivot point has not been set.
+    """
+
+    # Check for the pivot_x parameter.
+    if not hasattr(cdp, 'pivot_x'):
+        raise RelaxError("The pivot point has not been set, please use the 
frame_order.pivot user function to define the point.")
+
+