ALBA
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
albaOpManager Class Reference

#include <albaOpManager.h>

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

Public Member Functions

 albaOpManager ()
 
virtual ~albaOpManager ()
 
virtual void SetListener (albaObserver *Listener)
 
virtual void OnEvent (albaEventBase *alba_event)
 
virtual void OpAdd (albaOp *op, wxString menuPath="", bool can_undo=true, albaGUISettings *setting=NULL)
 
virtual void FillMenu (wxMenu *import, wxMenu *mexport, wxMenu *operations)
 
void FillSettingDialog (albaGUISettingsDialog *settingDialog)
 
virtual void VmeSelected (albaVME *v)
 
virtual void VmeModified (albaVME *v)
 
virtual void VmeRemove (albaVME *v)
 
virtual albaVMEGetSelectedVme ()
 
virtual void OpRun (int op_id)
 
virtual void OpRun (albaOp *op, void *op_param=NULL)
 
virtual void OpRun (albaString &op_type, void *op_param=NULL)
 
void RunOpAddGroup ()
 
void RunOpCut ()
 
void RunOpCopy ()
 
void RunOpPaste ()
 
void RunOpDelete ()
 
void RunOpRename ()
 
void RunOpReparentTo ()
 
void RunOpShowHistory ()
 
virtual void OpExec (albaOp *op)
 
virtual void OpSelect (albaVME *v)
 
virtual void WarningIfCantUndo (bool warn)
 
virtual void SetToolbar (wxToolBar *tb)
 
virtual void SetMenubar (wxMenuBar *mb)
 
virtual bool Running ()
 
virtual void ClearUndoStack ()
 
virtual bool ForceStopWithOk ()
 
virtual bool ForceStopWithCancel ()
 
virtual bool StopCurrentOperation ()
 
void EnableContextualMenu (albaGUITreeContextualMenu *contextualMenu, albaVME *node, bool CanEnable=true)
 
albaOpGetRunningOperation ()
 
albaOpGetOperationById (int id)
 
void SetMouse (albaDeviceButtonsPadMouse *mouse)
 
void RefreshMenu ()
 
void SetMafUser (albaUser *user)
 
albaUserGetMafUser ()
 
virtual void EnableOp (bool CanEnable=true)
 
albaString GetBuildNum () const
 
void SetBuildNum (albaString val)
 
- Public Member Functions inherited from albaObserver
 albaObserver ()
 
virtual ~albaObserver ()
 
virtual void OnEvent (albaEventBase *e)=0
 

Protected Member Functions

virtual void OpDo (albaOp *op)
 
virtual void OpRunOk (albaOp *op)
 
virtual void OpRunCancel (albaOp *op)
 
virtual void OpUndo ()
 
virtual void OpRedo ()
 
virtual bool WarnUser (albaOp *op)
 
virtual void Notify (int msg, long arg=0L)
 
virtual void EnableToolbar (bool CanEnable=true)
 
void FillTraceabilityAttribute (albaOp *op, albaVME *in_node, albaVME *out_node)
 
void SetAccelerator (albaOp *op)
 

Protected Attributes

albaDeviceButtonsPadMousem_Mouse
 
bool m_Warn
 
albaOpContextStack m_Context
 
albaOpm_RunningOp
 
wxMenu * m_Menu [3]
 
albaVMEm_Selected
 
albaVMEm_NaturalNode
 
albaUserm_User
 
std::vector< albaOp * > m_OpList
 
int m_NumOp
 
wxAcceleratorEntry m_OpAccelEntries [MAXOP]
 
int m_NumOfAccelerators
 
void * m_OpParameters
 
albaOpSelectm_OpSelect
 
albaOpCutm_OpCut
 
albaOpCopym_OpCopy
 
albaOpPastem_OpPaste
 
albaOpRenamem_OpRename
 
albaOpReparentTo * m_OpReparent
 
albaOpCreateGroup * m_OpAddGroup
 
albaOpShowHistory * m_OpShowHistory
 
wxMenuBar * m_MenuBar
 
wxToolBar * m_ToolBar
 
albaString m_BuildNum
 
albaObserverm_Listener
 

