Geant4  10.00.p01
Public Member Functions | Private Member Functions | Private Attributes | List of all members
G4UIcommandTree Class Reference

#include <G4UIcommandTree.hh>

+ Collaboration diagram for G4UIcommandTree:

Public Member Functions

 G4UIcommandTree ()
 
 G4UIcommandTree (const char *thePathName)
 
 ~G4UIcommandTree ()
 
G4int operator== (const G4UIcommandTree &right) const
 
G4int operator!= (const G4UIcommandTree &right) const
 
void AddNewCommand (G4UIcommand *newCommand, G4bool workerThreadOnly=false)
 
void RemoveCommand (G4UIcommand *aCommand, G4bool workerThreadOnly=false)
 
G4UIcommand * FindPath (const char *commandPath) const
 
G4UIcommandTree * FindCommandTree (const char *commandPath)
 Try to match a command or a path with the one given. More...
 
G4String CompleteCommandPath (const G4String &commandPath)
 
void List () const
 
void ListCurrent () const
 
void ListCurrentWithNum () const
 
void CreateHTML ()
 
const G4UIcommand * GetGuidance () const
 
const G4String GetPathName () const
 
G4int GetTreeEntry () const
 
G4int GetCommandEntry () const
 
G4UIcommandTree * GetTree (G4int i)
 
G4UIcommandTree * GetTree (const char *comNameC)
 
G4UIcommand * GetCommand (G4int i)
 
const G4String GetTitle () const
 

Private Member Functions

G4String CreateFileName (const char *pName)
 
G4String ModStr (const char *strS)
 
G4String GetFirstMatchedString (const G4String &, const G4String &) const
 

Private Attributes

std::vector< G4UIcommand * > command
 
std::vector< G4UIcommandTree * > tree
 
G4UIcommand * guidance
 
G4String pathName
 
G4bool broadcastCommands
 

Detailed Description

Definition at line 44 of file G4UIcommandTree.hh.

Constructor & Destructor Documentation

G4UIcommandTree::G4UIcommandTree ( )

Definition at line 35 of file G4UIcommandTree.cc.

Referenced by AddNewCommand().

+ Here is the caller graph for this function:

G4UIcommandTree::G4UIcommandTree ( const char *  thePathName)

Definition at line 39 of file G4UIcommandTree.cc.

References pathName.

G4UIcommandTree::~G4UIcommandTree ( )

Definition at line 45 of file G4UIcommandTree.cc.

References tree.

Member Function Documentation

void G4UIcommandTree::AddNewCommand ( G4UIcommand *  newCommand,
G4bool  workerThreadOnly = false 
)

Definition at line 63 of file G4UIcommandTree.cc.

References AddNewCommand(), G4String::append(), broadcastCommands, command, G4String::first(), G4UIcommandTree(), G4UIcommand::GetCommandPath(), GetPathName(), guidance, G4String::isNull(), pathName, G4String::remove(), G4UIcommand::SetToBeBroadcasted(), G4UIcommand::SetWorkerThreadOnly(), G4UIcommand::ToBeBroadcasted(), and tree.

Referenced by AddNewCommand(), G4UImanager::AddNewCommand(), and G4UImanager::AddWorkerCommand().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4String G4UIcommandTree::CompleteCommandPath ( const G4String &  commandPath)

Definition at line 237 of file G4UIcommandTree.cc.

References FindCommandTree(), G4cout, G4endl, GetCommand(), GetCommandEntry(), GetFirstMatchedString(), GetPathName(), GetTree(), GetTreeEntry(), G4String::index(), G4String::last(), and G4String::remove().

+ Here is the call graph for this function:

G4String G4UIcommandTree::CreateFileName ( const char *  pName)
private

Definition at line 405 of file G4UIcommandTree.cc.

References G4String::index().

Referenced by CreateHTML().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void G4UIcommandTree::CreateHTML ( )

Definition at line 437 of file G4UIcommandTree.cc.

References command, CreateFileName(), G4endl, G4UIcommand::GetCommandName(), G4UIparameter::GetCurrentAsDefault(), G4UIparameter::GetDefaultValue(), G4UIcommand::GetGuidanceEntries(), G4UIcommand::GetGuidanceLine(), G4UIcommand::GetParameter(), G4UIparameter::GetParameterCandidates(), G4UIcommand::GetParameterEntries(), G4UIparameter::GetParameterName(), G4UIparameter::GetParameterRange(), G4UIparameter::GetParameterType(), GetPathName(), G4UIcommand::GetRange(), G4UIcommand::GetStateList(), G4StateManager::GetStateManager(), G4StateManager::GetStateString(), GetTitle(), guidance, G4UIparameter::IsOmittable(), ModStr(), pathName, and tree.

Referenced by G4UImanager::CreateHTML(), and export_G4UIcommandTree().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4UIcommandTree * G4UIcommandTree::FindCommandTree ( const char *  commandPath)

Try to match a command or a path with the one given.

: command or path to match

Returns
the commandTree found or NULL if not

Definition at line 209 of file G4UIcommandTree.cc.

