Class SBCClass

ClassList > SBCClass

This class is the main root class. More...

• #include <SBCClass.hpp>

Public Types

Type	Name
enum	Category Available class categories.
enum	Type Available class types.

Public Functions

Type	Name
	SBCClass () Constructs a class.
virtual	~SBCClass () Destructs the class.

Public Static Functions

Type	Name
std::string	getClassCategoryString (Category category) Returns a string describing the category of the class.
std::string	getClassTypeString (Type type) Returns a string describing the type of the class.

Detailed Description

This class is the root class of numerous classes in SAMSON.

In particular, all data graph node classes indirectly derive from SBCClass, as well as many SAMSON Extensions classes.

This class derives class types and class categories. The static function getClassTypeString may be used to retrieve the string description corresponding to a class type, and the static function getClassCategoryString may be used to retrieve the string description corresponding to a class category (SBCClass::Category).

Short name: SBClass

Public Types Documentation

enum Category

Available class categories.

enum SBCClass::Category {
    Assembly = 100,
    Biology = 200,
    Chemistry = 300,
    Developer = 400,
    Education = 500,
    Electronics = 600,
    General = 700,
    Materials = 800,
    Medicine = 900,
    Metrology = 1000,
    Modeling = 1100,
    Optics = 1200,
    Particles = 1300,
    Pharmacy = 1400,
    Photonics = 1500,
    Physics = 1600,
    Simulation = 1700,
    Toxicology = 1800,
    Visualization = 1900
};

---

enum Type

Available class types.

enum SBCClass::Type {
    Base = 1,
    App = 10,
    Editor = 20,
    Importer = 30,
    Exporter = 31,
    Tutorial = 40,
    VisualModel = 100,
    DynamicalModelArticulatedBodySystem = 200,
    DynamicalModelParticleSystem = 201,
    DynamicalModelRigidBodySystem = 202,
    InteractionModelArticulatedBodySystem = 300,
    InteractionModelParticleSystem = 301,
    InteractionModelRigidBodySystem = 302,
    PropertyModel = 400,
    PropertyModelFunction = 401,
    NeighborSearchArticulatedBodySystem = 500,
    NeighborSearchParticleSystem = 501,
    NeighborSearchRigidBodySystem = 502,
    StateUpdaterArticulatedBodySystem = 600,
    StateUpdaterParticleSystem = 601,
    StateUpdaterRigidBodySystem = 602,
    RenderProgram = 700,
    Controller = 800,
    ControllerNode = 801,
    Label = 900,
    NodeGUI = 1000,
    Properties = 2000,
    Factory = 3000,
    StructuralModelFactory = 3001,
    DynamicalModelParticleSystemFactory = 3002,
    InteractionModelParticleSystemFactory = 3003,
    VisualModelFactory = 3004,
    PropertyModelFactory = 3005,
    ControllerFactory = 3006,
    LabelFactory = 3007,
    Inspector = 4000,
    InspectorFactory = 4001,
    AssetLibrary = 5000,
    AnimationFactory = 7000,
    EntranceAnimation = 7001,
    HighlightAnimation = 7002,
    MotionAnimation = 7003,
    ExitAnimation = 7004,
    CameraAnimation = 7005,
    OtherAnimation = 7006,
    ColorScheme = 8000,
    ColorPalette = 9000,
    Selector = 10000,
    Assistant = 20000,
    Custom = 100000
};

---

Public Functions Documentation

function SBCClass

Constructs a class.

SBCClass::SBCClass () 

Default constructor for SBCClass.

Constructs a new SBCClass instance.

---

function ~SBCClass

Destructs the class.

virtual SBCClass::~SBCClass () 

Destructor for SBCClass.

Destroys the SBCClass instance and releases associated resources.

---

Public Static Functions Documentation

function getClassCategoryString

Returns a string describing the category of the class.

static std::string SBCClass::getClassCategoryString (
    Category category
) 

Returns a string describing the specified class category.

The function maps each SBCClass::Category enumeration value to its textual representation.

Parameters:

• category The class category to describe.

Returns:

A string representation of the class category, or "Undefined" if the category is unknown.

---

function getClassTypeString

Returns a string describing the type of the class.

static std::string SBCClass::getClassTypeString (
    Type type
) 

Returns a string describing the specified class type.

The function maps each SBCClass::Type enumeration value to its textual representation.

Parameters:

• type The class type to describe.

Returns:

A string representation of the class type, or "Undefined" if the type is unknown.

---