Friends

class albaOpManagerTest
 

Detailed Description

Definition at line 61 of file albaOpManager.h.

Constructor & Destructor Documentation

◆ albaOpManager()

albaOpManager::albaOpManager ( )

◆ ~albaOpManager()

virtual albaOpManager::~albaOpManager ( )
virtual

Member Function Documentation

◆ SetListener()

virtual void albaOpManager::SetListener ( albaObserver Listener)
inlinevirtual

Definition at line 66 of file albaOpManager.h.

◆ OnEvent()

virtual void albaOpManager::OnEvent ( albaEventBase e)
virtual

process the events sent by subjects

Implements albaObserver.

◆ OpAdd()

virtual void albaOpManager::OpAdd ( albaOp op,
wxString  menuPath = "",
bool  can_undo = true,
albaGUISettings setting = NULL 
)
virtual

Event IDs used in collaborative modality.

Add the operation 'op' to the list of available operations.

◆ FillMenu()

virtual void albaOpManager::FillMenu ( wxMenu *  import,
wxMenu *  mexport,
wxMenu *  operations 
)
virtual

Fill the application men with the operations name.

◆ FillSettingDialog()

void albaOpManager::FillSettingDialog ( albaGUISettingsDialog settingDialog)

Fill the setting dialog with the settings associated to the plugged operations.

◆ VmeSelected()

virtual void albaOpManager::VmeSelected ( albaVME v)
virtual

Record the selected vme and enable the menu_entries relative to the compatible operations.

◆ VmeModified()

virtual void albaOpManager::VmeModified ( albaVME v)
virtual

Record the modified vme and enable the menu_entries relative to the compatible operations.

◆ VmeRemove()

virtual void albaOpManager::VmeRemove ( albaVME v)
virtual

Vme removed notification.

◆ GetSelectedVme()

virtual albaVME * albaOpManager::GetSelectedVme ( )
virtual

Return the selected vme.

◆ OpRun() [1/3]

virtual void albaOpManager::OpRun ( int  op_id)
virtual

Run the operation by id.

◆ OpRun() [2/3]

virtual void albaOpManager::OpRun ( albaOp op,
void *  op_param = NULL 
)
virtual

Call this to exec an operation with user interaction and undo/redo services.

◆ OpRun() [3/3]

virtual void albaOpManager::OpRun ( albaString op_type,
void *  op_param = NULL 
)
virtual

Run the operation by searching it from its type name.

◆ RunOpAddGroup()

void albaOpManager::RunOpAddGroup ( )

◆ RunOpCut()

void albaOpManager::RunOpCut ( )

◆ RunOpCopy()

void albaOpManager::RunOpCopy ( )

◆ RunOpPaste()

void albaOpManager::RunOpPaste ( )

◆ RunOpDelete()

void albaOpManager::RunOpDelete ( )

◆ RunOpRename()

void albaOpManager::RunOpRename ( )

◆ RunOpReparentTo()

void albaOpManager::RunOpReparentTo ( )

◆ RunOpShowHistory()

void albaOpManager::RunOpShowHistory ( )

◆ OpExec()

virtual void albaOpManager::OpExec ( albaOp op)
virtual

Execute the operation 'op' and warn the user if the operation is undoable.

◆ OpSelect()

virtual void albaOpManager::OpSelect ( albaVME v)
virtual

Execute the select operation.

◆ WarningIfCantUndo()

virtual void albaOpManager::WarningIfCantUndo ( bool  warn)
inlinevirtual

Set the flag for warning the user if the operation is undoable.

Definition at line 120 of file albaOpManager.h.

◆ SetToolbar()

virtual void albaOpManager::SetToolbar ( wxToolBar *  tb)
inlinevirtual

Set a reference to the main toolbar.

Definition at line 123 of file albaOpManager.h.

◆ SetMenubar()

virtual void albaOpManager::SetMenubar ( wxMenuBar *  mb)
inlinevirtual

Set a reference to the main men.

Definition at line 126 of file albaOpManager.h.

◆ Running()

virtual bool albaOpManager::Running ( )
inlinevirtual

return true if there is a running operation.

