Class¶

The SBCClass library defines fundamental mechanisms used for class introspection.

SAMSON API: The SBCClass Library

class samson.Core.Class.ClassAttribute¶

Bases: pybind11_builtins.pybind11_object

This class describes a class attribute in a class proxy.

class Type(self: samson.Core.Class.ClassAttribute.Type, arg0: int) → None¶

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)¶

Overloaded function.

__eq__(self: samson.Core.Class.ClassAttribute.Type, arg0: samson.Core.Class.ClassAttribute.Type) -> bool
__eq__(self: samson.Core.Class.ClassAttribute.Type, arg0: int) -> bool

__ne__(*args, **kwargs)¶

Overloaded function.

__ne__(self: samson.Core.Class.ClassAttribute.Type, arg0: samson.Core.Class.ClassAttribute.Type) -> bool
__ne__(self: samson.Core.Class.ClassAttribute.Type, arg0: int) -> bool

ReadOnly = Type.ReadOnly¶

ReadWrite = Type.ReadWrite¶

ReadWriteClear = Type.ReadWriteClear¶

ReadWriteClearArray = Type.ReadWriteClearArray¶

__ge__¶: Return self>=value.

__gt__¶: Return self>value.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

ReadOnly = Type.ReadOnly¶

ReadWrite = Type.ReadWrite¶

ReadWriteClear = Type.ReadWriteClear¶

ReadWriteClearArray = Type.ReadWriteClearArray¶

__eq__¶: Return self==value.

__ge__¶: Return self>=value.

__gt__¶: Return self>value.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

description¶: Returns the description of the attribute

group¶: Returns the group of the attribute

name¶: Returns the name of the attribute

type¶: Returns the type of the attribute

class samson.Core.Class.ClassInterface¶

Bases: pybind11_builtins.pybind11_object

This class describes a class interface in a class proxy.

SAMSON API: SBCClassInterface

getAttribute(self: samson.Core.Class.ClassInterface, attributeName: str) → samson.Core.Class.ClassAttribute¶: Returns the attribute with name attributeName

__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.Core.Class.ClassProxy¶

Bases: pybind11_builtins.pybind11_object

This class describes a class proxy.

SAMSON API: SBCClassProxy

getInterface(self: samson.Core.Class.ClassProxy) → SBCClassInterface¶: Returns the interface of the class

SDKVersionNumber¶: Returns the version number of the SAMSON SDK used to compile the class

UUID¶: Returns the UUID of the class

__eq__¶: Return self==value.

__ge__¶: Return self>=value.

__gt__¶: Return self>value.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

description¶: Returns the description of the class

element¶: Returns the SAMSON Element containing the class

elementUUID¶: Returns the UUID of the SAMSON Element containing the class

name¶: Returns the name of the class

type¶: Returns the type of the class

versionNumber¶: Returns the version number of the class

class samson.Core.Class.SBCClass¶

Bases: pybind11_builtins.pybind11_object

This class is the main root class.

SAMSON API: SBCClass

class Category(self: samson.Core.Class.SBCClass.Category, arg0: int) → None¶

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)¶

Overloaded function.

__eq__(self: samson.Core.Class.SBCClass.Category, arg0: samson.Core.Class.SBCClass.Category) -> bool
__eq__(self: samson.Core.Class.SBCClass.Category, arg0: int) -> bool

__ne__(*args, **kwargs)¶

Overloaded function.

__ne__(self: samson.Core.Class.SBCClass.Category, arg0: samson.Core.Class.SBCClass.Category) -> bool
__ne__(self: samson.Core.Class.SBCClass.Category, arg0: int) -> bool

Assembly = Category.Assembly¶

Biology = Category.Biology¶

Chemistry = Category.Chemistry¶

Developer = Category.Developer¶

Education = Category.Education¶

Electronics = Category.Electronics¶

General = Category.General¶

Materials = Category.Materials¶

Medicine = Category.Medicine¶

Metrology = Category.Metrology¶

Modeling = Category.Modeling¶

Optics = Category.Optics¶

Particles = Category.Particles¶

Pharmacy = Category.Pharmacy¶

Photonics = Category.Photonics¶

Physics = Category.Physics¶

Simulation = Category.Simulation¶

Toxicology = Category.Toxicology¶

Visualization = Category.Visualization¶

__ge__¶: Return self>=value.

__gt__¶: Return self>value.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

class Type(self: samson.Core.Class.SBCClass.Type, arg0: int) → None¶

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)¶

Overloaded function.

__eq__(self: samson.Core.Class.SBCClass.Type, arg0: samson.Core.Class.SBCClass.Type) -> bool
__eq__(self: samson.Core.Class.SBCClass.Type, arg0: int) -> bool

__ne__(*args, **kwargs)¶

Overloaded function.

__ne__(self: samson.Core.Class.SBCClass.Type, arg0: samson.Core.Class.SBCClass.Type) -> bool
__ne__(self: samson.Core.Class.SBCClass.Type, arg0: int) -> bool

App = Type.App¶

Base = Type.Base¶

Controller = Type.Controller¶

ControllerFactory = Type.ControllerFactory¶

ControllerNode = Type.ControllerNode¶

Custom = Type.Custom¶

DynamicalModelArticulatedBodySystem = Type.DynamicalModelArticulatedBodySystem¶

