DataGraph

The SBDDataGraph library contains all base classes related to SAMSON’s data graph.

SAMSON API: The SBDDataGraph Library

class samson.DataModel.DataGraph.ColorScheme(self: samson.DataModel.DataGraph.ColorScheme) → None

Bases: pybind11_builtins.pybind11_object

This class describes a color scheme.

SAMSON API: SBDDataGraphNodeColorScheme

Constructs a color scheme

getColor(self: samson.DataModel.DataGraph.ColorScheme, node: samson.DataModel.DataGraph.Node=None) → List[float]

Returns a color given a node

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

isSerializable

Returns true when the class is serializable

class samson.DataModel.DataGraph.Group(*args, **kwargs)

Bases: samson.DataModel.DataGraph.Node

This class describes a node group.

SAMSON API: SBDDataGraphNodeGroup

Overloaded function.

  1. __init__(self: samson.DataModel.DataGraph.Group) -> None
  2. __init__(self: samson.DataModel.DataGraph.Group, name: str, nodeIndexer: samson.DataModel.DataGraph.NodeIndexer) -> None

Constructs a group with name from nodes in nodeIndexer.

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

  1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
  2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
__ne__(*args, **kwargs)

Overloaded function.

  1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
  2. __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.Camera
Chain = NodeType.StructuralModelNodeChain
Conformation = NodeType.StructuralModelConformation
Controller = NodeType.Controller
ControllerNode = NodeType.ControllerNode
DataGraphNodeGroup = NodeType.DataGraphNodeGroup
Document = NodeType.Document
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
Folder = NodeType.Folder
InteractionModel = NodeType.InteractionModel
InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem
InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem
InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem
Label = NodeType.Label
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

canAddChild(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node=None) → bool

Returns whether this node can add node as a child

canAddChildType(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) → bool

Returns whether this node can add a node with type nodeType as a child

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.DataModel.DataGraph.Group) → samson.DataModel.DataGraph.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

getDocument(self: samson.DataModel.DataGraph.Node) → SBDDocument

Returns the document the node belongs to

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getGroupNodes(self: samson.DataModel.DataGraph.Group) → SBCReferencePointerIndexer<SBDDataGraphNode, SBCReferenceToTarget>

Returns the index of nodes belonging to the group

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

getNextGroup(self: samson.DataModel.DataGraph.Group) → samson.DataModel.DataGraph.Group

Returns the next group

getNextNode(*args, **kwargs)

Overloaded function.

  1. getNextNode(self: samson.DataModel.DataGraph.Node) -> samson.DataModel.DataGraph.Node

Returns the pointer to the next node in the children of the node’s parent

  1. getNextNode(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) -> samson.DataModel.DataGraph.Node

Returns the pointer to the next node with type nodeType in the children of the node’s parent

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.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the parent of the node

getPreviousGroup(self: samson.DataModel.DataGraph.Group) → samson.DataModel.DataGraph.Group

Returns the previous group

getPreviousNode(*args, **kwargs)

Overloaded function.

  1. getPreviousNode(self: samson.DataModel.DataGraph.Node) -> samson.DataModel.DataGraph.Node

Returns the pointer to the previous node in the children of the node’s parent

  1. getPreviousNode(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) -> samson.DataModel.DataGraph.Node

Returns the pointer to the previous node with type nodeType in the children of the node’s parent

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

