Slicer  4.13
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkSlicerModuleLogic Class Reference

#include <Base/Logic/vtkSlicerModuleLogic.h>

Inheritance diagram for vtkSlicerModuleLogic:
Inheritance graph
Collaboration diagram for vtkSlicerModuleLogic:
Collaboration graph

Public Types

typedef vtkMRMLAbstractLogic Superclass
- Public Types inherited from vtkMRMLAbstractLogic
typedef vtkObject Superclass
typedef void(vtkMRMLAbstractLogic::* TaskFunctionPointer) (void *clientdata)

Public Member Functions

virtual vtkSlicerApplicationLogicGetApplicationLogic ()
 Get access to overall application state. More...
virtual const char * GetClassName ()
virtual vtkMRMLAbstractLogicGetModuleLogic (const char *moduleName)
 Convenience method for getting another module's logic from the application logic. More...
std::string GetModuleShareDirectory () const
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent) override
void SetModuleShareDirectory (const std::string &shareDirectory)
- Public Member Functions inherited from vtkMRMLAbstractLogic
virtual vtkMRMLApplicationLogicGetMRMLApplicationLogic () const
 Get access to overall application state. More...
vtkMRMLSceneGetMRMLScene () const
 Return a reference to the current MRML scene. More...
void PrintSelf (ostream &os, vtkIndent indent) override
virtual void SetMRMLApplicationLogic (vtkMRMLApplicationLogic *logic)
void SetMRMLScene (vtkMRMLScene *newScene)
 Set and observe the MRMLScene. More...

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkSlicerModuleLogicNew ()
 The Usual vtk class functions. More...
static vtkSlicerModuleLogicSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkMRMLAbstractLogic
static int IsTypeOf (const char *type)
static vtkMRMLAbstractLogicNew ()
static vtkMRMLAbstractLogicSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSlicerModuleLogic ()
 ~vtkSlicerModuleLogic () override
- Protected Member Functions inherited from vtkMRMLAbstractLogic
int EndModify (bool wasModifying)
virtual bool EnterMRMLLogicsCallback () const
virtual bool EnterMRMLNodesCallback () const
virtual bool EnterMRMLSceneCallback () const
bool GetDisableModifiedEvent () const
int GetInMRMLLogicsCallbackFlag () const
int GetInMRMLNodesCallbackFlag () const
int GetInMRMLSceneCallbackFlag () const
vtkCallbackCommand * GetMRMLLogicsCallbackCommand ()
vtkObserverManagerGetMRMLLogicsObserverManager () const
vtkCallbackCommand * GetMRMLNodesCallbackCommand ()
vtkObserverManagerGetMRMLNodesObserverManager () const
vtkCallbackCommand * GetMRMLSceneCallbackCommand ()
vtkObserverManagerGetMRMLSceneObserverManager () const
int GetPendingModifiedEventCount () const
int GetProcessingMRMLSceneEvent () const
 Return the event id currently processed or 0 if any. More...
int InvokePendingModifiedEvent ()
void Modified () override
virtual void ObserveMRMLScene ()
virtual void OnMRMLNodeModified (vtkMRMLNode *)
virtual void OnMRMLSceneEndBatchProcess ()
virtual void OnMRMLSceneEndClose ()
virtual void OnMRMLSceneEndImport ()
virtual void OnMRMLSceneEndRestore ()
virtual void OnMRMLSceneNew ()
virtual void OnMRMLSceneNodeAdded (vtkMRMLNode *)
virtual void OnMRMLSceneNodeRemoved (vtkMRMLNode *)
virtual void OnMRMLSceneStartBatchProcess ()
virtual void OnMRMLSceneStartClose ()
virtual void OnMRMLSceneStartImport ()
virtual void OnMRMLSceneStartRestore ()
virtual void ProcessMRMLLogicsEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void ProcessMRMLSceneEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void RegisterNodes ()
void SetAndObserveMRMLSceneEventsInternal (vtkMRMLScene *newScene, vtkIntArray *events, vtkFloatArray *priorities=nullptr)
void SetDisableModifiedEvent (bool onOff)
void SetInMRMLLogicsCallbackFlag (int flag)
void SetInMRMLNodesCallbackFlag (int flag)
void SetInMRMLSceneCallbackFlag (int flag)
virtual void SetMRMLSceneInternal (vtkMRMLScene *newScene)
void SetProcessingMRMLSceneEvent (int event)
bool StartModify ()
virtual void UnobserveMRMLScene ()
virtual void UpdateFromMRMLScene ()
 vtkMRMLAbstractLogic ()
 ~vtkMRMLAbstractLogic () override

Additional Inherited Members

- Static Protected Member Functions inherited from vtkMRMLAbstractLogic
static void MRMLLogicsCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 MRMLLogicCallback is a static function to relay modified events from the logics. More...
static void MRMLNodesCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 MRMLNodesCallback is a static function to relay modified events from the nodes. More...
static void MRMLSceneCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)

Detailed Description

vtkSlicerModuleLogic - superclass for slicer module logic classes

Superclass for all slicer module logic classes

No GUI code goes in the logic class.

Definition at line 23 of file vtkSlicerModuleLogic.h.

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkSlicerModuleLogic.h.

Constructor & Destructor Documentation

◆ vtkSlicerModuleLogic()

vtkSlicerModuleLogic::vtkSlicerModuleLogic ( )

◆ ~vtkSlicerModuleLogic()

vtkSlicerModuleLogic::~vtkSlicerModuleLogic ( )

Member Function Documentation

◆ GetApplicationLogic()

virtual vtkSlicerApplicationLogic* vtkSlicerModuleLogic::GetApplicationLogic ( )

Get access to overall application state.

◆ GetClassName()

virtual const char* vtkSlicerModuleLogic::GetClassName ( )

◆ GetModuleLogic()

virtual vtkMRMLAbstractLogic* vtkSlicerModuleLogic::GetModuleLogic ( const char *  moduleName)

Convenience method for getting another module's logic from the application logic.

◆ GetModuleShareDirectory()

std::string vtkSlicerModuleLogic::GetModuleShareDirectory ( ) const

◆ IsA()

virtual int vtkSlicerModuleLogic::IsA ( const char *  type)

◆ IsTypeOf()

static int vtkSlicerModuleLogic::IsTypeOf ( const char *  type)

◆ New()

static vtkSlicerModuleLogic* vtkSlicerModuleLogic::New ( )

The Usual vtk class functions.

◆ PrintSelf()

void vtkSlicerModuleLogic::PrintSelf ( ostream &  os,
vtkIndent  indent 

◆ SafeDownCast()

static vtkSlicerModuleLogic* vtkSlicerModuleLogic::SafeDownCast ( vtkObject *  o)

◆ SetModuleShareDirectory()

void vtkSlicerModuleLogic::SetModuleShareDirectory ( const std::string &  shareDirectory)

The documentation for this class was generated from the following file: