schrodinger.application.livedesign.models2.datamodels.instance module

Classes to represent a LiveDesign model instance i.e. a set of values and inheritance rules corresponding to a model definition.

Many of these classes inherit CompoundParam, which is built upon QtCore.QObject. CompoundParam implements features such as serialization, versioning adapters, and Qt signals. As such, it’s a useful base class for data classes.

class schrodinger.application.livedesign.models2.datamodels.instance.InstanceMetadata(*args, _param_type=<object object>, **kwargs)

Bases: CompoundParam

creator: str

A parameter of the class.

model_owner: str

A parameter of the class.

last_editor: str

A parameter of the class.

date_edited: datetime

A parameter of the class.

date_created: datetime

A parameter of the class.

name: str

A parameter of the class.

description: str

A parameter of the class.

location: str

A parameter of the class.

version: int

A parameter of the class.

authorized_project_ids: list[str]

A parameter of the class.

is_archived: bool

A parameter of the class.

authorized_project_idsChanged

A pyqtSignal emitted by instances of the class.

authorized_project_idsReplaced

A pyqtSignal emitted by instances of the class.

creatorChanged

A pyqtSignal emitted by instances of the class.

creatorReplaced

A pyqtSignal emitted by instances of the class.

date_createdChanged

A pyqtSignal emitted by instances of the class.

date_createdReplaced

A pyqtSignal emitted by instances of the class.

date_editedChanged

A pyqtSignal emitted by instances of the class.

date_editedReplaced

A pyqtSignal emitted by instances of the class.

descriptionChanged

A pyqtSignal emitted by instances of the class.

descriptionReplaced

A pyqtSignal emitted by instances of the class.

is_archivedChanged

A pyqtSignal emitted by instances of the class.

is_archivedReplaced

A pyqtSignal emitted by instances of the class.

last_editorChanged

A pyqtSignal emitted by instances of the class.

last_editorReplaced

A pyqtSignal emitted by instances of the class.

locationChanged

A pyqtSignal emitted by instances of the class.

locationReplaced

A pyqtSignal emitted by instances of the class.

model_ownerChanged

A pyqtSignal emitted by instances of the class.

model_ownerReplaced

A pyqtSignal emitted by instances of the class.

nameChanged

A pyqtSignal emitted by instances of the class.

nameReplaced

A pyqtSignal emitted by instances of the class.

versionChanged

A pyqtSignal emitted by instances of the class.

versionReplaced

A pyqtSignal emitted by instances of the class.

class schrodinger.application.livedesign.models2.datamodels.instance.ChildInheritanceMode

Bases: JsonableEnum

The inheritance mode for static inputs (i.e. non-column inputs)

• MUST_SPECIFY: This var has no value, so the child must specify one.

• FIXED: This var has a value that will be inherited by all children.

• HIDDEN: Same as FIXED, but is hidden from the user.

• OVERRIDABLE: This var has a value that will be inherited by the child,

  and the child may override it.

MUST_SPECIFY = 'MUST-SPECIFY'

FIXED = 'FIXED'

HIDDEN = 'HIDDEN'

OVERRIDABLE = 'OVERRIDABLE'

class schrodinger.application.livedesign.models2.datamodels.instance.InputInst(*args, _param_type=<object object>, **kwargs)

Bases: CompoundParam

name: str

A parameter of the class.

val: str

A parameter of the class.

child_inheritance_mode: ChildInheritanceMode

A parameter of the class.

child_inheritance_modeChanged

A pyqtSignal emitted by instances of the class.

child_inheritance_modeReplaced

A pyqtSignal emitted by instances of the class.

nameChanged

A pyqtSignal emitted by instances of the class.

nameReplaced

A pyqtSignal emitted by instances of the class.

valChanged

A pyqtSignal emitted by instances of the class.

valReplaced

A pyqtSignal emitted by instances of the class.

class schrodinger.application.livedesign.models2.datamodels.instance.ModelInstance(*args, _param_type=<object object>, **kwargs)

Bases: CompoundParam

Variables:

• definition_id – The ID of the model definition on which this instance is based.

• instance_id – The ID of this model instance.

• parent_instance_id – The ID of the parent model instance, if this instance is a child. None if this is the root instance.

• metadata – Metadata for this model instance.

• auto_recalculate – Whether or not this model instance should automatically recalculate when versions change.

• settings – The settings for this model instance.

definition_id: str

A parameter of the class.

instance_id: str

A parameter of the class.

parent_instance_id: str

A parameter of the class.

metadata: InstanceMetadata

A parameter of the class.

auto_recalculate: bool

A parameter of the class.

inputs: list[InputInst]

A parameter of the class.

auto_recalculateChanged

A pyqtSignal emitted by instances of the class.

auto_recalculateReplaced

A pyqtSignal emitted by instances of the class.

definition_idChanged

A pyqtSignal emitted by instances of the class.

definition_idReplaced

A pyqtSignal emitted by instances of the class.

inputsChanged

A pyqtSignal emitted by instances of the class.

inputsReplaced

A pyqtSignal emitted by instances of the class.

instance_idChanged

A pyqtSignal emitted by instances of the class.

instance_idReplaced

A pyqtSignal emitted by instances of the class.

metadataChanged

A pyqtSignal emitted by instances of the class.

metadataReplaced

A pyqtSignal emitted by instances of the class.

parent_instance_idChanged

A pyqtSignal emitted by instances of the class.

parent_instance_idReplaced

A pyqtSignal emitted by instances of the class.