getThisNode(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the pointer to this node

getTypeString(type: SBDDataGraphNode::Type) → str

Returns a string describing the type of the data graph node

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

isDynamicalModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a dynamical model

isIn(*args, **kwargs)

Overloaded function.

  1. 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

  1. 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

isInteractionModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a interaction model

isModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a model

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

isPropertyModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a property model

isSimulator(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a simulator

isStructuralModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a structural model

isStructuralParticle(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a structural particle (an atom or a pseudo-atom)

isType(self: samson.DataModel.DataGraph.Node, type: SBDDataGraphNode::Type) → bool

Returns true when the type of the node corresponds to type

isVisualModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a visual model

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.DataModel.DataGraph.Group, 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.Camera
Chain = NodeType.StructuralModelNodeChain
Conformation = NodeType.StructuralModelConformation
Controller = NodeType.Controller
ControllerNode = NodeType.ControllerNode
DataGraphNodeGroup = NodeType.DataGraphNodeGroup
Document = NodeType.Document
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
Folder = NodeType.Folder
InteractionModel = NodeType.InteractionModel
InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem
InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem
InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem
Label = NodeType.Label
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
nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

selectionFlag
size

Returns the number of nodes belonging to the group

type

Returns the type of the data graph node

typeString

Returns a string describing the type of this data graph node

visibilityFlag
class samson.DataModel.DataGraph.Material(*args, **kwargs)

Bases: samson.Core.Reference.SBCReferenceTarget

This class describes a material.

SAMSON API: SBDDataGraphNodeMaterial

Overloaded function.

  1. __init__(self: samson.DataModel.DataGraph.Material) -> None

Constructs a material

  1. __init__(self: samson.DataModel.DataGraph.Material, colorScheme: samson.DataModel.DataGraph.ColorScheme) -> None

Constructs a material based on a given color scheme

  1. __init__(self: samson.DataModel.DataGraph.Material, color: SBDColor) -> None

Constructs a material based on a given color

getColorScheme(self: samson.DataModel.DataGraph.Material) → samson.DataModel.DataGraph.ColorScheme

Returns the color scheme

getMemoryFootprint(self: samson.Core.Reference.SBCReferenceTarget) → int

Returns the memory footprint

getNode(self: samson.DataModel.DataGraph.Material) → samson.DataModel.DataGraph.Node
setColorScheme(self: samson.DataModel.DataGraph.Material, colorScheme: samson.DataModel.DataGraph.ColorScheme) → bool

Sets the color scheme

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

isSerializable

Returns true when the class is serializable

class samson.DataModel.DataGraph.Node

Bases: samson.Core.Reference.SBCReferenceTarget

This class is the base class to describe a node in the data graph.

SAMSON API: SBDDataGraphNode

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

  1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
  2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool
__ne__(*args, **kwargs)

Overloaded function.

  1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
  2. __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.Camera
Chain = NodeType.StructuralModelNodeChain
Conformation = NodeType.StructuralModelConformation
Controller = NodeType.Controller
ControllerNode = NodeType.ControllerNode
DataGraphNodeGroup = NodeType.DataGraphNodeGroup
Document = NodeType.Document
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
Folder = NodeType.Folder
InteractionModel = NodeType.InteractionModel
InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem
InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem
InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem
Label = NodeType.Label
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

canAddChild(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node=None) → bool

Returns whether this node can add node as a child

canAddChildType(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) → bool

Returns whether this node can add a node with type nodeType as a child

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.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.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

getDocument(self: samson.DataModel.DataGraph.Node) → SBDDocument

Returns the document the node belongs to

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

getNextNode(*args, **kwargs)

Overloaded function.

  1. getNextNode(self: samson.DataModel.DataGraph.Node) -> samson.DataModel.DataGraph.Node

Returns the pointer to the next node in the children of the node’s parent

  1. getNextNode(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) -> samson.DataModel.DataGraph.Node

Returns the pointer to the next node with type nodeType in the children of the node’s parent

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.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the parent of the node

getPreviousNode(*args, **kwargs)

Overloaded function.

  1. getPreviousNode(self: samson.DataModel.DataGraph.Node) -> samson.DataModel.DataGraph.Node

Returns the pointer to the previous node in the children of the node’s parent

  1. getPreviousNode(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) -> samson.DataModel.DataGraph.Node

Returns the pointer to the previous node with type nodeType in the children of the node’s parent

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

getThisNode(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the pointer to this node

getTypeString(type: SBDDataGraphNode::Type) → str

Returns a string describing the type of the data graph node

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

isDynamicalModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a dynamical model

isIn(*args, **kwargs)

Overloaded function.

  1. 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

  1. 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

isInteractionModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a interaction model

isModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a model

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

isPropertyModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a property model

isSimulator(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a simulator

isStructuralModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a structural model

isStructuralParticle(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a structural particle (an atom or a pseudo-atom)

isType(self: samson.DataModel.DataGraph.Node, type: SBDDataGraphNode::Type) → bool

Returns true when the type of the node corresponds to type

isVisualModel(self: samson.DataModel.DataGraph.Node) → bool

Returns true when the node is a visual model

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.DataModel.DataGraph.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.Camera
Chain = NodeType.StructuralModelNodeChain
Conformation = NodeType.StructuralModelConformation
Controller = NodeType.Controller
ControllerNode = NodeType.ControllerNode
DataGraphNodeGroup = NodeType.DataGraphNodeGroup
Document = NodeType.Document
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
Folder = NodeType.Folder
InteractionModel = NodeType.InteractionModel
InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem
InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem
InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem
Label = NodeType.Label
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

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

selectionFlag
type

Returns the type of the data graph node

typeString

Returns a string describing the type of this data graph node

visibilityFlag
class samson.DataModel.DataGraph.NodeIndexer(*args, **kwargs)

Bases: pybind11_builtins.pybind11_object

This class describes a node indexer.

SAMSON API: SBDDataGraphNodeIndexer

Overloaded function.

  1. __init__(self: samson.DataModel.DataGraph.NodeIndexer) -> None

Constructs a node indexer

  1. __init__(self: samson.DataModel.DataGraph.NodeIndexer, initialSize: int) -> None

Constructs a node indexer with a pre-allocated initialSize

addNode(self: samson.DataModel.DataGraph.NodeIndexer, node: samson.DataModel.DataGraph.Node) → int

Adds a node to the indexer and returns the index of the node

clear(self: samson.DataModel.DataGraph.NodeIndexer) → None

clear the node indexer

getIndex(self: samson.DataModel.DataGraph.NodeIndexer, node: samson.DataModel.DataGraph.Node) → int

Returns the index associated to the node

getNode(self: samson.DataModel.DataGraph.NodeIndexer, index: int) → samson.DataModel.DataGraph.Node

Returns the node with the given inde

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
getRootNodes(self: samson.DataModel.DataGraph.NodeIndexer, nodeIndexer: samson.DataModel.DataGraph.NodeIndexer) → None

Collect the root nodes among the indexed nodes, i.e. the nodes that do not have indexed ascendants

hasIndex(self: samson.DataModel.DataGraph.NodeIndexer, arg0: samson.DataModel.DataGraph.Node) → bool

Returns true if the node has an index

hasNode(self: samson.DataModel.DataGraph.NodeIndexer, node: samson.DataModel.DataGraph.Node) → bool

Returns true if the node has an index

removeNode(self: samson.DataModel.DataGraph.NodeIndexer, node: samson.DataModel.DataGraph.Node) → int

Erases the node from the indexer

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

isEmpty

true if empty

size

size of the node indexer