References G4String::append(), G4String::first(), GetPathName(), G4String::index(), pathName, G4String::remove(), and tree.

Referenced by CompleteCommandPath().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4UIcommand * G4UIcommandTree::FindPath ( const char *  commandPath) const

Definition at line 171 of file G4UIcommandTree.cc.

References G4String::append(), command, G4String::first(), GetPathName(), G4String::index(), pathName, G4String::remove(), and tree.

Referenced by G4UImanager::ApplyCommand(), G4CascadeParamMessenger::CreateDirectory(), export_G4UIcommandTree(), G4VBasicShell::FindCommand(), G4UImanager::GetCurrentValues(), G4UIGAG::TerminalHelp(), G4VBasicShell::TerminalHelp(), and G4UIGainServer::TerminalHelp().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4UIcommand* G4UIcommandTree::GetCommand ( G4int  i)
inline

Definition at line 99 of file G4UIcommandTree.hh.

Referenced by G4UIGAG::CodeGenJavaParams(), G4UIGainServer::CodeGenJavaParams(), G4UIGAG::CodeGenJavaTree(), G4UIGainServer::CodeGenJavaTree(), G4UIGAG::CodeGenTclParams(), G4UIGAG::CodeGenTclTree(), CompleteCommandPath(), export_G4UIcommandTree(), G4UIGainServer::GetNewTreeStructure(), G4UIGAG::GetNewTreeStructure(), G4UIGainServer::GetNewTreeValues(), G4UIGAG::GetNewTreeValues(), G4UIGAG::SendDisableList(), G4UIGainServer::SendDisableList(), G4UIGAG::TerminalHelp(), G4VBasicShell::TerminalHelp(), and G4UIGainServer::TerminalHelp().

+ Here is the caller graph for this function:

G4int G4UIcommandTree::GetCommandEntry ( ) const
inline

Definition at line 85 of file G4UIcommandTree.hh.

Referenced by G4UIGAG::CodeGenJavaParams(), G4UIGainServer::CodeGenJavaParams(), G4UIGAG::CodeGenJavaTree(), G4UIGainServer::CodeGenJavaTree(), G4UIGAG::CodeGenTclParams(), G4UIGAG::CodeGenTclTree(), CompleteCommandPath(), export_G4UIcommandTree(), G4UIGainServer::GetNewTreeStructure(), G4UIGAG::GetNewTreeStructure(), G4UIGainServer::GetNewTreeValues(), G4UIGAG::GetNewTreeValues(), G4UIGAG::SendDisableList(), and G4UIGainServer::SendDisableList().

+ Here is the caller graph for this function:

G4String G4UIcommandTree::GetFirstMatchedString ( const G4String &  str1,
const G4String &  str2 
) const
private

Definition at line 317 of file G4UIcommandTree.cc.

Referenced by CompleteCommandPath().

+ Here is the caller graph for this function:

const G4UIcommand* G4UIcommandTree::GetGuidance ( ) const
inline

Definition at line 79 of file G4UIcommandTree.hh.

References guidance.

Referenced by export_G4UIcommandTree(), and ListCurrent().

+ Here is the caller graph for this function:

const G4String G4UIcommandTree::GetPathName ( ) const
inline

Definition at line 81 of file G4UIcommandTree.hh.

References pathName.

Referenced by AddNewCommand(), G4UIGAG::CodeGenJavaParams(), G4UIGainServer::CodeGenJavaParams(), G4UIGAG::CodeGenTclTree(), CompleteCommandPath(), CreateHTML(), export_G4UIcommandTree(), FindCommandTree(), FindPath(), G4UIGainServer::GetNewTreeStructure(), G4UIGAG::GetNewTreeStructure(), GetTree(), operator!=(), operator==(), and RemoveCommand().

+ Here is the caller graph for this function:

const G4String G4UIcommandTree::GetTitle ( ) const
inline

Definition at line 101 of file G4UIcommandTree.hh.

References G4UIcommand::GetTitle().

Referenced by G4UIGAG::CodeGenJavaParams(), G4UIGainServer::CodeGenJavaParams(), G4UIGAG::CodeGenTclTree(), CreateHTML(), export_G4UIcommandTree(), G4UIGainServer::GetNewTreeStructure(), and G4UIGAG::GetNewTreeStructure().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4UIcommandTree* G4UIcommandTree::GetTree ( G4int  i)
inline

Definition at line 87 of file G4UIcommandTree.hh.

Referenced by G4UIGAG::CodeGenJavaParams(), G4UIGainServer::CodeGenJavaParams(), G4UIGAG::CodeGenJavaTree(), G4UIGainServer::CodeGenJavaTree(), G4UIGAG::CodeGenTclParams(), G4UIGAG::CodeGenTclTree(), CompleteCommandPath(), G4VBasicShell::FindDirectory(), G4UImanager::FindDirectory(), G4UIGAG::FindDirPath(), G4UIGainServer::FindDirPath(), G4UIGainServer::GetNewTreeStructure(), G4UIGAG::GetNewTreeStructure(), G4UIGainServer::GetNewTreeValues(), G4UIGAG::GetNewTreeValues(), G4UIGAG::SendDisableList(), G4UIGainServer::SendDisableList(), G4UIGAG::TerminalHelp(), G4VBasicShell::TerminalHelp(), and G4UIGainServer::TerminalHelp().

+ Here is the caller graph for this function:

G4UIcommandTree* G4UIcommandTree::GetTree ( const char *  comNameC)
inline

Definition at line 89 of file G4UIcommandTree.hh.

References GetPathName().

+ Here is the call graph for this function:

G4int G4UIcommandTree::GetTreeEntry ( ) const
inline

Definition at line 83 of file G4UIcommandTree.hh.

Referenced by G4UIGAG::CodeGenJavaParams(), G4UIGainServer::CodeGenJavaParams(), G4UIGAG::CodeGenJavaTree(), G4UIGainServer::CodeGenJavaTree(), G4UIGAG::CodeGenTclParams(), G4UIGAG::CodeGenTclTree(), CompleteCommandPath(), export_G4UIcommandTree(), G4UIGainServer::GetNewTreeStructure(), G4UIGAG::GetNewTreeStructure(), G4UIGainServer::GetNewTreeValues(), G4UIGAG::GetNewTreeValues(), RemoveCommand(), G4UIGAG::SendDisableList(), G4UIGainServer::SendDisableList(), G4UIGAG::TerminalHelp(), G4VBasicShell::TerminalHelp(), and G4UIGainServer::TerminalHelp().

+ Here is the caller graph for this function:

void G4UIcommandTree::List ( ) const

Definition at line 390 of file G4UIcommandTree.cc.

References command, ListCurrent(), and tree.

Referenced by export_G4UIcommandTree(), and G4UImanager::ListCommands().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void G4UIcommandTree::ListCurrent ( ) const

Definition at line 338 of file G4UIcommandTree.cc.

References command, G4cout, G4endl, GetGuidance(), guidance, G4UIcommand::List(), pathName, and tree.

Referenced by export_G4UIcommandTree(), List(), G4UIGAG::ListDirectory(), G4VBasicShell::ListDirectory(), and G4UIGainServer::ListDirectory().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void G4UIcommandTree::ListCurrentWithNum ( ) const

Definition at line 367 of file G4UIcommandTree.cc.

References command, G4cout, G4endl, guidance, G4UIcommand::List(), pathName, and tree.

Referenced by export_G4UIcommandTree(), G4UIGAG::TerminalHelp(), G4VBasicShell::TerminalHelp(), and G4UIGainServer::TerminalHelp().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4String G4UIcommandTree::ModStr ( const char *  strS)
private

Definition at line 415 of file G4UIcommandTree.cc.

Referenced by CreateHTML().

+ Here is the caller graph for this function:

G4int G4UIcommandTree::operator!= ( const G4UIcommandTree &  right) const

Definition at line 58 of file G4UIcommandTree.cc.

References GetPathName(), and pathName.

+ Here is the call graph for this function:

G4int G4UIcommandTree::operator== ( const G4UIcommandTree &  right) const

Definition at line 53 of file G4UIcommandTree.cc.

References GetPathName(), and pathName.

+ Here is the call graph for this function:

void G4UIcommandTree::RemoveCommand ( G4UIcommand *  aCommand,
G4bool  workerThreadOnly = false 
)

Definition at line 116 of file G4UIcommandTree.cc.

References G4String::append(), command, G4String::first(), G4UIcommand::GetCommandPath(), GetPathName(), GetTreeEntry(), guidance, G4String::isNull(), G4UIcommand::IsWorkerThreadOnly(), pathName, G4String::remove(), and tree.

Referenced by G4UImanager::RemoveCommand(), and G4UImanager::RemoveWorkerCommand().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

G4bool G4UIcommandTree::broadcastCommands
private

Definition at line 76 of file G4UIcommandTree.hh.

Referenced by AddNewCommand().

std::vector<G4UIcommand*> G4UIcommandTree::command
private

Definition at line 72 of file G4UIcommandTree.hh.

Referenced by AddNewCommand(), CreateHTML(), FindPath(), List(), ListCurrent(), ListCurrentWithNum(), and RemoveCommand().

G4UIcommand* G4UIcommandTree::guidance
private

Definition at line 74 of file G4UIcommandTree.hh.

Referenced by AddNewCommand(), CreateHTML(), GetGuidance(), ListCurrent(), ListCurrentWithNum(), and RemoveCommand().

G4String G4UIcommandTree::pathName
private

Definition at line 75 of file G4UIcommandTree.hh.

Referenced by AddNewCommand(), CreateHTML(), FindCommandTree(), FindPath(), G4UIcommandTree(), GetPathName(), ListCurrent(), ListCurrentWithNum(), operator!=(), operator==(), and RemoveCommand().

std::vector<G4UIcommandTree*> G4UIcommandTree::tree
private

Definition at line 73 of file G4UIcommandTree.hh.

Referenced by AddNewCommand(), CreateHTML(), FindCommandTree(), FindPath(), List(), ListCurrent(), ListCurrentWithNum(), RemoveCommand(), and ~G4UIcommandTree().

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