Definition at line 129 of file albaOpManager.h.

◆ ClearUndoStack()

virtual void albaOpManager::ClearUndoStack ( )
virtual

Clear the stack of executed operation.

◆ ForceStopWithOk()

virtual bool albaOpManager::ForceStopWithOk ( )
virtual

Try to Stop the Current operation with OK condition.

◆ ForceStopWithCancel()

virtual bool albaOpManager::ForceStopWithCancel ( )
virtual

Try to Stop the Current Stop operation with CANCEL condition.

◆ StopCurrentOperation()

virtual bool albaOpManager::StopCurrentOperation ( )
virtual

Stop the current operation in any case - to be used as last resort.

◆ EnableContextualMenu()

void albaOpManager::EnableContextualMenu ( albaGUITreeContextualMenu contextualMenu,
albaVME node,
bool  CanEnable = true 
)

◆ GetRunningOperation()

albaOp * albaOpManager::GetRunningOperation ( )

Return the current running operation.

Return NULL if no operation is running.

◆ GetOperationById()

albaOp * albaOpManager::GetOperationById ( int  id)

Return an instance of operation from id.

◆ SetMouse()

void albaOpManager::SetMouse ( albaDeviceButtonsPadMouse mouse)

Initialize the action for the mouse device.

◆ RefreshMenu()

void albaOpManager::RefreshMenu ( )

Called by logic to refresh the operation's menù items.

◆ SetMafUser()

void albaOpManager::SetMafUser ( albaUser user)

Set MafUser.

◆ GetMafUser()

albaUser * albaOpManager::GetMafUser ( )
inline

Return the current alba user.

Definition at line 162 of file albaOpManager.h.

◆ EnableOp()

virtual void albaOpManager::EnableOp ( bool  CanEnable = true)
virtual

Enable/Disable the men items operation.

◆ GetBuildNum()

albaString albaOpManager::GetBuildNum ( ) const
inline

Set Build Num.

Definition at line 169 of file albaOpManager.h.

◆ SetBuildNum()

void albaOpManager::SetBuildNum ( albaString  val)
inline

Get Build Num.

Definition at line 172 of file albaOpManager.h.

◆ OpDo()

virtual void albaOpManager::OpDo ( albaOp op)
protectedvirtual

Execute the current operation.

◆ OpRunOk()

virtual void albaOpManager::OpRunOk ( albaOp op)
protectedvirtual

This method is called if the operation must be executed.

◆ OpRunCancel()

virtual void albaOpManager::OpRunCancel ( albaOp op)
protectedvirtual

The operation is not executed and is deleted.

◆ OpUndo()

virtual void albaOpManager::OpUndo ( )
protectedvirtual

Execute the 'UnDo' method of the operation.

◆ OpRedo()

virtual void albaOpManager::OpRedo ( )
protectedvirtual

Execute the 'Do' method of the operation.

◆ WarnUser()

virtual bool albaOpManager::WarnUser ( albaOp op)
protectedvirtual

Warn the user if the operation is undoable.

◆ Notify()

virtual void albaOpManager::Notify ( int  msg,
long  arg = 0L 
)
protectedvirtual

Sent a string message to the listener.

◆ EnableToolbar()

virtual void albaOpManager::EnableToolbar ( bool  CanEnable = true)
protectedvirtual

Enable/Disable the toolbar's buttons.

◆ FillTraceabilityAttribute()

void albaOpManager::FillTraceabilityAttribute ( albaOp op,
albaVME in_node,
albaVME out_node 
)
protected

Fill the attribute for traceability events.

◆ SetAccelerator()

void albaOpManager::SetAccelerator ( albaOp op)
protected

Friends And Related Function Documentation

◆ albaOpManagerTest

friend class albaOpManagerTest
friend

test friend

Definition at line 236 of file albaOpManager.h.

Member Data Documentation

◆ m_Mouse

albaDeviceButtonsPadMouse* albaOpManager::m_Mouse
protected

Pointer to the mouse devices.

Definition at line 204 of file albaOpManager.h.

◆ m_Warn

bool albaOpManager::m_Warn
protected

Flag to warn the user when an operation that can not undo is starting.

