schrodinger.application.models.datamodels.composite module¶

schrodinger.application.models.datamodels.composite.index_by_identity(seq, obj)¶

schrodinger.application.models.datamodels.composite.cast_value_string(value_string: str, type_: InputType)¶

class schrodinger.application.models.datamodels.composite.CompositeInput(*args, _param_type=<object object>, **kwargs)¶

Bases: CompoundParam

input_def: InputDef¶: A parameter of the class.

input_configs: list[InputConfig]¶: A parameter of the class.

getValueString()¶

isInherited() → bool¶

isUnspecified() → bool¶

getLockingAncestor() → InputConfig | None¶

Return the first ancestor InputConfig with a FIXED/HIDDEN constraint.

Returns None if no ancestor has a locking constraint.

isLockedByAncestor() → bool¶: Return True if any ancestor has a constraint that requires inheritance.

getValue()¶

getBottomInputConfig() → InputConfig | None¶

getBottomConstraint() → ChildConstraint¶

The child_constraint of the bottom (last) input config.

Used when creating a new child input config to inherit the parent’s constraint.

getParentConstraint() → ChildConstraint¶

The constraint imposed by the parent configuration on this input.

Used after a child input config has been added to get the constraint imposed on it by its parent (second-to-last in the list).

getName() → str¶

getInputType() → InputType¶

isColumnInput() → bool¶: Return True if this represents a column input.

isEntityInput() → bool¶: Return True if this input is an entity type.

addInputConfig(input_config: InputConfig)¶

input_configsChanged¶: A pyqtSignal emitted by instances of the class.

input_configsReplaced¶: A pyqtSignal emitted by instances of the class.

input_defChanged¶: A pyqtSignal emitted by instances of the class.

input_defReplaced¶: A pyqtSignal emitted by instances of the class.

schrodinger.application.models.datamodels.composite.cast_to_value_string(value, output, row_source_id=None) → str¶

class schrodinger.application.models.datamodels.composite.CompositeOutput(*args, _param_type=<object object>, **kwargs)¶

Bases: CompoundParam

output_def: OutputDef¶: A parameter of the class.

output_configs: list¶: A parameter of the class.

getName() → str¶

getOutputType() → OutputType¶

output_configsChanged¶: A pyqtSignal emitted by instances of the class.

output_configsReplaced¶: A pyqtSignal emitted by instances of the class.

output_defChanged¶: A pyqtSignal emitted by instances of the class.

output_defReplaced¶: A pyqtSignal emitted by instances of the class.

class schrodinger.application.models.datamodels.composite.ConfigLineage(*args, _param_type=<object object>, **kwargs)¶

Bases: CompoundParam

Serializable list of parent configurations in ancestor-to-child order.

Used to store the parent config chain alongside a leaf configuration in LiveDesign, so the entry point can reconstruct the full composite model without needing an authenticated client session.

configs: list[ModelConfiguration]¶: A parameter of the class.

configsChanged¶: A pyqtSignal emitted by instances of the class.

configsReplaced¶: A pyqtSignal emitted by instances of the class.

class schrodinger.application.models.datamodels.composite.CompositeModel(*args, _param_type=<object object>, **kwargs)¶

Bases: CompoundParam

inputs: list[CompositeInput]¶: A parameter of the class.

outputs: list[CompositeOutput]¶: A parameter of the class.

configs: list[ModelConfiguration]¶: A parameter of the class.

__init__(definition: ModelDefinition = None, configs: list[ModelConfiguration] = None, **kwargs)¶

definition: ModelDefinition¶: A parameter of the class.

createInputs()¶

createOutputs()¶

getBottomConfig() → ModelConfiguration | None¶

setRowSource(row_source)¶

getRowSource()¶

setRowSink(row_sink)¶

getRowSink()¶

getParent(config: ModelConfiguration) → ModelInterface¶

addConfigs(configs: list[ModelConfiguration])¶

addConfig(config: ModelConfiguration)¶

validate() → ValidationSummary¶

isRunnable() → bool¶: Return True if the composite model has no validation violations.

getUnspecifiedInputs() → list[CompositeInput]¶: Return list of inputs that have unspecified values.

configsChanged¶: A pyqtSignal emitted by instances of the class.

configsReplaced¶: A pyqtSignal emitted by instances of the class.

definitionChanged¶: A pyqtSignal emitted by instances of the class.

definitionReplaced¶: 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.

isComplete() → bool¶: Return True if all inputs have specified values.

outputsChanged¶: A pyqtSignal emitted by instances of the class.

outputsReplaced¶: A pyqtSignal emitted by instances of the class.