Slicer  4.11
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 | Static Public Attributes | Protected Member Functions
vtkSlicerSubjectHierarchyModuleLogic Class Reference

#include <Modules/Loadable/SubjectHierarchy/Logic/vtkSlicerSubjectHierarchyModuleLogic.h>

Inheritance diagram for vtkSlicerSubjectHierarchyModuleLogic:
Inheritance graph
[legend]
Collaboration diagram for vtkSlicerSubjectHierarchyModuleLogic:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
 
vtkMRMLSubjectHierarchyNodeGetSubjectHierarchyNode ()
 Convenience function to get subject hierarchy node from the logic. More...
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkSlicerModuleLogic
virtual vtkSlicerApplicationLogicGetApplicationLogic ()
 Get access to overall application state. More...
 
std::string GetModuleShareDirectory () const
 
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 vtkIdType AreItemsInSameBranch (vtkMRMLSubjectHierarchyNode *shNode, vtkIdType item1, vtkIdType item2, std::string lowestCommonLevel)
 
static vtkIdType AreNodesInSameBranch (vtkMRMLNode *node1, vtkMRMLNode *node2, std::string lowestCommonLevel)
 
static vtkIdType CloneSubjectHierarchyItem (vtkMRMLSubjectHierarchyNode *shNode, vtkIdType itemID, const char *name=nullptr)
 
static void HardenTransformOnBranch (vtkMRMLSubjectHierarchyNode *shNode, vtkIdType itemID)
 
static vtkIdType InsertDicomSeriesInHierarchy (vtkMRMLSubjectHierarchyNode *shNode, const char *subjectId, const char *studyInstanceUID, const char *seriesInstanceUID)
 
static bool IsPatientTag (std::string tagName)
 Determine if a tag name is a patient tag (not attribute, but tag - without prefix!) More...
 
static bool IsStudyTag (std::string tagName)
 Determine if a tag name is a study tag (not attribute, but tag - without prefix!) More...
 
static int IsTypeOf (const char *type)
 
static vtkSlicerSubjectHierarchyModuleLogicNew ()
 
static vtkSlicerSubjectHierarchyModuleLogicSafeDownCast (vtkObject *o)
 
static void TransformBranch (vtkMRMLSubjectHierarchyNode *shNode, vtkIdType itemID, vtkMRMLTransformNode *transformNode, bool hardenExistingTransforms=true)
 
- Static Public Member Functions inherited from vtkSlicerModuleLogic
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)
 

Static Public Attributes

static const char * CLONED_NODE_NAME_POSTFIX
 Postfix added to cloned node name by default. More...
 

Protected Member Functions

void SetMRMLSceneInternal (vtkMRMLScene *newScene) override
 Called each time a new scene is set. More...
 
void UpdateFromMRMLScene () override
 Called every time the scene has been significantly changed. More...
 
 vtkSlicerSubjectHierarchyModuleLogic ()
 
 ~vtkSlicerSubjectHierarchyModuleLogic () override
 
- Protected Member Functions inherited from vtkSlicerModuleLogic
 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)
 
void SetProcessingMRMLSceneEvent (int event)
 
bool StartModify ()
 
virtual void UnobserveMRMLScene ()
 
 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

Definition at line 41 of file vtkSlicerSubjectHierarchyModuleLogic.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkSlicerSubjectHierarchyModuleLogic.h.

Constructor & Destructor Documentation

◆ vtkSlicerSubjectHierarchyModuleLogic()

vtkSlicerSubjectHierarchyModuleLogic::vtkSlicerSubjectHierarchyModuleLogic ( )
protected

◆ ~vtkSlicerSubjectHierarchyModuleLogic()

vtkSlicerSubjectHierarchyModuleLogic::~vtkSlicerSubjectHierarchyModuleLogic ( )
overrideprotected

Member Function Documentation

◆ AreItemsInSameBranch()

static vtkIdType vtkSlicerSubjectHierarchyModuleLogic::AreItemsInSameBranch ( vtkMRMLSubjectHierarchyNode shNode,
vtkIdType  item1,
vtkIdType  item2,
std::string  lowestCommonLevel 
)
static

Determine if two subject hierarchy items are in the same branch (share the same parent)

Parameters
shNodeSubject hierarchy to search in
item1First item to check
item2Second item to check
lowestCommonLevelLowest level on which they have to share an ancestor
Returns
The common parent if the two items share a parent on the specified level, INVALID_ITEM_ID otherwise

◆ AreNodesInSameBranch()

static vtkIdType vtkSlicerSubjectHierarchyModuleLogic::AreNodesInSameBranch ( vtkMRMLNode node1,
vtkMRMLNode node2,
std::string  lowestCommonLevel 
)
static