DynamicalModelParticleSystem = Type.DynamicalModelParticleSystem¶

DynamicalModelParticleSystemFactory = Type.DynamicalModelParticleSystemFactory¶

DynamicalModelRigidBodySystem = Type.DynamicalModelRigidBodySystem¶

Editor = Type.Editor¶

Exporter = Type.Exporter¶

Factory = Type.Factory¶

Importer = Type.Importer¶

Inspector = Type.Inspector¶

InspectorFactory = Type.InspectorFactory¶

InteractionModelArticulatedBodySystem = Type.InteractionModelArticulatedBodySystem¶

InteractionModelParticleSystem = Type.InteractionModelParticleSystem¶

InteractionModelParticleSystemFactory = Type.InteractionModelParticleSystemFactory¶

InteractionModelRigidBodySystem = Type.InteractionModelRigidBodySystem¶

Label = Type.Label¶

LabelFactory = Type.LabelFactory¶

NeighborSearchArticulatedBodySystem = Type.NeighborSearchArticulatedBodySystem¶

NeighborSearchParticleSystem = Type.NeighborSearchParticleSystem¶

NeighborSearchRigidBodySystem = Type.NeighborSearchRigidBodySystem¶

NodeGUI = Type.NodeGUI¶

Properties = Type.Properties¶

PropertyModel = Type.PropertyModel¶

PropertyModelFactory = Type.PropertyModelFactory¶

PropertyModelFunction = Type.PropertyModelFunction¶

RenderProgram = Type.RenderProgram¶

StateUpdaterArticulatedBodySystem = Type.StateUpdaterArticulatedBodySystem¶

StateUpdaterParticleSystem = Type.StateUpdaterParticleSystem¶

StateUpdaterRigidBodySystem = Type.StateUpdaterRigidBodySystem¶

StructuralModelFactory = Type.StructuralModelFactory¶

VisualModel = Type.VisualModel¶

VisualModelFactory = Type.VisualModelFactory¶

__ge__¶: Return self>=value.

__gt__¶: Return self>value.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

getClassCategoryString(self: SBCClass::Category) → str¶: Returns a string describing the category of the class

getClassTypeString(self: SBCClass::Type) → str¶: Returns a string describing the type of the class

App = Type.App¶

Assembly = Category.Assembly¶

Base = Type.Base¶

Biology = Category.Biology¶

Chemistry = Category.Chemistry¶

Controller = Type.Controller¶

ControllerFactory = Type.ControllerFactory¶

ControllerNode = Type.ControllerNode¶

Custom = Type.Custom¶

Developer = Category.Developer¶

DynamicalModelArticulatedBodySystem = Type.DynamicalModelArticulatedBodySystem¶

DynamicalModelParticleSystem = Type.DynamicalModelParticleSystem¶

DynamicalModelParticleSystemFactory = Type.DynamicalModelParticleSystemFactory¶

DynamicalModelRigidBodySystem = Type.DynamicalModelRigidBodySystem¶

Editor = Type.Editor¶

Education = Category.Education¶

Electronics = Category.Electronics¶

Exporter = Type.Exporter¶

Factory = Type.Factory¶

General = Category.General¶

Importer = Type.Importer¶

Inspector = Type.Inspector¶

InspectorFactory = Type.InspectorFactory¶

InteractionModelArticulatedBodySystem = Type.InteractionModelArticulatedBodySystem¶

InteractionModelParticleSystem = Type.InteractionModelParticleSystem¶

InteractionModelParticleSystemFactory = Type.InteractionModelParticleSystemFactory¶

InteractionModelRigidBodySystem = Type.InteractionModelRigidBodySystem¶

Label = Type.Label¶

LabelFactory = Type.LabelFactory¶

Materials = Category.Materials¶

Medicine = Category.Medicine¶

Metrology = Category.Metrology¶

Modeling = Category.Modeling¶

NeighborSearchArticulatedBodySystem = Type.NeighborSearchArticulatedBodySystem¶

NeighborSearchParticleSystem = Type.NeighborSearchParticleSystem¶

NeighborSearchRigidBodySystem = Type.NeighborSearchRigidBodySystem¶

NodeGUI = Type.NodeGUI¶

Optics = Category.Optics¶

Particles = Category.Particles¶

Pharmacy = Category.Pharmacy¶

Photonics = Category.Photonics¶

Physics = Category.Physics¶

Properties = Type.Properties¶

PropertyModel = Type.PropertyModel¶

PropertyModelFactory = Type.PropertyModelFactory¶

PropertyModelFunction = Type.PropertyModelFunction¶

RenderProgram = Type.RenderProgram¶

Simulation = Category.Simulation¶

StateUpdaterArticulatedBodySystem = Type.StateUpdaterArticulatedBodySystem¶

StateUpdaterParticleSystem = Type.StateUpdaterParticleSystem¶

StateUpdaterRigidBodySystem = Type.StateUpdaterRigidBodySystem¶

StructuralModelFactory = Type.StructuralModelFactory¶

Toxicology = Category.Toxicology¶

VisualModel = Type.VisualModel¶

VisualModelFactory = Type.VisualModelFactory¶

Visualization = Category.Visualization¶

__eq__¶: Return self==value.

__ge__¶: Return self>=value.

__gt__¶: Return self>value.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.