StructuralModel¶
This library defines structural models.
SAMSON API: The SBMStructuralModel Library
-
class
samson.Modeling.StructuralModel.
Atom
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.NodeParticle
This class describes an atom in a structural model
SAMSON API: SBMStructuralModelNodeAtom
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Atom) -> None
Constructs an atom of a default type (default position = (0,0,0))
- __init__(self: samson.Modeling.StructuralModel.Atom, element: samson.Modeling.Element.Element.ElementType) -> None
Constructs an atom of a given type (default position = (0,0,0))
- __init__(self: samson.Modeling.StructuralModel.Atom, element: samson.Modeling.Element.Element.ElementType, x: samson.DataModel.Quantity.unitsSI, y: samson.DataModel.Quantity.unitsSI, z: samson.DataModel.Quantity.unitsSI) -> None
Constructs an atom of a given type at position = (x,y,z)
- __init__(self: samson.Modeling.StructuralModel.Atom, element: samson.Modeling.Element.Element.ElementType, p: samson.DataModel.Type.vector3) -> None
Constructs an atom of a given type at position p
- __init__(self: samson.Modeling.StructuralModel.Atom, element: samson.Modeling.Element.Element.ElementType, n: str, p: samson.DataModel.Type.vector3) -> None
Constructs an atom of a given type with name n at position p
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=0) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearAltLocation
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s alternate location
-
clearAnisotropicTFactors
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s AnisotropicTFactors
-
clearAromaticity
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s Aromaticity
-
clearChain
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s chain
-
clearChainID
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s ChainID
-
clearComment
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s Comment
-
clearCustomType
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s CustomType
-
clearFormalCharge
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s FormalCharge
-
clearHybridization
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s Hybridization
-
clearInsertionCode
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s insertion code
-
clearMoleculeName
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s MoleculeName
-
clearName
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s full name
-
clearOccupancy
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s occupancy
-
clearOxydationState
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s OxydationState
-
clearPartialCharge
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s PartialCharge
-
clearRecordType
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s RecordType
-
clearResidueName
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s ResidueName
-
clearResidueSequenceNumber
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s ResidueSequenceNumber
-
clearResonance
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s Resonance
-
clearSYBYLType
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s SYBYLType
-
clearSegment
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s Segment
-
clearSerialNumber
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s serial number
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s StatusBit
-
clearSubstructureName
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s SubstructureName
-
clearSubstructureSequenceNumber
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s SubstructureSequenceNumber
-
clearTemperatureFactor
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s TemperatureFactor
-
clearWaterFlag
(self: samson.Modeling.StructuralModel.Atom) → None¶ Clears the atom’s WaterFlag
-
clone
(self: samson.Modeling.StructuralModel.Atom) → samson.Modeling.StructuralModel.Atom¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getBondList
(self: samson.Modeling.StructuralModel.Atom) → SBCReferencePointerList<SBMStructuralModelNodeBond, SBCReferenceToTarget>¶ Returns the bond list
-
getBondTo
(self: samson.Modeling.StructuralModel.Atom, atom: samson.Modeling.StructuralModel.Atom) → SBMStructuralModelNodeBond¶ Returns the bond to an atom (0 if no bond)
-
getChain
(self: samson.Modeling.StructuralModel.Atom) → str¶ Returns the atom’s chain
-
getChildren
(self: samson.Modeling.StructuralModel.Node) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getComment
(self: samson.Modeling.StructuralModel.Atom) → str¶ Returns the atom’s comment
-
getConnectedComponent
(self: samson.Modeling.StructuralModel.Atom) → samson.DataModel.DataGraph.NodeIndexer¶ Gets all atoms in the connected component containing the atom
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getMoleculeName
(self: samson.Modeling.StructuralModel.Atom) → str¶ Returns the atom’s moleculeName
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → SBDDataGraphNodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPosition
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Type.vector3¶
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRecordType
(self: samson.Modeling.StructuralModel.Atom) → str¶ Returns the atom’s recordType
-
getResidueName
(self: samson.Modeling.StructuralModel.Atom) → str¶ Returns the atom’s residueName
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
getSYBYLType
(self: samson.Modeling.StructuralModel.Atom) → str¶ Returns the atom’s SYBYLType
-
getSegment
(self: samson.Modeling.StructuralModel.Atom) → str¶ Returns the atom’s segment
-
getStatusBit
(self: samson.Modeling.StructuralModel.Atom) → str¶ Returns the atom’s statusBit
-
getSubstructureName
(self: samson.Modeling.StructuralModel.Atom) → str¶ Returns the atom’s substructureName
-
getX
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Quantity.unitsSI¶
-
getY
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Quantity.unitsSI¶
-
getZ
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Quantity.unitsSI¶
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node) → bool¶ Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setChain
(self: samson.Modeling.StructuralModel.Atom, chain: str, size: int) → None¶ Set the atom’s chain
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setComment
(self: samson.Modeling.StructuralModel.Atom, comment: str, size: int) → None¶ Set the atom’s comment
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMoleculeName
(self: samson.Modeling.StructuralModel.Atom, moleculeName: str, size: int) → None¶ Set the atom’s moleculeName
-
setPosition
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Type.vector3) → None¶
-
setRecordType
(self: samson.Modeling.StructuralModel.Atom, recordType: str, size: int) → None¶ Set the atom’s RecordType
-
setResidueName
(self: samson.Modeling.StructuralModel.Atom, residueName: str, size: int) → None¶ Set the atom’s residueName
-
setSYBYLType
(self: samson.Modeling.StructuralModel.Atom, SYBYLType: str, size: int) → None¶ Set the atom’s SYBYLType
-
setSegment
(self: samson.Modeling.StructuralModel.Atom, segment: str, size: int) → None¶ Set the atom’s segment
-
setStatusBit
(self: samson.Modeling.StructuralModel.Atom, statusBit: str, size: int) → None¶ Set the atom’s statusBit
-
setSubstructureName
(self: samson.Modeling.StructuralModel.Atom, substructureName: str, size: int) → None¶ Set the atom’s substructureName
-
setX
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Quantity.unitsSI) → None¶
-
setY
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Quantity.unitsSI) → None¶
-
setZ
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Quantity.unitsSI) → None¶
-
sprint
(self: samson.Modeling.StructuralModel.NodeParticle, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Atom) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
SYBYLTypeSize
¶ atom’s SYBYLType size
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
alternateLocation
¶ atom’s alternate location
-
anisotropicTFactors
¶ atom’s AnisotropicTFactors
-
aromaticity
¶ atom’s Aromaticity
-
atomicWeight
¶
-
block
¶
-
chainID
¶ atom’s ChainID
-
chainSize
¶ atom’s chain size
-
commentSize
¶ atom’s comment size
-
covalentRadius
¶
-
customType
¶ atom’s CustomType
-
electronegativity
¶
-
elementName
¶
-
elementSymbol
¶
-
elementType
¶
-
formalCharge
¶ atom’s FormalCharge
-
group
¶
-
hasAltLocation
¶ Returns true when the atom’s alternate location is set
-
hasAnisotropicTFactors
¶ Returns true when the atom’s AnisotropicTFactors is set
-
hasAromaticity
¶ Returns true when the atom’s Aromaticity is set
-
hasChain
¶ Returns true when the atom’s chain is set
-
hasChainID
¶ Returns true when the atom’s ChainID is set
-
hasComment
¶ Returns true when the atom’s Comment is set
-
hasCustomType
¶ Returns true when the atom’s CustomType is set
-
hasFormalCharge
¶ Returns true when the atom’s FormalCharge is set
-
hasHybridization
¶ Returns true when the atom’s Hybridization is set
-
hasInsertionCode
¶ Returns true when the atom’s insertion code is set
-
hasMoleculeName
¶ Returns true when the atom’s MoleculeName is set
-
hasName
¶ Returns true when the atom’s name is set
-
hasOccupancy
¶ Returns true when the atom’s occupancy is set
-
hasOxydationState
¶ Returns true when the atom’s OxydationState is set
-
hasPartialCharge
¶ Returns true when the atom’s PartialCharge is set
-
hasRecordType
¶ Returns true when the atom’s RecordType is set
-
hasResidueName
¶ Returns true when the atom’s ResidueName is set
-
hasResidueSequenceNumber
¶ Returns true when the atom’s ResidueSequenceNumber is set
-
hasResonance
¶ Returns true when the atom’s Resonance is set
-
hasSYBYLType
¶ Returns true when the atom’s SYBYLType is set
-
hasSegment
¶ Returns true when the atom’s Segment is set
-
hasSerialNumber
¶ Returns true when the atom’s serial number is set
-
hasStatusBit
¶ Returns true when the atom’s statusBit is set
-
hasSubstructureName
¶ Returns true when the atom’s SubstructureName is set
-
hasSubstructureSequenceNumber
¶ Returns true when the atom’s SubstructureSequenceNumber is set
-
hasTemperatureFactor
¶ Returns true when the atom’s TemperatureFactor is set
-
hasWaterFlag
¶ Returns true when the atom’s WaterFlag is set
-
highlightingFlag
¶
-
hybridization
¶ atom’s Hybridization
-
insertionCode
¶ atom’s insertion code
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isFromAminoAcidBackbone
¶ Returns true when the atom is from an amino-acid backbone
-
isFromNucleicAcidBackbone
¶ Returns true when the atom is from a nucleic acid backbone
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
moleculeNameSize
¶ atom’s moleculeName size
-
name
¶ atom’s full name
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
occupancy
¶ atom’s occupancy
-
oxydationState
¶ atom’s OxydationState
-
partialCharge
¶ atom’s PartialCharge
-
period
¶
-
recordTypeSize
¶ atom’s RecordType size
-
residueNameSize
¶ atom’s residue name size
-
residueSequenceNumber
¶ atom’s ResidueSequenceNumber
-
resonance
¶ atom’s Resonance
-
segmentSize
¶ atom’s segment size
-
selectionFlag
¶
-
serialNumber
¶ atom’s serial number
-
statusBitSize
¶ atom’s statusBit size
-
substructureNameSize
¶ atom’s substructureName size
-
substructureSequenceNumber
¶ atom’s SubstructureSequenceNumber
-
temperatureFactor
¶ atom’s TemperatureFactor
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
vanDerWaalsRadius
¶
-
visibilityFlag
¶
-
waterFlag
¶ atom’s WaterFlag
-
class
samson.Modeling.StructuralModel.
Backbone
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.Group
This class describes a residue backbone
SAMSON API: SBMStructuralModelNodeBackbone
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Backbone) -> None
Constructs a residue backbone
- __init__(self: samson.Modeling.StructuralModel.Backbone, s: str) -> None
Constructs a residue backbone
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Backbone, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=None) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearComment
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s Comment
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s status bit
-
clone
(self: samson.Modeling.StructuralModel.Backbone) → samson.Modeling.StructuralModel.Backbone¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getAlphaCarbon
(self: samson.Modeling.StructuralModel.Backbone) → samson.Modeling.StructuralModel.Atom¶ Returns the alpha carbon of an amino-acid backbone
-
getCarbon
(self: samson.Modeling.StructuralModel.Backbone) → samson.Modeling.StructuralModel.Atom¶ Returns the carbon of an amino-acid backbone
-
getChildren
(self: samson.Modeling.StructuralModel.Group) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNitrogen
(self: samson.Modeling.StructuralModel.Backbone) → samson.Modeling.StructuralModel.Atom¶ Returns the nitrogen of an amino-acid backbone
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getOxygen
(self: samson.Modeling.StructuralModel.Backbone) → samson.Modeling.StructuralModel.Atom¶ Returns the oxygen of an amino-acid backbone
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(*args, **kwargs)¶ Overloaded function.
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.DataModel.DataGraph.Node) -> bool
Removes a child from the node
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.Modeling.StructuralModel.Node) -> bool
Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Group, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Backbone) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
comment
¶ group’s comment
-
hasComment
¶ Returns true when the group’s Comment is set
-
hasStatusBit
¶ Returns true when the group’s status bit is set
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
name
¶ name of the model
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
statusBit
¶ group’s status bit
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
Bond
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.Node
This class describes a bond in a structural model
SAMSON API: SBMStructuralModelNodeBond
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Bond) -> None
Constructs a bond
- __init__(self: samson.Modeling.StructuralModel.Bond, leftAtom: samson.Modeling.StructuralModel.Atom, rightAtom: samson.Modeling.StructuralModel.Atom, order: samson.DataModel.Quantity.unitsSI=1.000000 (dimensionless)) -> None
Constructs a bond between atoms leftAtom and rightAtom and a specific bond order
-
class
BondType
(self: samson.Modeling.StructuralModel.Bond.BondType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.Modeling.StructuralModel.Bond.BondType, arg0: samson.Modeling.StructuralModel.Bond.BondType) -> bool
- __eq__(self: samson.Modeling.StructuralModel.Bond.BondType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.Modeling.StructuralModel.Bond.BondType, arg0: samson.Modeling.StructuralModel.Bond.BondType) -> bool
- __ne__(self: samson.Modeling.StructuralModel.Bond.BondType, arg0: int) -> bool
-
Amide
= BondType.Amide¶
-
Aromatic
= BondType.Aromatic¶
-
Double
= BondType.Double¶
-
Dummy
= BondType.Dummy¶
-
Single
= BondType.Single¶
-
Triple
= BondType.Triple¶
-
Undefined
= BondType.Undefined¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=0) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearCustomType
(self: samson.Modeling.StructuralModel.Bond) → None¶ Clears the bond’s custom type
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Bond) → None¶ Clears the bond’s status bit
-
clone
(self: samson.Modeling.StructuralModel.Bond) → samson.Modeling.StructuralModel.Bond¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Node) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getOppositeAtom
(self: samson.Modeling.StructuralModel.Bond, atom: samson.Modeling.StructuralModel.Atom) → samson.Modeling.StructuralModel.Atom¶ Returns the pointer to the atom opposite atom, when atom is either the left atom or the right atom of the bond
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isLinking
(self: samson.Modeling.StructuralModel.Bond, nodeIndexer: samson.DataModel.DataGraph.NodeIndexer) → bool¶ Returns true if and only if either atom is in nodeIndexer, or descends from a node of nodeIndexer
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node) → bool¶ Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Bond, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Bond) → str¶ Converts to a string
-
Amide
= BondType.Amide¶
-
Aromatic
= BondType.Aromatic¶
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
Double
= BondType.Double¶
-
Dummy
= BondType.Dummy¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
Single
= BondType.Single¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Triple
= BondType.Triple¶
-
Undefined
= BondType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
bondType
¶ Bond type
-
bondTypeString
¶ Returns the string corresponding to the bondType
-
customType
¶ bond’s custom type
-
hasCustomType
¶ Returns true when the bond’s custom type is set
-
hasStatusBit
¶ Returns true when the bond’s status bit is set
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
leftAtom
¶ Returns a pointer to the left atom
-
length
¶ Compute the length of the bond
-
midPoint
¶ Compute the mid point of the bond
-
mobilityFlag
¶
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
order
¶ Bond order
-
rightAtom
¶ Returns a pointer to the right atom
-
selectionFlag
¶
-
statusBit
¶ bond’s status bit
-
type
¶ Returns the node type
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
Chain
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.Group
This class describes a chain in a structural model
SAMSON API: SBMStructuralModelNodeChain
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Chain) -> None
Constructs a chain
- __init__(self: samson.Modeling.StructuralModel.Chain, arg0: str) -> None
Constructs a chain
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Chain, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=None) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearComment
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s Comment
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s status bit
-
clone
(self: samson.Modeling.StructuralModel.Chain) → samson.Modeling.StructuralModel.Chain¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Group) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(*args, **kwargs)¶ Overloaded function.
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.DataModel.DataGraph.Node) -> bool
Removes a child from the node
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.Modeling.StructuralModel.Node) -> bool
Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Group, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Chain) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
comment
¶ group’s comment
-
hasComment
¶ Returns true when the group’s Comment is set
-
hasStatusBit
¶ Returns true when the group’s status bit is set
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
name
¶ name of the model
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
statusBit
¶ group’s status bit
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
Conformation
(*args, **kwargs)¶ Bases:
samson.DataModel.DataGraph.Node
This class describes a structural conformation.
SAMSON API: SBMStructuralModelConformation
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Conformation) -> None
Constructs a structural conformation
- __init__(self: samson.Modeling.StructuralModel.Conformation, s: str, nodeIndexer: samson.DataModel.DataGraph.NodeIndexer) -> None
Constructs a structural conformation
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node=None) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clone
(self: samson.Modeling.StructuralModel.Conformation) → samson.Modeling.StructuralModel.Conformation¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getAtomIndexer
(self: samson.Modeling.StructuralModel.Conformation) → SBCReferencePointerIndexer<SBMStructuralModelNodeParticle, SBCReferenceToTarget>¶ Returns the indexer of structural particles for which a position is saved
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getNextConformation
(self: samson.Modeling.StructuralModel.Conformation) → samson.Modeling.StructuralModel.Conformation¶ Returns the next conformation in the document
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getNumberOfPositions
(self: samson.Modeling.StructuralModel.Conformation) → int¶ Returns the number of particles for which a position is saved
-
getParent
(self: samson.Modeling.StructuralModel.Conformation) → samson.DataModel.DataGraph.Node¶ Returns the parent of the node
-
getPosition
(*args, **kwargs)¶ Overloaded function.
- getPosition(self: samson.Modeling.StructuralModel.Conformation, structuralParticleIndex: int) -> samson.DataModel.Type.vector3
Retrieves the position of structural particle structuralParticleIndex
- getPosition(self: samson.Modeling.StructuralModel.Conformation, structuralParticle: SBMStructuralModelNodeParticle) -> samson.DataModel.Type.vector3
Retrieves the position of structural particle structuralParticle
-
getPreviousConformation
(self: samson.Modeling.StructuralModel.Conformation) → samson.Modeling.StructuralModel.Conformation¶ Returns the previous conformation in the document
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) → bool¶ Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
restore
(self: samson.Modeling.StructuralModel.Conformation) → None¶ Restores the conformation
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setPosition
(*args, **kwargs)¶ Overloaded function.
- setPosition(self: samson.Modeling.StructuralModel.Conformation, structuralParticleIndex: int, structuralParticlePosition: samson.DataModel.Type.vector3) -> None
Sets the position of structural particle structuralParticleIndex
- setPosition(self: samson.Modeling.StructuralModel.Conformation, structuralParticle: SBMStructuralModelNodeParticle, structuralParticlePosition: samson.DataModel.Type.vector3) -> None
Sets the position of structural particle structuralParticle
-
sprint
(self: samson.DataModel.DataGraph.Node, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Conformation) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
name
¶ name of the conformation
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
Grid
(self: samson.Modeling.StructuralModel.Grid, arg0: samson.DataModel.DataGraph.NodeIndexer, arg1: samson.DataModel.Quantity.unitsSI) → None¶ Bases:
samson.Core.Reference.SBCReferenceTarget
This class describes a grid-based neighbor search algorithm that can be applied to structural particles (atoms or pseudo-atoms).
SAMSON API: SBMStructuralModelGrid
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getNeighborIndexer
(*args, **kwargs)¶ Overloaded function.
- getNeighborIndexer(self: samson.Modeling.StructuralModel.Grid, i: int) -> SBCContainerIndexer<SBMStructuralModelNodeParticle*, SBCContainerHashMap<SBMStructuralModelNodeParticle*, unsigned int, SBCContainerHashMapFunctor<SBMStructuralModelNodeParticle*>, SBCContainerHashMapKeyComparator<SBMStructuralModelNodeParticle*> >, SBCContainerVector<SBMStructuralModelNodeParticle*> >
Returns the neighbor indexer of structural particle i
- getNeighborIndexer(self: samson.Modeling.StructuralModel.Grid, structuralParticle: SBMStructuralModelNodeParticle) -> SBCContainerIndexer<SBMStructuralModelNodeParticle*, SBCContainerHashMap<SBMStructuralModelNodeParticle*, unsigned int, SBCContainerHashMapFunctor<SBMStructuralModelNodeParticle*>, SBCContainerHashMapKeyComparator<SBMStructuralModelNodeParticle*> >, SBCContainerVector<SBMStructuralModelNodeParticle*> >
Returns the neighbor indexer of structural particle structuralParticle
-
sprint
(self: samson.Modeling.StructuralModel.Grid, offset: int=0) → None¶ Prints some debugging information
-
update
(self: samson.Modeling.StructuralModel.Grid) → None¶ Updates the grid and neighbor lists
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
-
class
samson.Modeling.StructuralModel.
Group
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.Node
This class describes a structural group
SAMSON API: SBMStructuralModelNodeGroup
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Group) -> None
Constructs a structural group
- __init__(self: samson.Modeling.StructuralModel.Group, arg0: str) -> None
Constructs a structural group
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(*args, **kwargs)¶ Overloaded function.
- addChild(self: samson.Modeling.StructuralModel.Group, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node=None) -> bool
Adds a child to the node
- addChild(self: samson.Modeling.StructuralModel.Group, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=None) -> bool
Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearComment
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s Comment
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s status bit
-
clone
(self: samson.Modeling.StructuralModel.Group) → samson.Modeling.StructuralModel.Group¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Group) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(*args, **kwargs)¶ Overloaded function.
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.DataModel.DataGraph.Node) -> bool
Removes a child from the node
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.Modeling.StructuralModel.Node) -> bool
Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Group, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Group) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
comment
¶ group’s comment
-
hasComment
¶ Returns true when the group’s Comment is set
-
hasStatusBit
¶ Returns true when the group’s status bit is set
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
name
¶ name of the model
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
statusBit
¶ group’s status bit
-
type
¶ Returns the node type
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
Molecule
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.Group
This class describes a molecule in a structural model
SAMSON API: SBMStructuralModelNodeMolecule
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Molecule) -> None
Constructs a molecule
- __init__(self: samson.Modeling.StructuralModel.Molecule, arg0: str) -> None
Constructs a molecule
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Molecule, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=None) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearComment
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s Comment
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s status bit
-
clone
(self: samson.Modeling.StructuralModel.Molecule) → samson.Modeling.StructuralModel.Molecule¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Group) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(*args, **kwargs)¶ Overloaded function.
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.DataModel.DataGraph.Node) -> bool
Removes a child from the node
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.Modeling.StructuralModel.Node) -> bool
Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Group, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Molecule) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
comment
¶ group’s comment
-
hasComment
¶ Returns true when the group’s Comment is set
-
hasStatusBit
¶ Returns true when the group’s status bit is set
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
name
¶ name of the model
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
statusBit
¶ group’s status bit
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
Node
¶ Bases:
samson.Modeling.Model.SBMModelNode
This class describes a structural model node
SAMSON API: SBMStructuralModelNode
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=0) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clone
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Node) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → SBDDataGraphNodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node) → bool¶ Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Node, offset: int=0) → None¶ Prints some debugging information
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
type
¶ the data graph node type
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
-
class
samson.Modeling.StructuralModel.
NodeParticle
¶ Bases:
samson.Modeling.StructuralModel.Node
This class describes a particle (atom or pseudo-atom) in a structural model
SAMSON API: SBMStructuralModelNodeParticle
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=0) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clone
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Node) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → SBDDataGraphNodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPosition
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Type.vector3¶
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
getX
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Quantity.unitsSI¶
-
getY
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Quantity.unitsSI¶
-
getZ
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Quantity.unitsSI¶
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node) → bool¶ Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setPosition
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Type.vector3) → None¶
-
setX
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Quantity.unitsSI) → None¶
-
setY
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Quantity.unitsSI) → None¶
-
setZ
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Quantity.unitsSI) → None¶
-
sprint
(self: samson.Modeling.StructuralModel.NodeParticle, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.NodeParticle) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
type
¶ Returns the node type
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
-
class
samson.Modeling.StructuralModel.
Path
(*args, **kwargs)¶ Bases:
samson.DataModel.DataGraph.Node
This class describes a structural path
SAMSON API: sbmstructuralmodelpath
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Path) -> None
Constructs a structural model path
- __init__(self: samson.Modeling.StructuralModel.Path, name: str, nodeIndexer: samson.DataModel.DataGraph.NodeIndexer) -> None
Constructs a structural model path with name from the nodes in nodeIndexer
-
class
AnimationType
(self: samson.Modeling.StructuralModel.Path.AnimationType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.Modeling.StructuralModel.Path.AnimationType, arg0: samson.Modeling.StructuralModel.Path.AnimationType) -> bool
- __eq__(self: samson.Modeling.StructuralModel.Path.AnimationType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.Modeling.StructuralModel.Path.AnimationType, arg0: samson.Modeling.StructuralModel.Path.AnimationType) -> bool
- __ne__(self: samson.Modeling.StructuralModel.Path.AnimationType, arg0: int) -> bool
-
Bounce
= AnimationType.Bounce¶
-
Loop
= AnimationType.Loop¶
-
Once
= AnimationType.Once¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node=None) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clone
(self: samson.Modeling.StructuralModel.Path) → samson.Modeling.StructuralModel.Path¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getDocument
(self: samson.Modeling.StructuralModel.Path) → samson.DataModel.Document.Document¶ Returns the document which owns the path
-
getEnergy
(self: samson.Modeling.StructuralModel.Path, step: int) → samson.DataModel.Quantity.unitsSI¶ Returnes the energy for a specific step
-
getEnergyArray
(self: samson.Modeling.StructuralModel.Path) → List[samson.DataModel.Quantity.unitsSI]¶ Returnes the energy array: 1D array, size = number of timesteps
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getForce
(*args, **kwargs)¶ Overloaded function.
- getForce(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int) -> samson.DataModel.Type.vector3
Returnes the force of structural particle structuralParticleIndex for a specific step
- getForce(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.NodeParticle) -> samson.DataModel.Type.vector3
Returnes the force of structural particle structuralParticle for a specific step
-
getForceArray
(self: samson.Modeling.StructuralModel.Path) → List[List[samson.DataModel.Type.vector3]]¶ Returns the force array: 2D array, size = (number of timesteps) x (number of structural nodes)
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getNextPath
(self: samson.Modeling.StructuralModel.Path) → samson.Modeling.StructuralModel.Path¶ Returns the next path in the document
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → SBDDataGraphNodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Path) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the path
-
getPosition
(*args, **kwargs)¶ Overloaded function.
- getPosition(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int) -> samson.DataModel.Type.vector3
Returnes the position of structural particle structuralParticleIndex for a specific step
- getPosition(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.NodeParticle) -> samson.DataModel.Type.vector3
Returnes the position of structural particle structuralParticle for a specific step
-
getPositionArray
(self: samson.Modeling.StructuralModel.Path) → List[List[samson.DataModel.Type.vector3]]¶ Returns the position array: 2D array, size = (number of timesteps) x (number of structural nodes)
-
getPreviousPath
(self: samson.Modeling.StructuralModel.Path) → samson.Modeling.StructuralModel.Path¶ Returns the previous path in the document
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
getStructuralParticleIndexer
(self: samson.Modeling.StructuralModel.Path) → samson.DataModel.DataGraph.NodeIndexer¶ Returns the indexer of structural particles for which a position is saved
-
getTime
(self: samson.Modeling.StructuralModel.Path, step: int) → samson.DataModel.Quantity.unitsSI¶ Returnes the time for a specific step
-
getTimeArray
(self: samson.Modeling.StructuralModel.Path) → List[samson.DataModel.Quantity.unitsSI]¶ Returnes the time array: 1D array, size = number of timesteps
-
getVelocity
(*args, **kwargs)¶ Overloaded function.
- getVelocity(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int) -> samson.DataModel.Type.vector3
Returnes the velocity of structural particle structuralParticleIndex for a specific step
- getVelocity(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.NodeParticle) -> samson.DataModel.Type.vector3
Returnes the velocity of structural particle structuralParticle for a specific step
-
getVelocityArray
(self: samson.Modeling.StructuralModel.Path) → List[List[samson.DataModel.Type.vector3]]¶ Returns the velocity array: 2D array, size = (number of timesteps) x (number of structural nodes)
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) → bool¶ Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setEnergy
(self: samson.Modeling.StructuralModel.Path, step: int, energy: samson.DataModel.Quantity.unitsSI) → None¶ Sets the energy for a specific step
-
setEnergyArray
(self: samson.Modeling.StructuralModel.Path, energyArray: List[samson.DataModel.Quantity.unitsSI]) → None¶ Sets the energy array: 1D array, size = number of timesteps
-
setForce
(*args, **kwargs)¶ Overloaded function.
- setForce(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int, force: samson.DataModel.Type.vector3) -> None
Sets the force of structural particle structuralParticleIndex to position for a specific step
- setForce(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.NodeParticle, force: samson.DataModel.Type.vector3) -> None
Sets the force of structural particle structuralParticle to position for a specific step
-
setForceArray
(self: samson.Modeling.StructuralModel.Path, forceArray: List[List[samson.DataModel.Type.vector3]]) → None¶ Sets the force array: 2D array, size = (number of timesteps) x (number of structural nodes)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setPosition
(*args, **kwargs)¶ Overloaded function.
- setPosition(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int, position: samson.DataModel.Type.vector3) -> None
Sets the position of structural particle structuralParticleIndex to position for a specific step
- setPosition(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.NodeParticle, position: samson.DataModel.Type.vector3) -> None
Sets the position of structural particle structuralParticle to position for a specific step
-
setPositionArray
(self: samson.Modeling.StructuralModel.Path, positionArray: List[List[samson.DataModel.Type.vector3]]) → None¶ Sets the position array: 2D array, size = (number of timesteps) x (number of structural nodes)
-
setTime
(self: samson.Modeling.StructuralModel.Path, step: int, time: samson.DataModel.Quantity.unitsSI) → None¶ Sets the time for a specific step
-
setTimeArray
(self: samson.Modeling.StructuralModel.Path, timeArray: List[samson.DataModel.Quantity.unitsSI]) → None¶ Sets the time array: 1D array, size = number of timesteps
-
setVelocity
(*args, **kwargs)¶ Overloaded function.
- setVelocity(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int, velocity: samson.DataModel.Type.vector3) -> None
Sets the velocity of structural particle structuralParticleIndex to position for a specific step
- setVelocity(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.NodeParticle, velocity: samson.DataModel.Type.vector3) -> None
Sets the velocity of structural particle structuralParticle to position for a specific step
-
setVelocityArray
(self: samson.Modeling.StructuralModel.Path, velocityArray: List[List[samson.DataModel.Type.vector3]]) → None¶ Sets the velocity array: 2D array, size = (number of timesteps) x (number of structural nodes)
-
sprint
(self: samson.Modeling.StructuralModel.Path, offset: int=0) → None¶ Prints some debugging information
-
updateState
(self: samson.Modeling.StructuralModel.Path) → None¶ Updates the state along the path according to the animation parameters
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Bounce
= AnimationType.Bounce¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Loop
= AnimationType.Loop¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
Once
= AnimationType.Once¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
animationFlag
¶ the animation flag
-
animationType
¶ the animation type
-
currentEnergy
¶ the current energy
-
currentStep
¶ the current step along the path
-
currentTime
¶ the current time
-
forwardFlag
¶ the forward flag, which indicates when the animation is moving forward
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
name
¶ the name of the path
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
numberOfSteps
¶ the number of steps in the path
-
selectionFlag
¶
-
smoothingWindowSize
¶ the size of the smoothing window
-
stepDuration
¶ the step duration
-
type
¶ the data graph node type
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
PseudoAtom
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.NodeParticle
This class describes a pseudo-atom in a structural model
SAMSON API: SBMStructuralModelNodePseudoAtom
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.PseudoAtom) -> None
Builds a pseudo-atom (default position = (0,0,0))
- __init__(self: samson.Modeling.StructuralModel.PseudoAtom, x: samson.DataModel.Quantity.unitsSI, y: samson.DataModel.Quantity.unitsSI, z: samson.DataModel.Quantity.unitsSI) -> None
Builds a pseudo-atom at position = (x,y,z)
- __init__(self: samson.Modeling.StructuralModel.PseudoAtom, p: samson.DataModel.Type.vector3) -> None
Builds a pseudo-atom at position p
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=0) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clone
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Node) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → SBDDataGraphNodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPosition
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Type.vector3¶
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
getX
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Quantity.unitsSI¶
-
getY
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Quantity.unitsSI¶
-
getZ
(self: samson.Modeling.StructuralModel.NodeParticle) → samson.DataModel.Quantity.unitsSI¶
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(self: samson.Modeling.StructuralModel.Node, node: samson.Modeling.StructuralModel.Node) → bool¶ Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setPosition
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Type.vector3) → None¶
-
setX
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Quantity.unitsSI) → None¶
-
setY
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Quantity.unitsSI) → None¶
-
setZ
(self: samson.Modeling.StructuralModel.NodeParticle, arg0: samson.DataModel.Quantity.unitsSI) → None¶
-
sprint
(self: samson.Modeling.StructuralModel.NodeParticle, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.PseudoAtom) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
Residue
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.Group
This class describes a residue in a structural model
SAMSON API: SBMStructuralModelNodeResidue
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Residue) -> None
Builds a residue
- __init__(self: samson.Modeling.StructuralModel.Residue, arg0: str) -> None
Builds a residue
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
class
ResidueType
(self: samson.Modeling.StructuralModel.Residue.ResidueType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.Modeling.StructuralModel.Residue.ResidueType, arg0: samson.Modeling.StructuralModel.Residue.ResidueType) -> bool
- __eq__(self: samson.Modeling.StructuralModel.Residue.ResidueType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.Modeling.StructuralModel.Residue.ResidueType, arg0: samson.Modeling.StructuralModel.Residue.ResidueType) -> bool
- __ne__(self: samson.Modeling.StructuralModel.Residue.ResidueType, arg0: int) -> bool
-
A
= ResidueType.A¶
-
ALA
= ResidueType.ALA¶
-
ARG
= ResidueType.ARG¶
-
ASN
= ResidueType.ASN¶
-
ASP
= ResidueType.ASP¶
-
ASX
= ResidueType.ASX¶
-
C
= ResidueType.C¶
-
CYS
= ResidueType.CYS¶
-
DA
= ResidueType.DA¶
-
DC
= ResidueType.DC¶
-
DG
= ResidueType.DG¶
-
DI
= ResidueType.DI¶
-
DT
= ResidueType.DT¶
-
G
= ResidueType.G¶
-
GLN
= ResidueType.GLN¶
-
GLU
= ResidueType.GLU¶
-
GLX
= ResidueType.GLX¶
-
GLY
= ResidueType.GLY¶
-
HIS
= ResidueType.HIS¶
-
I
= ResidueType.I¶
-
ILE
= ResidueType.ILE¶
-
LEU
= ResidueType.LEU¶
-
LYS
= ResidueType.LYS¶
-
MET
= ResidueType.MET¶
-
PHE
= ResidueType.PHE¶
-
PRO
= ResidueType.PRO¶
-
PYL
= ResidueType.PYL¶
-
SEC
= ResidueType.SEC¶
-
SER
= ResidueType.SER¶
-
THR
= ResidueType.THR¶
-
TRP
= ResidueType.TRP¶
-
TYR
= ResidueType.TYR¶
-
U
= ResidueType.U¶
-
Undefined
= ResidueType.Undefined¶
-
VAL
= ResidueType.VAL¶
-
XAA
= ResidueType.XAA¶
-
XLE
= ResidueType.XLE¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
class
SecondaryStructureType
(self: samson.Modeling.StructuralModel.Residue.SecondaryStructureType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.Modeling.StructuralModel.Residue.SecondaryStructureType, arg0: samson.Modeling.StructuralModel.Residue.SecondaryStructureType) -> bool
- __eq__(self: samson.Modeling.StructuralModel.Residue.SecondaryStructureType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.Modeling.StructuralModel.Residue.SecondaryStructureType, arg0: samson.Modeling.StructuralModel.Residue.SecondaryStructureType) -> bool
- __ne__(self: samson.Modeling.StructuralModel.Residue.SecondaryStructureType, arg0: int) -> bool
-
Alpha
= SecondaryStructureType.Alpha¶
-
Beta
= SecondaryStructureType.Beta¶
-
Unstructured
= SecondaryStructureType.Unstructured¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Residue, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=None) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearComment
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s Comment
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s status bit
-
clone
(self: samson.Modeling.StructuralModel.Residue) → samson.Modeling.StructuralModel.Residue¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getBackbone
(self: samson.Modeling.StructuralModel.Residue) → samson.Modeling.StructuralModel.Backbone¶
-
getChildren
(self: samson.Modeling.StructuralModel.Group) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextAminoAcid
(self: samson.Modeling.StructuralModel.Residue) → samson.Modeling.StructuralModel.Residue¶
-
getNextNucleicAcid
(self: samson.Modeling.StructuralModel.Residue) → samson.Modeling.StructuralModel.Residue¶
-
getNextResidue
(self: samson.Modeling.StructuralModel.Residue) → samson.Modeling.StructuralModel.Residue¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPreviousAminoAcid
(self: samson.Modeling.StructuralModel.Residue) → samson.Modeling.StructuralModel.Residue¶
-
getPreviousNucleicAcid
(self: samson.Modeling.StructuralModel.Residue) → samson.Modeling.StructuralModel.Residue¶
-
getPreviousResidue
(self: samson.Modeling.StructuralModel.Residue) → samson.Modeling.StructuralModel.Residue¶
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getResidueTypeString
(self: samson.Modeling.StructuralModel.Residue, arg0: SBMStructuralModelNodeResidue::ResidueType) → str¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
getSecondaryStructureTypeString
(self: samson.Modeling.StructuralModel.Residue, secondaryStructureType: SBMStructuralModelNodeResidue::SecondaryStructureType) → str¶ Returns the secondary structure type secondaryStructureType as a string
-
getSideChain
(self: samson.Modeling.StructuralModel.Residue) → SBMStructuralModelNodeSideChain¶
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(self: samson.Modeling.StructuralModel.Residue, node: samson.Modeling.StructuralModel.Node) → bool¶ Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Group, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Residue) → str¶ Converts to a string
-
A
= ResidueType.A¶
-
ALA
= ResidueType.ALA¶
-
ARG
= ResidueType.ARG¶
-
ASN
= ResidueType.ASN¶
-
ASP
= ResidueType.ASP¶
-
ASX
= ResidueType.ASX¶
-
Alpha
= SecondaryStructureType.Alpha¶
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Beta
= SecondaryStructureType.Beta¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
C
= ResidueType.C¶
-
CYS
= ResidueType.CYS¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DA
= ResidueType.DA¶
-
DC
= ResidueType.DC¶
-
DG
= ResidueType.DG¶
-
DI
= ResidueType.DI¶
-
DT
= ResidueType.DT¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
G
= ResidueType.G¶
-
GLN
= ResidueType.GLN¶
-
GLU
= ResidueType.GLU¶
-
GLX
= ResidueType.GLX¶
-
GLY
= ResidueType.GLY¶
-
HIS
= ResidueType.HIS¶
-
I
= ResidueType.I¶
-
ILE
= ResidueType.ILE¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
LEU
= ResidueType.LEU¶
-
LYS
= ResidueType.LYS¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
MET
= ResidueType.MET¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
PHE
= ResidueType.PHE¶
-
PRO
= ResidueType.PRO¶
-
PYL
= ResidueType.PYL¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
SEC
= ResidueType.SEC¶
-
SER
= ResidueType.SER¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
THR
= ResidueType.THR¶
-
TRP
= ResidueType.TRP¶
-
TYR
= ResidueType.TYR¶
-
U
= ResidueType.U¶
-
Undefined
= ResidueType.Undefined¶
-
Unstructured
= SecondaryStructureType.Unstructured¶
-
VAL
= ResidueType.VAL¶
-
VisualModel
= NodeType.VisualModel¶
-
XAA
= ResidueType.XAA¶
-
XLE
= ResidueType.XLE¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
comment
¶ group’s comment
-
hasComment
¶ Returns true when the group’s Comment is set
-
hasCompleteAminoAcidBackbone
¶ Returns true if and only if the residue has a complete amino-acid backbone
-
hasStatusBit
¶ Returns true when the group’s status bit is set
-
highlightingFlag
¶
-
isAminoAcid
¶ Returns true if and only if the residue is an amino acid
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isNucleicAcid
¶ Returns true if and only if the residue is a nucleic acid
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isTerminal
¶ Returns true if and only if the residue is terminal
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
name
¶ name of the model
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
residueType
¶
-
residueTypeString
¶
-
secondaryStructureType
¶ Returns the most probable secondary structure based on bonds parameters and residue geometry
-
secondaryStructureTypeString
¶ Returns the secondary structure type as a string
-
selectionFlag
¶
-
statusBit
¶ group’s status bit
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
Root
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.Group
This class describes the root of a structural model
SAMSON API: SBMStructuralModelNodeRoot
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Root) -> None
Builds the root of a structural model
- __init__(self: samson.Modeling.StructuralModel.Root, arg0: str) -> None
Builds the root of a structural model
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(*args, **kwargs)¶ Overloaded function.
- addChild(self: samson.Modeling.StructuralModel.Group, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node=None) -> bool
Adds a child to the node
- addChild(self: samson.Modeling.StructuralModel.Group, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=None) -> bool
Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearComment
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s Comment
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s status bit
-
clone
(self: samson.Modeling.StructuralModel.Root) → samson.Modeling.StructuralModel.Root¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Group) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Root) → samson.DataModel.DataGraph.Node¶ Returns the parent of the node
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(*args, **kwargs)¶ Overloaded function.
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.DataModel.DataGraph.Node) -> bool
Removes a child from the node
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.Modeling.StructuralModel.Node) -> bool
Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Group, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Root) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
comment
¶ group’s comment
-
hasComment
¶ Returns true when the group’s Comment is set
-
hasStatusBit
¶ Returns true when the group’s status bit is set
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
name
¶ name of the model
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
statusBit
¶ group’s status bit
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
Segment
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.Group
This class describes a segment in a structural model
SAMSON API: SBMStructuralModelNodeSegment
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Segment) -> None
Builds a segment
- __init__(self: samson.Modeling.StructuralModel.Segment, arg0: str) -> None
Builds a segment
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.Segment, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=None) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearComment
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s Comment
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s status bit
-
clone
(self: samson.Modeling.StructuralModel.Segment) → samson.Modeling.StructuralModel.Segment¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Group) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(*args, **kwargs)¶ Overloaded function.
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.DataModel.DataGraph.Node) -> bool
Removes a child from the node
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.Modeling.StructuralModel.Node) -> bool
Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Group, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Segment) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
comment
¶ group’s comment
-
hasComment
¶ Returns true when the group’s Comment is set
-
hasStatusBit
¶ Returns true when the group’s status bit is set
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
name
¶ name of the model
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
statusBit
¶ group’s status bit
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
SideChain
(*args, **kwargs)¶ Bases:
samson.Modeling.StructuralModel.Group
This class describes a residue side-chain
SAMSON API: SBMStructuralModelNodeSideChain
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.SideChain) -> None
Builds a residue side-chain
- __init__(self: samson.Modeling.StructuralModel.SideChain, arg0: str) -> None
Builds a residue side-chain
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.Modeling.StructuralModel.SideChain, node: samson.Modeling.StructuralModel.Node, nextNode: samson.Modeling.StructuralModel.Node=None) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearComment
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s Comment
-
clearStatusBit
(self: samson.Modeling.StructuralModel.Group) → None¶ Clears the group’s status bit
-
clone
(self: samson.Modeling.StructuralModel.SideChain) → samson.Modeling.StructuralModel.SideChain¶ Returns a copy of the node and its descendants
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getChildren
(self: samson.Modeling.StructuralModel.Group) → SBCReferencePointerList<SBMStructuralModelNode, SBCReferenceToTarget>¶
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getModel
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.StructuralModel¶
-
getNextStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.StructuralModel.Node) → samson.DataModel.DataGraph.Node¶ Returns the document which owns the node
-
getPreviousStructuralNode
(self: samson.Modeling.StructuralModel.Node) → samson.Modeling.StructuralModel.Node¶
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(*args, **kwargs)¶ Overloaded function.
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.DataModel.DataGraph.Node) -> bool
Removes a child from the node
- removeChild(self: samson.Modeling.StructuralModel.Group, node: samson.Modeling.StructuralModel.Node) -> bool
Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.Group, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.SideChain) → str¶ Converts to a string
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
comment
¶ group’s comment
-
hasComment
¶ Returns true when the group’s Comment is set
-
hasStatusBit
¶ Returns true when the group’s status bit is set
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
mobilityFlag
¶
-
name
¶ name of the model
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
¶
-
statusBit
¶ group’s status bit
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class
samson.Modeling.StructuralModel.
StructuralModel
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Bases:
samson.Modeling.Model.SBMModel
This class describes a structural model.
SAMSON API: SBMStructuralModel
Constructs a structural model
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
__eq__
(*args, **kwargs)¶ Overloaded function.
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
__ne__
(*args, **kwargs)¶ Overloaded function.
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
- __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
-
addChild
(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node=None) → bool¶ Adds a child to the node
-
addMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool¶ Adds material to the node
-
castToInteractionModelParticleSystem
(self: samson.DataModel.DataGraph.Node) → SBMInteractionModelParticleSystem¶ Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
-
castToLabel
(self: samson.DataModel.DataGraph.Node) → SBDDocumentLabel¶ Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
-
castToVisualModel
(self: samson.DataModel.DataGraph.Node) → SBMVisualModel¶ Casts (if possible) from SBDDataGraphNode to SBMVisualModel
-
clearConnectivityAnnotationInformation
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Clears the model’s connectivity annotation information
-
clearCrystallographicAndTransformationInformation
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Clears the model’s transformation information
-
clearHeterogenInformation
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Clears the model’s heterogen information
-
clearMiscellaneousInformation
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Clears the model’s miscellaneous information
-
clearPrimaryStructureInformation
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Clears the model’s primary structure information
-
clearSecondaryStructureInformation
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Clears the model’s secondary structure information
-
clearTitleInformation
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Clears the model’s title information
-
clone
(self: samson.Modeling.StructuralModel.StructuralModel) → samson.Modeling.StructuralModel.StructuralModel¶ Returns a copy of the node and its descendants
-
computeSecondaryStructure
(self: samson.Modeling.StructuralModel.StructuralModel, forceUpdate: bool=False) → List[bool]¶ Computes the secondary structure for all residues in the structural model. Returns a list: 1st element - true if everything went well; 2nd element - true if and only if the secondary structure was changed compared to the previous call.
-
countNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int¶ - Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
create
(self: samson.DataModel.DataGraph.Node) → None¶ Creates the node
-
createCovalentBonds
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Builds covalent bonds for the atoms belonging to the structural model according to the inter-atomic distances
-
createCovalentBondsByResidueType
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Builds covalent bonds for the atoms belonging to the structural model according to the residue types, regardless of inter-atomic distances
-
display
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Displays the property model
-
displayForSelection
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Displays the property model for selection purposes
-
displayForShadow
(self: samson.Modeling.StructuralModel.StructuralModel) → None¶ Displays the property model for shadow purposes
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getInheritedFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the inherited flags
-
getLayer
(self: samson.Modeling.Model.SBMModel) → samson.DataModel.Document.Layer¶ Returns the owning document layer
-
getMaterial
(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial¶ Returns the material of the node
-
getMaterialOwner
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the node whose material is inherited
-
getMemoryFootprint
(self: samson.Core.Reference.SBCReferenceTarget) → int¶ Returns the memory footprint
-
getNextModel
(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel¶ Returns the next model in the document layer
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.Modeling.Model.SBMModel) → samson.DataModel.DataGraph.Node¶ Returns the parent node
-
getPreviousModel
(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel¶ Returns the previous model in the document layer
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
getStructuralRoot
(self: samson.Modeling.StructuralModel.StructuralModel) → SBMStructuralModelNodeRoot¶ Returns the root
-
hasOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
removeChild
(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) → bool¶ Removes a child from the node
-
removeMaterial
(self: samson.DataModel.DataGraph.Node) → bool¶ Removes material from the node
-
setColor
(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None¶ Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)
- Args:
color (Color): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
setMaterial
(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None¶ Sets the material for the node (removes an existing material from the node and adds a given material)
- Args:
material (Material): material to set
applyToChildren (boolean): if set to True goes through child nodes (default value: False)
-
sprint
(self: samson.Modeling.StructuralModel.StructuralModel, offset: int=0) → None¶ Prints some debugging information
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.DocumentCamera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentCamera
= NodeType.DocumentCamera¶
-
DocumentLabel
= NodeType.DocumentLabel¶
-
DocumentLayer
= NodeType.DocumentLayer¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.DocumentLabel¶
-
Layer
= NodeType.DocumentLayer¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
ParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
Path
= NodeType.StructuralModelPath¶
-
PropertyModel
= NodeType.PropertyModel¶
-
PropertyModelFunction
= NodeType.PropertyModelFunction¶
-
Protein
= NodeType.StructuralModelNodeProtein¶
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
Residue
= NodeType.StructuralModelNodeResidue¶
-
RigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
Root
= NodeType.StructuralModelNodeRoot¶
-
Segment
= NodeType.StructuralModelNodeSegment¶
-
SideChain
= NodeType.StructuralModelNodeSideChain¶
-
Simulator
= NodeType.Simulator¶
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystem¶
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystem¶
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystem¶
-
StateUpdater
= NodeType.StateUpdater¶
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystem¶
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystem¶
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystem¶
-
StructuralGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModel
= NodeType.StructuralModel¶
-
StructuralModelConformation
= NodeType.StructuralModelConformation¶
-
StructuralModelNode
= NodeType.StructuralModelNode¶
-
StructuralModelNodeAtom
= NodeType.Atom¶
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackbone¶
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBond¶
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChain¶
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroup¶
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMolecule¶
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticle¶
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProtein¶
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtom¶
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidue¶
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRoot¶
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegment¶
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChain¶
-
StructuralModelPath
= NodeType.StructuralModelPath¶
-
StructuralParticle
= NodeType.StructuralModelNodeParticle¶
-
Undefined
= NodeType.Undefined¶
-
VisualModel
= NodeType.VisualModel¶
-
__eq__
¶ Return self==value.
-
__ge__
¶ Return self>=value.
-
__gt__
¶ Return self>value.
-
__le__
¶ Return self<=value.
-
__lt__
¶ Return self<value.
-
__ne__
¶ Return self!=value.
-
connectivityAnnotationInformation
¶ model’s connectivity annotation information
-
crystallographicAndTransformationInformation
¶ model’s transformation information
-
hasConnectivityAnnotationInformation
¶ Returns true when the model’s connectivity annotation information is set
-
hasCrystallographicAndTransformationInformation
¶ Returns true when the model’s transformation information is set
-
hasHeterogenInformation
¶ Returns true when the model’s heterogen information is set
-
hasMiscellaneousInformation
¶ Returns true when the model’s miscellaneous information is set
-
hasPrimaryStructureInformation
¶ Returns true when the model’s primary structure information is set
-
hasSecondaryStructureInformation
¶ Returns true when the model’s secondary structure information is set
-
hasTitleInformation
¶ Returns true when the model’s title information is set
-
heterogenInformation
¶ model’s heterogen information
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
miscellaneousInformation
¶ model’s miscellaneous information
-
modelType
¶
-
name
¶
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
primaryStructureInformation
¶ model’s primary structure information
-
secondaryStructureInformation
¶ model’s secondary structure information
-
selectionFlag
¶
-
titleInformation
¶ model’s title information
-
type
¶
-
typeString
¶ Returns a string describing the type of the data graph node
-
visibilityFlag
¶
-
class