Loading...
Searching...
No Matches
SBMStructuralModelEvent Class Reference

This class describe a structural event.

Event types

enum  Type {
  Any ,
  AtomAdded ,
  AtomRemoved ,
  AtomTypeChanged ,
  AtomNameChanged ,
  AtomAltLocationChanged ,
  AtomInsertionCodeChanged ,
  AtomSerialNumberChanged ,
  AtomOccupancyChanged ,
  AtomRecordTypeChanged ,
  AtomPartialChargeChanged ,
  AtomTemperatureFactorChanged ,
  AtomFormalChargeChanged ,
  AtomCommentChanged ,
  AtomSYBYLTypeChanged ,
  AtomStatusBitChanged ,
  AtomAnisotropicTFactorsChanged ,
  AtomOxidationStateChanged ,
  AtomHybridizationChanged ,
  AtomResonanceChanged ,
  AtomAromaticityChanged ,
  AtomElementChanged ,
  AtomWaterFlagChanged ,
  AtomCustomTypeChanged ,
  AtomGeometryChanged ,
  AtomPositionChanged ,
  AtomMassChanged ,
  BondAdded ,
  BondRemoved ,
  BondConnected ,
  BondDisconnected ,
  BondOrderChanged ,
  BondTypeChanged ,
  BondStatusBitChanged ,
  BondCustomTypeChanged ,
  ResidueAdded ,
  ResidueRemoved ,
  BackboneAdded ,
  BackboneRemoved ,
  SideChainAdded ,
  SideChainRemoved ,
  ResidueTypeChanged ,
  SegmentAdded ,
  SegmentRemoved ,
  ChainAdded ,
  ChainRemoved ,
  MoleculeAdded ,
  MoleculeRemoved ,
  StructuralGroupAdded ,
  StructuralGroupRemoved ,
  StructuralGroupCommentChanged ,
  StructuralGroupStatusBitChanged ,
  StructuralGroupIDChanged ,
  FixedFlagChanged ,
  MobilityFlagChanged ,
  TitleInformationChanged ,
  PrimaryStructureInformationChanged ,
  HeterogenInformationChanged ,
  SecondaryStructureInformationChanged ,
  ConnectivityAnnotationInformationChanged ,
  MiscellaneousInformationChanged ,
  CrystallographicAndTransformationInformationChanged ,
  TransformChanged ,
  SecondaryStructureChanged ,
  HydrophobicityChanged ,
  HydrogenBondAdded ,
  HydrogenBondRemoved ,
  HydrogenBondGroupAdded ,
  HydrogenBondGroupRemoved ,
  HydrogenBondGroupChanged ,
  CoarseGrainedTypeChanged ,
  CoarseGrainedRadiusChanged ,
  CoarseGrainedMassChanged ,
  CoarseGrainedColorChanged
}
 The type of the structural event. More...
 

Constructors and destructors

 SBMStructuralModelEvent (SBDDataGraphNode *sender, Type type, SBDDataGraphNode *auxiliaryNode=0)
 Constructs a structural event.
 
virtual ~SBMStructuralModelEvent ()
 Destructs the structural event.
 

Identity

virtual Category getCategory () const override
 Returns the category of the event (SBDDataGraphEvent::StructuralEvent)
 
Type getType () const
 Returns the structural model event type.
 
SBDDataGraphNodegetAuxiliaryNode () const
 Returns the auxiliary node.
 
static std::string getTypeString (Type type)
 Returns the structural model event type as a string.
 

Debugging

virtual void print (unsigned int offset=0) const override
 Prints the structural event.
 
 SB_DECLARE_DATA (SBMStructuralModelEvent)
 
 SBMStructuralModelEvent (SBMStructuralModelEventData *dataPointer)
 

Additional Inherited Members

- Public Types inherited from SBDDataGraphEvent
enum  Category {
  UndefinedEvent ,
  BaseEvent ,
  DocumentEvent ,
  StructuralEvent ,
  VisualEvent ,
  DynamicalEvent ,
  InteractionEvent ,
  PropertyEvent ,
  StateUpdaterEvent ,
  SimulatorEvent ,
  ControllerEvent ,
  AssetEvent
}
 The category of the data graph event. More...
 
- Public Member Functions inherited from SBDDataGraphEvent
 SB_DECLARE_DATA (SBDDataGraphEvent)
 
 SBDDataGraphEvent (SBDDataGraphNode *sender)
 
virtual ~SBDDataGraphEvent ()
 
SBDDataGraphNodegetSender () const
 Returns the sender of the event.
 
- Static Public Member Functions inherited from SBDDataGraphEvent
static std::string getCategoryString (Category category)
 Returns a string representation of the category of the data graph event.
 
- Protected Member Functions inherited from SBDDataGraphEvent
 SBDDataGraphEvent (SBDDataGraphEventData *dataPointer)
 
- Protected Attributes inherited from SBDDataGraphEvent
SBDDataGraphEventData * dataPointer
 

Member Enumeration Documentation

◆ Type

