Package schrodinger :: Package application :: Package jaguar :: Module reactiq_keywords :: Class ReactiqKeyword

Class ReactiqKeyword

object --+
         |
        ReactiqKeyword

Instance Methods

[hide private]

__init__(self, name, valid_type, default, description)
x.__init__(...) initializes x; see help(type(x)) for signature

setValue(self, value)
Set to user-defined value.

reset(self)
Reset user-value to NoneType.

bool

isNonDefault(self)
Return True if keyword user-value differs from default value.

validate(self)
Raise MultipleInvalid or ReactiqKeywordException if keyword name/value don't conform to the schema.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

name

valid_type

default

description

value
Return user-set value.

Inherited from object: __class__

Method Details

[hide private]

init(self, name, valid_type, default, description)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:

name (string) - unique name for keyword
valid_type (python type) - keyword type e.g. bool, int
default (<valid_type>) - default keyword value
description (string) - short description of what the keyword does

Overrides: object.__init__

setValue(self, value)

Set to user-defined value.

Parameters:

value (anything)

isNonDefault(self)

Return True if keyword user-value differs from default value. False otherwise.

Returns: bool

validate(self)

Raise MultipleInvalid or ReactiqKeywordException if keyword name/value don't conform to the schema. (i.e. type check)

Property Details

[hide private]

name

Get Method:: unreachable.name(self)

valid_type

Get Method:: unreachable.valid_type(self)

default

Get Method:: unreachable.default(self)

description

Get Method:: unreachable.description(self)

value

Return user-set value. If None, return default value.

Get Method:: unreachable.value(self) - Return user-set value.
Set Method:: unreachable.value(self, value)

Class ReactiqKeyword

__init__(self, name, valid_type, default, description) (Constructor)

setValue(self, value)

isNonDefault(self)

validate(self)

name

valid_type

default

description

value

init(self, name, valid_type, default, description)
(Constructor)