G4UIcommandTree Class Reference

#include <G4UIcommandTree.hh>

Public Member Functions
	G4UIcommandTree ()=default
	G4UIcommandTree (const char *thePathName)
	~G4UIcommandTree ()
G4bool	operator== (const G4UIcommandTree &right) const
G4bool	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)
G4String	GetFirstMatchedString (const G4String &, const G4String &) const
G4String	CompleteCommandPath (const G4String &commandPath)
void	List () const
void	ListCurrent () const
void	ListCurrentWithNum () const
void	CreateHTML (const G4String &="")
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

Detailed Description

Definition at line 44 of file G4UIcommandTree.hh.

Constructor & Destructor Documentation

G4UIcommandTree() [1/2]

G4UIcommandTree::G4UIcommandTree ( )

default

Referenced by AddNewCommand(), CompleteCommandPath(), FindCommandTree(), G4UIcommandTree(), GetTree(), GetTree(), operator!=(), operator==(), and RemoveCommand().

G4UIcommandTree() [2/2]

G4UIcommandTree::G4UIcommandTree

(

const char *

thePathName

)

Definition at line 43 of file G4UIcommandTree.cc.

{
  pathName = thePathName;
}

~G4UIcommandTree()

G4UIcommandTree::~G4UIcommandTree

(

)

Definition at line 49 of file G4UIcommandTree.cc.

{
  for (auto& i : tree) {
    delete i;
  }
}

Member Function Documentation

AddNewCommand()

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

Definition at line 69 of file G4UIcommandTree.cc.

{
  G4String commandPath = newCommand->GetCommandPath();
  G4String remainingPath = commandPath;
  remainingPath.erase(0, pathName.length());
  if (remainingPath.empty()) {
    if (guidance == nullptr) {
      guidance = newCommand;
      if (!(newCommand->ToBeBroadcasted())) {
        broadcastCommands = false;
      }
      if (workerThreadOnly) {
        newCommand->SetWorkerThreadOnly();
      }
    }
    return;
  }
 
  if (guidance != nullptr) {
    auto* dir = static_cast<G4UIdirectory*>(guidance);
    ifSort = dir->IfSort();
  }
  std::size_t i = remainingPath.find('/');
  if (i == std::string::npos) {
    // Adding a new command to this directory
    std::size_t n_commandEntry = command.size();
    for (std::size_t i_thCommand = 0; i_thCommand < n_commandEntry; ++i_thCommand) {
      if (remainingPath == command[i_thCommand]->GetCommandName()) {
        // a command of same name has already defined. do nothing and return.
        if (G4UImanager::GetUIpointer()->GetVerboseLevel() > 8) {
          G4ExceptionDescription ed;
          ed << "Command <" << commandPath << "> already exist. New command is not added.";
          G4Exception("G4UIcommandTree::AddNewCommand", "UI_ComTree_001",
                      // FatalException,
                      JustWarning, ed);
        }
        return;
      }
    }
    if (!broadcastCommands) {
      newCommand->SetToBeBroadcasted(false);
    }
    if (workerThreadOnly) {
      newCommand->SetWorkerThreadOnly();
    }
    if (ifSort) {
      auto j = command.cbegin();
      for (; j != command.cend(); ++j) {
        if (newCommand->GetCommandPath() < (*j)->GetCommandPath()) {
          break;
        }
      }
      command.insert(j, newCommand);
    }
    else {
      command.push_back(newCommand);
    }
    return;
  }
 
  // Adding a new command to a sub-directory
  G4String nextPath = pathName;
  nextPath.append(remainingPath.substr(0, i + 1));
  std::size_t n_treeEntry = tree.size();
  for (std::size_t i_thTree = 0; i_thTree < n_treeEntry; ++i_thTree) {
    if (nextPath == tree[i_thTree]->GetPathName()) {
      if (!broadcastCommands) {
        newCommand->SetToBeBroadcasted(false);
      }
      tree[i_thTree]->AddNewCommand(newCommand, workerThreadOnly);
      return;
    }
  }
  // Creating a new sub-directory
  auto* newTree = new G4UIcommandTree(nextPath);
  if (ifSort) {
    auto j = tree.cbegin();
    for (; j != tree.cend(); ++j) {
      if (newTree->GetPathName() < (*j)->GetPathName()) {
        break;
      }
    }
    tree.insert(j, newTree);
  }
  else {
    tree.push_back(newTree);
  }
  if (!broadcastCommands) {
    newCommand->SetToBeBroadcasted(false);
  }
  // In case a new sub-directry is created with a new G4UIdirectory
  // (most-likely this is the case), inherit the sort flag
  newCommand->SetDefaultSortFlag(ifSort);
  newTree->AddNewCommand(newCommand, workerThreadOnly);
  return;
}

CompleteCommandPath()

G4String G4UIcommandTree::CompleteCommandPath

(

const G4String &

commandPath

)

Definition at line 279 of file G4UIcommandTree.cc.

{
  G4String pName = aCommandPath;
  G4String remainingPath = aCommandPath;
  G4String empty = "";
  G4String matchingPath = empty;
 
  // find the tree
  auto jpre = pName.rfind('/');
  if (jpre != G4String::npos) {
    pName.erase(jpre + 1);
  }
  G4UIcommandTree* aTree = FindCommandTree(pName);
 
  if (aTree == nullptr) {
    return empty;
  }
 
  if (pName.find(pName) == std::string::npos) {
    return empty;
  }
 
  std::vector<G4String> paths;
 
  // list matched directories/commands
  G4String strtmp;
  G4int nMatch = 0;
 
  G4int Ndir = aTree->GetTreeEntry();
  G4int Ncmd = aTree->GetCommandEntry();
 
  // directory ...
  for (G4int idir = 1; idir <= Ndir; ++idir) {
    const G4String& fpdir = aTree->GetTree(idir)->GetPathName();
    // matching test
    if (fpdir.find(remainingPath, 0) == 0) {
      if (nMatch == 0) {
        matchingPath = fpdir;
      }
      else {
        matchingPath = GetFirstMatchedString(fpdir, matchingPath);
      }
      ++nMatch;
      paths.push_back(fpdir);
    }
  }
 
  if (paths.size() >= 2) {
    G4cout << "Matching directories :" << G4endl;
    for (const auto& path : paths) {
      G4cout << path << G4endl;
    }
  }
 
  // command ...
  std::vector<G4String> commands;
 
  for (G4int icmd = 1; icmd <= Ncmd; ++icmd) {
    G4String fpcmd = aTree->GetPathName() + aTree->GetCommand(icmd)->GetCommandName();
    // matching test
    if (fpcmd.find(remainingPath, 0) == 0) {
      if (nMatch == 0) {
        matchingPath = fpcmd + " ";
      }
      else {
        strtmp = fpcmd + " ";
        matchingPath = GetFirstMatchedString(matchingPath, strtmp);
      }
      nMatch++;
      commands.emplace_back(fpcmd + " ");
    }
  }
 
  if (commands.size() >= 2) {
    G4cout << "Matching commands :" << G4endl;
    for (const auto& matched : commands) {
      G4cout << matched << G4endl;
    }
  }
 
  return matchingPath;
}

Referenced by G4VBasicShell::FindMatchingPath().

CreateHTML()

void G4UIcommandTree::CreateHTML

(

const G4String &

sideBar = ""

)

Definition at line 493 of file G4UIcommandTree.cc.

{
  G4String ofileName = CreateFileName(pathName);
  std::ofstream oF(ofileName, std::ios::out);
 
  oF << "<html><head><title>Commands in " << ModStr(pathName) << "</title></head>" << G4endl;
  oF << "<style> \
    table,table td,table th { \
       border:1px solid #eee \
    } \
    table td,table th { \
      padding:5px 20px; \
      line-height:1.3; \
      text-align:inherit \
    } \
    a { \
      color:#17a81a; \
      text-decoration:none; \
      transition-duration:0.3s \
    } \
      a:hover { \
      color:#17a81a \
    } \
    table { \
      border-collapse:collapse; \
      border-spacing:0; \
      margin-bottom:5px; \
    } \
    h1 { \
      font-size:2.25em; \
      font-weight:300; \
      letter-spacing:-1px; \
      line-height:1.15em; \
      margin-bottom:0.5em; \
      word-wrap:break-word \
    } \
    h2 { \
      font-size:1.5em; \
      font-weight:300; \
      letter-spacing:-1px; \
      line-height:1.15em; \
      margin-bottom:0.5em; \
      word-wrap:break-word \
    } \
    h3 { \
      color:#26282a; \
      font-weight:300; \
      font-size:1.3em; \
      padding:15px 0 15px 0; \
      border-bottom:2px #eee solid; \
      word-wrap:break-word \
    } \
    .sidebar { \
      display:block; \
      position:relative; \
      position:sticky; \
      float:left; \
      -webkit-box-sizing:border-box; \
      -moz-box-sizing:border-box; \
      -ms-box-sizing:border-box; \
      box-sizing:border-box; \
      width:20%; \
      padding-right:20px \
    } \
    .context { \
    width:80%; \
    display:inline-block; \
    background-color:#fff; \
    padding: 25px 35px 20px 30px; \
    -webkit-box-sizing:border-box; \
    -moz-box-sizing:border-box; \
    -ms-box-sizing:border-box; \
    box-sizing:border-box \
  } \
    </style>"
     << G4endl;
  oF << "<body bgcolor=\"#ffffff\">" << G4endl;
 
  // Left Panel
  if (createHTMLTreeLevel == 0) {
    oF << "<div class=\"sidebar\">" << sideBar << "</div>" << G4endl;
  }
  // Right Panel
  oF << "<div class=\"context\">";
  oF << "<h1>" << ModStr(pathName) << "</h1>" << G4endl;
 
  if (guidance != nullptr) {
    for (G4int i = 0; i < (G4int)guidance->GetGuidanceEntries(); ++i) {
      oF << ModStr(guidance->GetGuidanceLine(i)) << "<br>" << G4endl;
    }
  }
  if (!tree.empty()) {
    G4String menu = "";
    G4String newSideBar = "";
    menu += "<h2>Sub-directories </h2><table>";
    newSideBar += "<h2><a href=\"" + ofileName + "\">Top level </a></h2><table>";
    // Build menu short version
    for (auto& i_thTree : tree) {
      newSideBar += "<tr><td><a href=\"" + CreateFileName(i_thTree->GetPathName()) + "\">"
                    + ModStr(i_thTree->GetPathName()) + "</a>";
    }
    // Build menu
    for (auto& i_thTree : tree) {
      menu += "<tr><td><a href=\"" + CreateFileName(i_thTree->GetPathName()) + "\">"
              + ModStr(i_thTree->GetPathName()) + "</a>";
      menu += "</td><td>" + ModStr(i_thTree->GetTitle()) + "</tr>";
    }
    menu += "</table>";
    newSideBar += "</table>";
    for (auto& i_thTree : tree) {
      createHTMLTreeLevel++;
      i_thTree->CreateHTML(newSideBar);
      createHTMLTreeLevel--;
    }
    oF << menu << G4endl;
  }
 
  if (!command.empty()) {
    oF << "<h2>Commands </h2>" << G4endl;
 
    // resume
    oF << "<table>" << G4endl;
    for (std::size_t i_thCommand = 0; i_thCommand < command.size(); ++i_thCommand) {
      G4UIcommand* cmd = command[i_thCommand];
      oF << "<tr><td><a href=\"#c" << i_thCommand << "\">" << ModStr(cmd->GetCommandName());
      oF << "</a></td></tr>" << G4endl;
    }
    oF << "</table>" << G4endl;
    for (std::size_t i_thCommand = 0; i_thCommand < command.size(); ++i_thCommand) {
      G4UIcommand* cmd = command[i_thCommand];
      oF << "<h3 id=\"c" << i_thCommand << "\">" << ModStr(cmd->GetCommandName());
      if (cmd->GetParameterEntries() > 0) {
        for (G4int i_thParam = 0; i_thParam < (G4int)cmd->GetParameterEntries(); ++i_thParam) {
          oF << " [<i>" << ModStr(cmd->GetParameter(i_thParam)->GetParameterName()) << "</i>]";
        }
      }
      oF << "</h3>" << G4endl;
      oF << "<p>" << G4endl;
      for (G4int i = 0; i < (G4int)cmd->GetGuidanceEntries(); ++i) {
        oF << ModStr(cmd->GetGuidanceLine(i)) << "<br>" << G4endl;
      }
      if (!(cmd->GetRange()).empty()) {
        oF << "<p>Range : " << ModStr(cmd->GetRange()) << G4endl;
      }
      std::vector<G4ApplicationState>* availabelStateList = cmd->GetStateList();
      if (availabelStateList->size() == 6) {
        oF << "<p>Available at all Geant4 states." << G4endl;
      }
      else {
        oF << "<p>Available Geant4 state(s) : ";
        for (auto& ias : *availabelStateList) {
          oF << G4StateManager::GetStateManager()->GetStateString(ias) << " " << G4endl;
        }
      }
      if (cmd->GetParameterEntries() > 0) {
        oF << "<p>Parameters<table border=1>" << G4endl;
        for (G4int i_thParam = 0; i_thParam < (G4int)cmd->GetParameterEntries(); ++i_thParam) {
          G4UIparameter* prm = cmd->GetParameter(i_thParam);
          oF << "<tr><td>" << ModStr(prm->GetParameterName()) << G4endl;
          oF << "<td>type " << prm->GetParameterType() << G4endl;
          oF << "<td>";
          if (prm->IsOmittable()) {
            oF << "Omittable : ";
            if (prm->GetCurrentAsDefault()) {
              oF << "current value is used as the default value." << G4endl;
            }
            else {
              oF << "default value = " << prm->GetDefaultValue() << G4endl;
            }
          }
          oF << "<td>";
          if (!(prm->GetParameterRange()).empty()) {
            oF << "Parameter range : " << ModStr(prm->GetParameterRange()) << G4endl;
          }
          else if (!(prm->GetParameterCandidates()).empty()) {
            oF << "Parameter candidates : " << ModStr(prm->GetParameterCandidates()) << G4endl;
          }
        }
        oF << "</table>" << G4endl;
      }
    }
  }
  oF << "</div></body></html>" << G4endl;
  oF.close();
}

Referenced by G4UImanager::CreateHTML().

FindCommandTree()

G4UIcommandTree * G4UIcommandTree::FindCommandTree

(

const char *

commandPath

)

Definition at line 246 of file G4UIcommandTree.cc.

{
  // Try to match a command or a path with the one given.
  // @commandPath : command or path to match
  // @return the commandTree found or nullptr if not
 
  G4String remainingPath = commandPath;
  if (remainingPath.find(pathName) == std::string::npos) {
    return nullptr;
  }
  remainingPath.erase(0, pathName.length());
  std::size_t i = remainingPath.find('/');
  if (i != std::string::npos) {
    // Find path
    G4String nextPath = pathName;
    nextPath.append(remainingPath.substr(0, i + 1));
    std::size_t n_treeEntry = tree.size();
    for (std::size_t i_thTree = 0; i_thTree < n_treeEntry; ++i_thTree) {
      if (tree[i_thTree]->GetPathName() == commandPath) {
        return tree[i_thTree];
      }
      if (nextPath == tree[i_thTree]->GetPathName()) {
        return tree[i_thTree]->FindCommandTree(commandPath);
      }
    }
  }
  else {
    return this;
  }
  return nullptr;
}

Referenced by CompleteCommandPath(), G4UImessenger::CreateDirectory(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

FindPath()

G4UIcommand * G4UIcommandTree::FindPath

(

const char *

commandPath

)

const

Definition at line 212 of file G4UIcommandTree.cc.

{
  // This function tries to match a command name
 
  G4String remainingPath = commandPath;
  if (remainingPath.find(pathName) == std::string::npos) {
    return nullptr;
  }
  remainingPath.erase(0, pathName.length());
  std::size_t i = remainingPath.find('/');
  if (i == std::string::npos) {
    // Find command
    std::size_t n_commandEntry = command.size();
    for (std::size_t i_thCommand = 0; i_thCommand < n_commandEntry; ++i_thCommand) {
      if (remainingPath == command[i_thCommand]->GetCommandName()) {
        return command[i_thCommand];
      }
    }
  }
  else {
    // Find path
    G4String nextPath = pathName;
    nextPath.append(remainingPath.substr(0, i + 1));
    std::size_t n_treeEntry = tree.size();
    for (std::size_t i_thTree = 0; i_thTree < n_treeEntry; ++i_thTree) {
      if (nextPath == tree[i_thTree]->GetPathName()) {
        return tree[i_thTree]->FindPath(commandPath);
      }
    }
  }
  return nullptr;
}

Referenced by G4UIQt::AddButton(), G4UIQt::AddIcon(), G4VBasicShell::FindCommand(), G4VisCommandDrawLogicalVolume::G4VisCommandDrawLogicalVolume(), G4VisCommandDrawVolume::G4VisCommandDrawVolume(), G4VisCommandOpen::G4VisCommandOpen(), G4VisCommandSceneAddMagneticField::G4VisCommandSceneAddMagneticField(), and G4VBasicShell::TerminalHelp().

GetCommand()

G4UIcommand * G4UIcommandTree::GetCommand ( G4int i )

inline

Definition at line 76 of file G4UIcommandTree.hh.

{ return command[i - 1]; }

Referenced by G4UItcsh::CompleteCommand(), CompleteCommandPath(), G4VUIshell::ListCommand(), G4VBasicShell::TerminalHelp(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

GetCommandEntry()

G4int G4UIcommandTree::GetCommandEntry ( ) const

inline

Definition at line 73 of file G4UIcommandTree.hh.

{ return G4int(command.size()); }

Referenced by G4UItcsh::CompleteCommand(), CompleteCommandPath(), G4VUIshell::ListCommand(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

GetFirstMatchedString()

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

Definition at line 363 of file G4UIcommandTree.cc.

{
  std::size_t nlen1 = str1.length();
  std::size_t nlen2 = str2.length();
 
  std::size_t nmin = nlen1 < nlen2 ? nlen1 : nlen2;
 
  G4String strMatched;
  for (G4int i = 0; i < (G4int)nmin; ++i) {
    if (str1[i] == str2[i]) {
      strMatched += str1[i];
    }
    else {
      break;
    }
  }
 
  return strMatched;
}

Referenced by CompleteCommandPath().

GetGuidance()

const G4UIcommand * G4UIcommandTree::GetGuidance ( ) const

inline

Definition at line 70 of file G4UIcommandTree.hh.

{ return guidance; }

Referenced by ListCurrent().

GetPathName()

const G4String & G4UIcommandTree::GetPathName ( ) const

inline

Definition at line 71 of file G4UIcommandTree.hh.

{ return pathName; }

Referenced by AddNewCommand(), G4UItcsh::CompleteCommand(), CompleteCommandPath(), G4UImessenger::CreateDirectory(), FindCommandTree(), FindPath(), G4VUIshell::ListCommand(), operator!=(), operator==(), and RemoveCommand().

GetTitle()

const G4String G4UIcommandTree::GetTitle ( ) const

inline

Definition at line 77 of file G4UIcommandTree.hh.

    {
      return (guidance == nullptr) ? G4String("...Title not available...") : guidance->GetTitle();
    }

GetTree() [1/2]

G4UIcommandTree * G4UIcommandTree::GetTree

(

const char *

comNameC

)

Definition at line 680 of file G4UIcommandTree.cc.

{
  G4String comName = comNameC;
  for (auto& i : tree) {
    if (comName == i->GetPathName()) {
      return i;
    }
  }
  return nullptr;
}

GetTree() [2/2]

G4UIcommandTree * G4UIcommandTree::GetTree ( G4int i )

inline

Definition at line 74 of file G4UIcommandTree.hh.

{ return tree[i - 1]; }

Referenced by G4UItcsh::CompleteCommand(), CompleteCommandPath(), G4VBasicShell::FindDirectory(), G4VUIshell::GetCommandTree(), G4VUIshell::ListCommand(), and G4VBasicShell::TerminalHelp().

GetTreeEntry()

G4int G4UIcommandTree::GetTreeEntry ( ) const

inline

Definition at line 72 of file G4UIcommandTree.hh.

{ return G4int(tree.size()); }

Referenced by G4UItcsh::CompleteCommand(), CompleteCommandPath(), G4VUIshell::ListCommand(), and G4VBasicShell::TerminalHelp().

List()

void G4UIcommandTree::List

(

)

const

Definition at line 443 of file G4UIcommandTree.cc.

{
  ListCurrent();
  std::size_t n_commandEntry = command.size();
  for (std::size_t i_thCommand = 0; i_thCommand < n_commandEntry; ++i_thCommand) {
    command[i_thCommand]->List();
  }
  std::size_t n_treeEntry = tree.size();
  for (std::size_t i_thTree = 0; i_thTree < n_treeEntry; ++i_thTree) {
    tree[i_thTree]->List();
  }
}

Referenced by G4UImanager::ListCommands().

ListCurrent()

void G4UIcommandTree::ListCurrent

(

)

const

Definition at line 384 of file G4UIcommandTree.cc.

{
  G4cout << "Command directory path : " << pathName << G4endl;
  if (guidance != nullptr) {
    guidance->List();
  }
  G4cout << " Sub-directories : " << G4endl;
  std::size_t n_treeEntry = tree.size();
  for (std::size_t i_thTree = 0; i_thTree < n_treeEntry; ++i_thTree) {
    G4cout << "   " << tree[i_thTree]->GetPathName();
    if ((tree[i_thTree]->GetGuidance() != nullptr)
        && tree[i_thTree]->GetGuidance()->IsWorkerThreadOnly())
    {
      G4cout << " @ ";
    }
    else {
      G4cout << "   ";
    }
    G4cout << tree[i_thTree]->GetTitle() << G4endl;
  }
  G4cout << " Commands : " << G4endl;
  std::size_t n_commandEntry = command.size();
  for (std::size_t i_thCommand = 0; i_thCommand < n_commandEntry; ++i_thCommand) {
    G4cout << "   " << command[i_thCommand]->GetCommandName();
    if (command[i_thCommand]->IsWorkerThreadOnly()) {
      G4cout << " @ ";
    }
    else {
      G4cout << " * ";
    }
    G4cout << command[i_thCommand]->GetTitle() << G4endl;
  }
}

Referenced by List(), and G4VBasicShell::ListDirectory().

ListCurrentWithNum()

void G4UIcommandTree::ListCurrentWithNum

(

)

const

Definition at line 419 of file G4UIcommandTree.cc.

{
  G4cout << "Command directory path : " << pathName << G4endl;
  if (guidance != nullptr) {
    guidance->List();
  }
  G4int i = 0;
  G4cout << " Sub-directories : " << G4endl;
  std::size_t n_treeEntry = tree.size();
  for (std::size_t i_thTree = 0; i_thTree < n_treeEntry; ++i_thTree) {
    ++i;
    G4cout << " " << i << ") " << tree[i_thTree]->GetPathName() << "   "
           << tree[i_thTree]->GetTitle() << G4endl;
  }
  G4cout << " Commands : " << G4endl;
  std::size_t n_commandEntry = command.size();
  for (std::size_t i_thCommand = 0; i_thCommand < n_commandEntry; ++i_thCommand) {
    ++i;
    G4cout << " " << i << ") " << command[i_thCommand]->GetCommandName() << " * "
           << command[i_thCommand]->GetTitle() << G4endl;
  }
}

Referenced by G4VBasicShell::TerminalHelp().

operator!=()

G4bool G4UIcommandTree::operator!=

(

const G4UIcommandTree &

right

)

const

Definition at line 63 of file G4UIcommandTree.cc.

{
  return (pathName != right.GetPathName());
}

operator==()

G4bool G4UIcommandTree::operator==

(

const G4UIcommandTree &

right

)

const

Definition at line 57 of file G4UIcommandTree.cc.

{
  return (pathName == right.GetPathName());
}

RemoveCommand()

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

Definition at line 167 of file G4UIcommandTree.cc.

{
  if (workerThreadOnly && !(aCommand->IsWorkerThreadOnly())) {
    return;
  }
  G4String commandPath = aCommand->GetCommandPath();
  commandPath.erase(0, pathName.length());
  if (commandPath.empty()) {
    guidance = nullptr;
  }
  else {
    std::size_t i = commandPath.find('/');
    if (i == std::string::npos) {
      // Find command
      std::size_t n_commandEntry = command.size();
      for (std::size_t i_thCommand = 0; i_thCommand < n_commandEntry; ++i_thCommand) {
        if (commandPath == command[i_thCommand]->GetCommandName()) {
          command.erase(command.begin() + i_thCommand);
          break;
        }
      }
    }
    else {
      // Find path
      G4String nextPath = pathName;
      nextPath.append(commandPath.substr(0, i + 1));
      std::size_t n_treeEntry = tree.size();
      for (std::size_t i_thTree = 0; i_thTree < n_treeEntry; ++i_thTree) {
        if (nextPath == tree[i_thTree]->GetPathName()) {
          tree[i_thTree]->RemoveCommand(aCommand);
          G4int n_commandRemain = tree[i_thTree]->GetCommandEntry();
          G4int n_treeRemain = tree[i_thTree]->GetTreeEntry();
          if (n_commandRemain == 0 && n_treeRemain == 0) {
            G4UIcommandTree* emptyTree = tree[i_thTree];
            tree.erase(tree.begin() + i_thTree);
            delete emptyTree;
          }
          break;
        }
      }
    }
  }
}

---

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

• G4UIcommandTree.hh
• G4UIcommandTree.cc