Enumerator
Any 

An event occurred.

AtomAdded 

An atom was added to the structural model.

AtomRemoved 

An atom was removed from the structural model.

AtomTypeChanged 

An atom type changed.

AtomNameChanged 

An atom name changed.

AtomAltLocationChanged 

An atom alt location changed.

AtomInsertionCodeChanged 

An atom insertion code changed.

AtomSerialNumberChanged 

An atom serial number changed.

AtomOccupancyChanged 

An atom occupancy changed.

AtomRecordTypeChanged 

An atom record type changed.

AtomPartialChargeChanged 

An atom partial charge changed.

AtomTemperatureFactorChanged 

An atom temperature factor changed.

AtomFormalChargeChanged 

An atom formal charge changed.

AtomCommentChanged 

An atom comment changed.

AtomSYBYLTypeChanged 

An atom SYBYL type changed.

AtomStatusBitChanged 

An atom status bit changed.

AtomAnisotropicTFactorsChanged 

An atom anisotropic T factor changed.

AtomOxidationStateChanged 

An atom oxidation state changed.

AtomHybridizationChanged 

An atom hybridization state changed.

AtomResonanceChanged 

An atom resonance changed.

AtomAromaticityChanged 

An atom aromaticity changed.

AtomElementChanged 

An atom element changed.

AtomWaterFlagChanged 

An atom water flag changed.

AtomCustomTypeChanged 

An atom custom type changed.

AtomGeometryChanged 

An atom geometry changed.

AtomPositionChanged 

An atom position changed.

AtomMassChanged 

An atom mass changed.

BondAdded 

A bond was added to the structural model.

BondRemoved 

A bond was removed from the structural model.

BondConnected 

A bond was connected to an atom.

BondDisconnected 

A bond was disconnected from an atom.

BondOrderChanged 

A bond order changed.

BondTypeChanged 

A bond type changed.

BondStatusBitChanged 

A bond status bit changed.

BondCustomTypeChanged 

A bond custom type changed.

ResidueAdded 

A residue was added to the structural model.

ResidueRemoved 

A residue was removed from the structural model.

BackboneAdded 

A backbone was added to the structural model.

BackboneRemoved 

A backbone was removed from the structural model.

SideChainAdded 

A side chain was added to the structural model.

SideChainRemoved 

A side chain was removed from the structural model.

ResidueTypeChanged 

A residue type was changed.

SegmentAdded 

A segment was added to the structural model.

SegmentRemoved 

A segment was removed from the structural model.

ChainAdded 

A chain was added to the structural model.

ChainRemoved 

A chain was removed from the structural model.

MoleculeAdded 

A molecule was added to the structural model.

MoleculeRemoved 

A molecule was removed from the structural model.

StructuralGroupAdded 

A structural group was added to the structural model.

StructuralGroupRemoved 

A structural group was removed from the structural model.

StructuralGroupCommentChanged 

A structural group comment changed.

StructuralGroupStatusBitChanged 

A structural group status bit changed.

StructuralGroupIDChanged 

A structural group ID changed.

FixedFlagChanged 

A fixed flag changed.

MobilityFlagChanged 

A fixed flag changed (deprecated). This value is no longer recommended for use and may not be fully functional or up-to-date with the latest version of the software. We recommend that you update your code to use the recommended alternative value instead, which is FixedFlagChanged.

TitleInformationChanged 

A title information changed.

PrimaryStructureInformationChanged 

A primary structure information changed.

HeterogenInformationChanged 

A heterogen information changed.

SecondaryStructureInformationChanged 

A secondary structure information changed.

ConnectivityAnnotationInformationChanged 

A connectivity annotation information changed.

MiscellaneousInformationChanged 

A miscellaneous information changed.

CrystallographicAndTransformationInformationChanged 

A crystallographic and transformation information changed.

TransformChanged 

The transform of the structural model changed.

SecondaryStructureChanged 

A secondary structure changed.

HydrophobicityChanged 

A hydrophobicity changed.

HydrogenBondAdded 

A Hydrogen-bond was added to the structural model.

HydrogenBondRemoved 

A Hydrogen-bond was removed from the structural model.

HydrogenBondGroupAdded 

A Hydrogen-bond group was added to the structural model.

HydrogenBondGroupRemoved 

A Hydrogen-bond group was removed from the structural model.

HydrogenBondGroupChanged 

A Hydrogen-bond group has been modified, e.g. hydrogen bonds have changed.

CoarseGrainedTypeChanged 

A coarse-grained radius was changed.

CoarseGrainedRadiusChanged 

A coarse-grained radius was changed.

CoarseGrainedMassChanged 

A coarse-grained mass was changed.

CoarseGrainedColorChanged 

A coarse-grained color was changed.

Member Function Documentation

◆ getCategory()

SBDDataGraphEvent::Category SBMStructuralModelEvent::getCategory ( ) const
overridevirtual

Reimplemented from SBDDataGraphEvent.

◆ print()

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

Reimplemented from SBDDataGraphEvent.