Package schrodinger :: Package application :: Package jaguar :: Package gui :: Module utils :: Class SpinTreatment
[hide private]
[frames] | no frames]

Class SpinTreatment

object --+    
         |    
 enum.Enum --+
             |
            SpinTreatment

An enumeration of the possible spin treatment settings. Enum values correspond to mmjag settings.

Nested Classes [hide private]

Inherited from enum.Enum: _member_type_

Instance Methods [hide private]
bool
unrestrictedAvailable(self)
Does the current spin treatment setting allow for an unrestricted waveform?
 
__nonzero__(self)
 
__format__(self, format_spec)
default object formatter
 
__reduce_ex__(self, proto)
helper for pickle
 
__repr__(self)
repr(x)
 
__str__(self)
str(x)

Inherited from enum.Enum: __dir__, __eq__, __ge__, __gt__, __hash__, __le__, __lt__, __ne__

Inherited from object: __delattr__, __getattribute__, __init__, __reduce__, __setattr__, __sizeof__, __subclasshook__

Static Methods [hide private]

Inherited from enum.Enum: __new__

Class Variables [hide private]
  NA = None
hash(x)
  Restricted = 0
hash(x)
  Unrestricted = 1
  Automatic = 2
  _member_map_ = OrderedDict([('NA', <SpinTreatment.NA: None>), ...
  _member_names_ = ['NA', 'Restricted', 'Unrestricted', 'Automat...
  _value2member_map_ = {None: <SpinTreatment.NA: None>, 0: <Spin...

Inherited from enum.Enum: name, value

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

unrestrictedAvailable(self)

 

Does the current spin treatment setting allow for an unrestricted waveform?

Returns: bool
True for unrestricted or automatic spin treatments. False otherwise.

__format__(self, format_spec)

 

default object formatter

Overrides: object.__format__
(inherited documentation)

__reduce_ex__(self, proto)

 

helper for pickle

Overrides: object.__reduce_ex__
(inherited documentation)

__repr__(self)
(Representation operator)

 

repr(x)

Overrides: object.__repr__
(inherited documentation)

__str__(self)
(Informal representation operator)

 

str(x)

Overrides: object.__str__
(inherited documentation)

Class Variable Details [hide private]

_member_map_

Value:
OrderedDict([('NA', <SpinTreatment.NA: None>), ('Restricted', <SpinTre\
atment.Restricted: 0>), ('Unrestricted', <SpinTreatment.Unrestricted: \
1>), ('Automatic', <SpinTreatment.Automatic: 2>)])

_member_names_

Value:
['NA', 'Restricted', 'Unrestricted', 'Automatic']

_value2member_map_

Value:
{None: <SpinTreatment.NA: None>,
 0: <SpinTreatment.Restricted: 0>,
 1: <SpinTreatment.Unrestricted: 1>,
 2: <SpinTreatment.Automatic: 2>}