Definition at line 205 of file albaOpManager.h.

◆ m_Context

albaOpContextStack albaOpManager::m_Context
protected

Definition at line 206 of file albaOpManager.h.

◆ m_RunningOp

albaOp* albaOpManager::m_RunningOp
protected

Pointer to the current running operation.

Definition at line 207 of file albaOpManager.h.

◆ m_Menu

wxMenu* albaOpManager::m_Menu[3]
protected

Array of pointers to the menu 'Operations', 'Importer' and 'Exporter'.

Definition at line 208 of file albaOpManager.h.

◆ m_Selected

albaVME* albaOpManager::m_Selected
protected

Pointer to the current selected node.

Definition at line 209 of file albaOpManager.h.

◆ m_NaturalNode

albaVME* albaOpManager::m_NaturalNode
protected

Pointer to the NATURAL node on which is running a non-input preserving operation.

Definition at line 210 of file albaOpManager.h.

◆ m_User

albaUser* albaOpManager::m_User
protected

User credentials.

Definition at line 212 of file albaOpManager.h.

◆ m_OpList

std::vector<albaOp *> albaOpManager::m_OpList
protected

List of pointer of plugged operations.

Definition at line 214 of file albaOpManager.h.

◆ m_NumOp

int albaOpManager::m_NumOp
protected

Number of plugged operations.

Definition at line 215 of file albaOpManager.h.

◆ m_OpAccelEntries

wxAcceleratorEntry albaOpManager::m_OpAccelEntries[MAXOP]
protected

List of Accelerators for menu items.

Definition at line 216 of file albaOpManager.h.

◆ m_NumOfAccelerators

int albaOpManager::m_NumOfAccelerators
protected

Definition at line 217 of file albaOpManager.h.

◆ m_OpParameters

void* albaOpManager::m_OpParameters
protected

Pointer to the operation's parameter list.

Definition at line 219 of file albaOpManager.h.

◆ m_OpSelect

albaOpSelect* albaOpManager::m_OpSelect
protected

Pointer to the (always available) operation for selecting VMEs.

Definition at line 221 of file albaOpManager.h.

◆ m_OpCut

albaOpCut* albaOpManager::m_OpCut
protected

Pointer to the (always available) operation for cutting VMEs.

Definition at line 222 of file albaOpManager.h.

◆ m_OpCopy

albaOpCopy* albaOpManager::m_OpCopy
protected

Pointer to the (always available) operation for copying VMEs.

Definition at line 223 of file albaOpManager.h.

◆ m_OpPaste

albaOpPaste* albaOpManager::m_OpPaste
protected

Pointer to the (always available) operation for pasting VMEs.

Definition at line 224 of file albaOpManager.h.

◆ m_OpRename

albaOpRename* albaOpManager::m_OpRename
protected

Pointer to the (always available) operation for reparenting VMEs.

Definition at line 225 of file albaOpManager.h.

◆ m_OpReparent

albaOpReparentTo* albaOpManager::m_OpReparent
protected

Pointer to the (always available) operation for reparenting VMEs.

Definition at line 226 of file albaOpManager.h.

◆ m_OpAddGroup

albaOpCreateGroup* albaOpManager::m_OpAddGroup
protected

Pointer to the (always available) operation for Adding Group VMEs.

Definition at line 227 of file albaOpManager.h.

◆ m_OpShowHistory

albaOpShowHistory* albaOpManager::m_OpShowHistory
protected

Definition at line 228 of file albaOpManager.h.

◆ m_MenuBar

wxMenuBar* albaOpManager::m_MenuBar
protected

Pointer to the Application's main menù.

Definition at line 229 of file albaOpManager.h.

◆ m_ToolBar

wxToolBar* albaOpManager::m_ToolBar
protected

Pointer to the application's Toolbal.

Definition at line 230 of file albaOpManager.h.

◆ m_BuildNum

albaString albaOpManager::m_BuildNum
protected

Definition at line 231 of file albaOpManager.h.

◆ m_Listener

albaObserver* albaOpManager::m_Listener
protected

Definition at line 233 of file albaOpManager.h.


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