Determine if two data nodes are in the same branch in subject hierarchy (share the same parent)

Parameters
node1First node to check. Can be subject hierarchy node or a node associated with one
node2Second node to check
lowestCommonLevelLowest level on which they have to share an ancestor
Returns
The common parent if the two nodes share a parent on the specified level, INVALID_ITEM_ID otherwise

◆ CloneSubjectHierarchyItem()

static vtkIdType vtkSlicerSubjectHierarchyModuleLogic::CloneSubjectHierarchyItem ( vtkMRMLSubjectHierarchyNode shNode,
vtkIdType  itemID,
const char *  name = nullptr 
)
static

Clone subject hierarchy node, the associated data node, and its display and storage nodes

Parameters
itemIDSubject hierarchy item to clone
nameCustom name. If omitted, then default postfix is added from
See also
node
Returns
Clone subject hierarchy node

◆ GetClassName()

virtual const char* vtkSlicerSubjectHierarchyModuleLogic::GetClassName ( )
virtual

Reimplemented from vtkSlicerModuleLogic.

◆ GetSubjectHierarchyNode()

vtkMRMLSubjectHierarchyNode* vtkSlicerSubjectHierarchyModuleLogic::GetSubjectHierarchyNode ( )

Convenience function to get subject hierarchy node from the logic.

◆ HardenTransformOnBranch()

static void vtkSlicerSubjectHierarchyModuleLogic::HardenTransformOnBranch ( vtkMRMLSubjectHierarchyNode shNode,
vtkIdType  itemID 
)
static

Harden transform on subject hierarchy item and on all children, recursively

Parameters
shNodeSubject hierarchy where item can be found
itemIDSubject hierarchy item defining branch to harden transform on

◆ InsertDicomSeriesInHierarchy()

static vtkIdType vtkSlicerSubjectHierarchyModuleLogic::InsertDicomSeriesInHierarchy ( vtkMRMLSubjectHierarchyNode shNode,
const char *  subjectId,
const char *  studyInstanceUID,
const char *  seriesInstanceUID 
)
static

Place series in subject hierarchy. Create subject and study node if needed

Returns
Series subject hierarchy node of the inserted series

◆ IsA()

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

Reimplemented from vtkSlicerModuleLogic.

◆ IsPatientTag()

static bool vtkSlicerSubjectHierarchyModuleLogic::IsPatientTag ( std::string  tagName)
static

Determine if a tag name is a patient tag (not attribute, but tag - without prefix!)

◆ IsStudyTag()

static bool vtkSlicerSubjectHierarchyModuleLogic::IsStudyTag ( std::string  tagName)
static

Determine if a tag name is a study tag (not attribute, but tag - without prefix!)

◆ IsTypeOf()

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

◆ New()

static vtkSlicerSubjectHierarchyModuleLogic* vtkSlicerSubjectHierarchyModuleLogic::New ( )
static

◆ PrintSelf()

void vtkSlicerSubjectHierarchyModuleLogic::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ SafeDownCast()

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

◆ SetMRMLSceneInternal()

void vtkSlicerSubjectHierarchyModuleLogic::SetMRMLSceneInternal ( vtkMRMLScene newScene)
overrideprotectedvirtual

Called each time a new scene is set.

Reimplemented from vtkMRMLAbstractLogic.

◆ TransformBranch()

static void vtkSlicerSubjectHierarchyModuleLogic::TransformBranch ( vtkMRMLSubjectHierarchyNode shNode,
vtkIdType  itemID,
vtkMRMLTransformNode transformNode,
bool  hardenExistingTransforms = true 
)
static

Apply transform node as parent transform on subject hierarchy node and on all children, recursively

Parameters
shNodeSubject hierarchy where item can be found
itemIDSubject hierarchy item defining branch to apply transform on
transformNodeTransform node to apply. If nullptr, then any existing transform is removed
hardenExistingTransformsMode of handling already transformed nodes. If true (default), then the possible parent transforms of target nodes are hardened before applying the specified transform. If false, then the already applied parent transforms are transformed with the specified transform (Note: this latter approach may result in unwanted transformations of other nodes)

◆ UpdateFromMRMLScene()

void vtkSlicerSubjectHierarchyModuleLogic::UpdateFromMRMLScene ( )
overrideprotectedvirtual

Called every time the scene has been significantly changed.

Reimplemented from vtkMRMLAbstractLogic.

Member Data Documentation

◆ CLONED_NODE_NAME_POSTFIX

const char* vtkSlicerSubjectHierarchyModuleLogic::CLONED_NODE_NAME_POSTFIX
static

Postfix added to cloned node name by default.

Definition at line 46 of file vtkSlicerSubjectHierarchyModuleLogic.h.


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