Web Analytics Made Easy - Statcounter
Skip to content

Class SBMStructuralModelEvent#

ClassList > SBMStructuralModelEvent

This class describe a structural event. More...

  • #include <SBMStructuralModelEvent.hpp>

Inherits the following classes: SBDDataGraphEvent

Public Types#

Type Name
enum Type
The type of the structural event.

Public Types inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type Name
enum Category
The category of the data graph event.

Public Functions#

Type Name
SBMStructuralModelEvent (SBDDataGraphNode * sender, Type type, SBDDataGraphNode * auxiliaryNode=nullptr)
Constructs a structural event.
SBDDataGraphNode * getAuxiliaryNode () const
Returns the auxiliary node.
virtual Category getCategory () override const
Returns the category of the event ( SBDDataGraphEvent::StructuralEvent )
Type getType () const
Returns the structural model event type.
virtual void print (unsigned int offset=0) override const
Prints the structural event.
virtual ~SBMStructuralModelEvent ()
Destructs the structural event.

Public Functions inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type Name
SBDDataGraphEvent (SBDDataGraphNode * sender)
Build a data graph event for the sender sender .
virtual Category getCategory () const
Returns the category of the data graph event.
SBDDataGraphNode * getSender () const
Returns the sender of the event.
virtual void print (unsigned int offset=0) const
Prints debugging information.
virtual ~SBDDataGraphEvent ()
Destructor.

Public Static Functions#

Type Name
std::string getTypeString (Type type)
Returns the structural model event type as a string.

Public Static Functions inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type Name
std::string getCategoryString (Category category)
Returns a string representation of the category of the data graph event.

Protected Attributes inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type Name
SBDDataGraphEventData * dataPointer
A pointer to the private data.

Protected Functions#

Type Name
SBMStructuralModelEvent (SBMStructuralModelEventData * dataPointer)
Protected constructor.

Protected Functions inherited from SBDDataGraphEvent#

See SBDDataGraphEvent

Type Name
SBDDataGraphEvent (SBDDataGraphEventData * dataPointer)
Protected constructor.

Detailed Description#

Short name: SBStructuralEvent

Public Types Documentation#

enum Type#

The type of the structural event. 

enum SBMStructuralModelEvent::Type {
    Any = 0,
    AtomAdded = 1,
    AtomRemoved = 2,
    AtomTypeChanged = 3,
    AtomNameChanged = 4,
    AtomAltLocationChanged = 5,
    AtomInsertionCodeChanged = 7,
    AtomSerialNumberChanged = 8,
    AtomOccupancyChanged = 9,
    AtomRecordTypeChanged = 10,
    AtomPartialChargeChanged = 14,
    AtomTemperatureFactorChanged = 15,
    AtomFormalChargeChanged = 16,
    AtomCommentChanged = 17,
    AtomSYBYLTypeChanged = 18,
    AtomStatusBitChanged = 19,
    AtomAnisotropicTFactorsChanged = 23,
    AtomOxidationStateChanged = 25,
    AtomHybridizationChanged = 26,
    AtomResonanceChanged = 27,
    AtomAromaticityChanged = 28,
    AtomElementChanged = 29,
    AtomWaterFlagChanged = 30,
    AtomCustomTypeChanged = 31,
    AtomGeometryChanged = 32,
    AtomPositionChanged = 33,
    AtomMassChanged = 34,
    BondAdded = 40,
    BondRemoved = 41,
    BondConnected = 42,
    BondDisconnected = 43,
    BondOrderChanged = 44,
    BondTypeChanged = 45,
    BondStatusBitChanged = 46,
    BondCustomTypeChanged = 47,
    ResidueAdded = 50,
    ResidueRemoved = 51,
    BackboneAdded = 52,
    BackboneRemoved = 53,
    SideChainAdded = 54,
    SideChainRemoved = 55,
    ResidueTypeChanged = 56,
    SegmentAdded = 60,
    SegmentRemoved = 61,
    ChainAdded = 70,
    ChainRemoved = 71,
    MoleculeAdded = 80,
    MoleculeRemoved = 81,
    StructuralGroupAdded = 90,
    StructuralGroupRemoved = 91,
    StructuralGroupCommentChanged = 93,
    StructuralGroupStatusBitChanged = 94,
    StructuralGroupIDChanged = 95,
    FixedFlagChanged = 110,
    MobilityFlagChanged = 110,
    TitleInformationChanged = 120,
    PrimaryStructureInformationChanged = 121,
    HeterogenInformationChanged = 122,
    SecondaryStructureInformationChanged = 123,
    ConnectivityAnnotationInformationChanged = 124,
    MiscellaneousInformationChanged = 125,
    CrystallographicAndTransformationInformationChanged = 126,
    TransformChanged = 127,
    UnitCellChanged = 128,
    SecondaryStructureChanged = 130,
    HydrophobicityChanged = 150,
    HydrogenBondAdded = 170,
    HydrogenBondRemoved = 171,
    HydrogenBondGroupAdded = 180,
    HydrogenBondGroupRemoved = 181,
    HydrogenBondGroupChanged = 182,
    CoarseGrainedTypeChanged = 200,
    CoarseGrainedRadiusChanged = 201,
    CoarseGrainedMassChanged = 202,
    CoarseGrainedColorChanged = 203
};

Public Functions Documentation#

function SBMStructuralModelEvent [1/2]#

Constructs a structural event. 

SBMStructuralModelEvent::SBMStructuralModelEvent (
    SBDDataGraphNode * sender,
    Type type,
    SBDDataGraphNode * auxiliaryNode=nullptr
)

Constructs a structural model event.

This constructor initializes the event with the specified sender node, event type, and optional auxiliary node.

Parameters:

  • sender The node that originated the event.
  • type The type of the structural model event.
  • auxiliaryNode An optional node related to the event, or nullptr if not applicable.

function getAuxiliaryNode#

Returns the auxiliary node. 

SBDDataGraphNode * SBMStructuralModelEvent::getAuxiliaryNode () const

Retrieves the auxiliary node associated with the event.

Returns:

A pointer to the auxiliary node, or nullptr if none was provided.

function getCategory#

Returns the category of the event ( SBDDataGraphEvent::StructuralEvent ) 

virtual Category SBMStructuralModelEvent::getCategory () override const

Returns the category of the event.

The returned category identifies the event as a structural event.

Returns:

The category of the event (StructuralEvent).

Implements SBDDataGraphEvent::getCategory

function getType#

Returns the structural model event type. 

Type SBMStructuralModelEvent::getType () const

Returns the specific type of the structural model event.

Returns:

The event type enumeration value.

function print#

Prints the structural event. 

virtual void SBMStructuralModelEvent::print (
    unsigned int offset=0
) override const

Prints a textual representation of the event to standard output.

The output includes the event type, the sender node, and the auxiliary node information, indented by the specified offset.

Parameters:

  • offset The number of tab characters to prepend to each line of output.

Implements SBDDataGraphEvent::print

function ~SBMStructuralModelEvent#

Destructs the structural event. 

virtual SBMStructuralModelEvent::~SBMStructuralModelEvent ()

Destroys the structural model event.

Public Static Functions Documentation#

function getTypeString#

Returns the structural model event type as a string. 

static std::string SBMStructuralModelEvent::getTypeString (
    Type type
)

Returns a string representation of the given event type.

This function converts an event type enumeration value to a human‑readable string.

Parameters:

  • type The event type to convert.

Returns:

A string describing the event type, or a default message if the type is unknown.

Protected Functions Documentation#

function SBMStructuralModelEvent [2/2]#

Protected constructor. 

SBMStructuralModelEvent::SBMStructuralModelEvent (
    SBMStructuralModelEventData * dataPointer
)