G4UIcommand Class Reference

#include <G4UIcommand.hh>

Inheritance diagram for G4UIcommand:

Public Types
enum	CommandType {   BaseClassCmd , WithoutParameterCmd , WithABoolCmd , WithAnIntegerCmd ,   WithALongIntCmd , WithADoubleCmd , WithADoubleAndUnitCmd , With3VectorCmd ,   With3VectorAndUnitCmd , WithAStringCmd , CmdDirectory = -1 }

Public Member Functions
	G4UIcommand ()=default
	G4UIcommand (const char *theCommandPath, G4UImessenger *theMessenger, G4bool tBB=true)
virtual	~G4UIcommand ()
G4bool	operator== (const G4UIcommand &right) const
G4bool	operator!= (const G4UIcommand &right) const
virtual G4int	DoIt (const G4String &parameterList)
G4String	GetCurrentValue ()
void	AvailableForStates (G4ApplicationState s1)
void	AvailableForStates (G4ApplicationState s1, G4ApplicationState s2)
void	AvailableForStates (G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3)
void	AvailableForStates (G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3, G4ApplicationState s4)
void	AvailableForStates (G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3, G4ApplicationState s4, G4ApplicationState s5)
G4bool	IsAvailable ()
virtual void	List ()
void	SetRange (const char *rs)
const G4String &	GetRange () const
std::size_t	GetGuidanceEntries () const
const G4String &	GetGuidanceLine (G4int i) const
const G4String &	GetCommandPath () const
const G4String &	GetCommandName () const
std::size_t	GetParameterEntries () const
G4UIparameter *	GetParameter (G4int i) const
std::vector< G4ApplicationState > *	GetStateList ()
G4UImessenger *	GetMessenger () const
void	SetParameter (G4UIparameter *const newParameter)
void	SetGuidance (const char *aGuidance)
const G4String	GetTitle () const
void	SetToBeBroadcasted (G4bool val)
G4bool	ToBeBroadcasted () const
void	SetToBeFlushed (G4bool val)
G4bool	ToBeFlushed () const
void	SetWorkerThreadOnly (G4bool val=true)
G4bool	IsWorkerThreadOnly () const
void	CommandFailed (G4int errCode, G4ExceptionDescription &ed)
void	CommandFailed (G4ExceptionDescription &ed)
G4int	IfCommandFailed ()
const G4String &	GetFailureDescription ()
void	ResetFailure ()
CommandType	GetCommandType () const
void	SetCommandType (CommandType)
void	SetDefaultSortFlag (G4bool val)

Static Public Member Functions
static G4String	ConvertToString (G4bool boolVal)
static G4String	ConvertToString (G4int intValue)
static G4String	ConvertToString (G4long longValue)
static G4String	ConvertToString (G4double doubleValue)
static G4String	ConvertToString (G4double doubleValue, const char *unitName)
static G4String	ConvertToString (const G4ThreeVector &vec)
static G4String	ConvertToString (const G4ThreeVector &vec, const char *unitName)
static G4bool	ConvertToBool (const char *st)
static G4int	ConvertToInt (const char *st)
static G4long	ConvertToLongInt (const char *st)
static G4double	ConvertToDouble (const char *st)
static G4double	ConvertToDimensionedDouble (const char *st)
static G4ThreeVector	ConvertTo3Vector (const char *st)
static G4ThreeVector	ConvertToDimensioned3Vector (const char *st)
static G4double	ValueOf (const char *unitName)
static G4String	CategoryOf (const char *unitName)
static G4String	UnitsList (const char *unitCategory)

Protected Member Functions
G4int	CheckNewValue (const char *newValue)

Protected Attributes
G4bool	toBeBroadcasted = false
G4bool	toBeFlushed = false
G4bool	workerThreadOnly = false
G4int	commandFailureCode = 0
G4String	failureDescription = ""
G4bool	ifSort = false

Detailed Description

Definition at line 50 of file G4UIcommand.hh.

Member Enumeration Documentation

CommandType

enum G4UIcommand::CommandType

Enumerator
BaseClassCmd
WithoutParameterCmd
WithABoolCmd
WithAnIntegerCmd
WithALongIntCmd
WithADoubleCmd
WithADoubleAndUnitCmd
With3VectorCmd
With3VectorAndUnitCmd
WithAStringCmd
CmdDirectory

Definition at line 178 of file G4UIcommand.hh.

    {
      BaseClassCmd,
      WithoutParameterCmd,
      WithABoolCmd,
      WithAnIntegerCmd,
      WithALongIntCmd,
      WithADoubleCmd,
      WithADoubleAndUnitCmd,
      With3VectorCmd,
      With3VectorAndUnitCmd,
      WithAStringCmd,
      CmdDirectory = -1
    };

Constructor & Destructor Documentation

G4UIcommand() [1/2]

G4UIcommand::G4UIcommand ( )

default

Referenced by G4UIcmdWith3Vector::G4UIcmdWith3Vector(), G4UIcmdWith3VectorAndUnit::G4UIcmdWith3VectorAndUnit(), G4UIcmdWithABool::G4UIcmdWithABool(), G4UIcmdWithADouble::G4UIcmdWithADouble(), G4UIcmdWithADoubleAndUnit::G4UIcmdWithADoubleAndUnit(), G4UIcmdWithALongInt::G4UIcmdWithALongInt(), G4UIcmdWithAnInteger::G4UIcmdWithAnInteger(), G4UIcmdWithAString::G4UIcmdWithAString(), G4UIcmdWithNucleusLimits::G4UIcmdWithNucleusLimits(), G4UIcmdWithoutParameter::G4UIcmdWithoutParameter(), G4UIcommand(), G4UIdirectory::G4UIdirectory(), G4UIdirectory::G4UIdirectory(), operator!=(), and operator==().

G4UIcommand() [2/2]

G4UIcommand::G4UIcommand	(	const char *	theCommandPath,
		G4UImessenger *	theMessenger,
		G4bool	tBB = true )

Definition at line 44 of file G4UIcommand.cc.

  : toBeBroadcasted(tBB), messenger(theMessenger)
{
  G4String comStr = theCommandPath;
  G4UIcommandCommonConstructorCode(comStr);
  availabelStateList = {G4State_PreInit,    G4State_Init,      G4State_Idle,
                        G4State_GeomClosed, G4State_EventProc, G4State_Abort};
}

~G4UIcommand()

G4UIcommand::~G4UIcommand ( )

virtual

Definition at line 97 of file G4UIcommand.cc.

{
  G4UImanager* fUImanager = G4UImanager::GetUIpointer();
  if (fUImanager != nullptr) {
    fUImanager->RemoveCommand(this);
  }
 
  for (const auto& p : parameter) {
    delete p;
  }
}

Member Function Documentation

AvailableForStates() [1/5]

void G4UIcommand::AvailableForStates

(

G4ApplicationState

s1

)

Definition at line 234 of file G4UIcommand.cc.

{
  availabelStateList = {s1};
}

AvailableForStates() [2/5]

void G4UIcommand::AvailableForStates	(	G4ApplicationState	s1,
		G4ApplicationState	s2 )

Definition at line 240 of file G4UIcommand.cc.

{
  availabelStateList = {s1, s2};
}

AvailableForStates() [3/5]

void G4UIcommand::AvailableForStates	(	G4ApplicationState	s1,
		G4ApplicationState	s2,
		G4ApplicationState	s3 )

Definition at line 246 of file G4UIcommand.cc.

{
  availabelStateList = {s1, s2, s3};
}

AvailableForStates() [4/5]

void G4UIcommand::AvailableForStates	(	G4ApplicationState	s1,
		G4ApplicationState	s2,
		G4ApplicationState	s3,
		G4ApplicationState	s4 )

Definition at line 253 of file G4UIcommand.cc.

{
  availabelStateList = {s1, s2, s3, s4};
}

AvailableForStates() [5/5]

void G4UIcommand::AvailableForStates	(	G4ApplicationState	s1,
		G4ApplicationState	s2,
		G4ApplicationState	s3,
		G4ApplicationState	s4,
		G4ApplicationState	s5 )

Definition at line 260 of file G4UIcommand.cc.

{
  availabelStateList = {s1, s2, s3, s4, s5};
}

CategoryOf()

G4String G4UIcommand::CategoryOf ( const char * unitName )

static

Definition at line 288 of file G4UIcommand.cc.

{
  return G4UnitDefinition::GetCategory(unitName);
}

Referenced by G4UIcmdWith3VectorAndUnit::ConvertToStringWithBestUnit(), G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit(), G4UIcmdWith3VectorAndUnit::DoIt(), G4UIcmdWithADoubleAndUnit::DoIt(), G4UIcmdWith3VectorAndUnit::SetDefaultUnit(), G4UIcmdWithADoubleAndUnit::SetDefaultUnit(), and G4UIparameter::SetDefaultUnit().

CheckNewValue()

G4int G4UIcommand::CheckNewValue ( const char * newValue )

protected

Definition at line 476 of file G4UIcommand.cc.

{
  if (!G4UIparsing::RangeCheck(*this, newValue)) {
    return fParameterOutOfRange;
  }
  return 0;  // succeeded
}

Referenced by DoIt().

CommandFailed() [1/2]

void G4UIcommand::CommandFailed ( G4ExceptionDescription & ed )

inline

Definition at line 164 of file G4UIcommand.hh.

    {
      commandFailureCode = 1;
      failureDescription = ed.str();
    }

CommandFailed() [2/2]

void G4UIcommand::CommandFailed ( G4int errCode, G4ExceptionDescription & ed )

inline

Definition at line 159 of file G4UIcommand.hh.

    {
      commandFailureCode = errCode;
      failureDescription = ed.str();
    }

Referenced by G4ScoreQuantityMessenger::CheckMeshPS(), G4ScoringMessenger::Fill1D(), G4FTFTuningsMessenger::SetNewValue(), G4GeneralParticleSourceMessenger::SetNewValue(), G4ParticleGunMessenger::SetNewValue(), G4ProcessManagerMessenger::SetNewValue(), G4ProcessTableMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4UserPhysicsListMessenger::SetNewValue(), G4VisCommandOpen::SetNewValue(), G4VisCommandSceneHandlerCreate::SetNewValue(), and G4VisCommandViewerCreate::SetNewValue().

ConvertTo3Vector()

G4ThreeVector G4UIcommand::ConvertTo3Vector ( const char * st )

static

Definition at line 452 of file G4UIcommand.cc.

{
  G4double vx;
  G4double vy;
  G4double vz;
  std::istringstream is(st);
  is >> vx >> vy >> vz;
  return G4ThreeVector(vx, vy, vz);
}

Referenced by G4UIcmdWith3Vector::GetNew3VectorValue(), G4VisCommandsViewerSet::SetNewValue(), and G4AttCheck::Standard().

ConvertToBool()

G4bool G4UIcommand::ConvertToBool ( const char * st )

static

Definition at line 414 of file G4UIcommand.cc.

{
  G4String v = G4StrUtil::to_upper_copy(st);
  return (v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE");
}

Referenced by G4UIcmdWithABool::GetNewBoolValue(), G4HnMessenger::SetNewValue(), G4InteractorMessenger::SetNewValue(), G4NtupleMessenger::SetNewValue(), G4OpenGLViewerMessenger::SetNewValue(), G4OpticalParametersMessenger::SetNewValue(), G4ToolsSGOffscreenViewer::Messenger::SetNewValue(), G4ToolsSGViewer< SG_SESSION, SG_VIEWER >::Messenger::SetNewValue(), G4VisCommandAbortReviewKeptEvents::SetNewValue(), G4VisCommandAbortReviewPlots::SetNewValue(), G4VisCommandDrawOnlyToBeKeptEvents::SetNewValue(), G4VisCommandEnable::SetNewValue(), G4VisCommandGeometrySetDaughtersInvisible::SetNewValue(), G4VisCommandGeometrySetForceAuxEdgeVisible::SetNewValue(), G4VisCommandGeometrySetForceCloud::SetNewValue(), G4VisCommandGeometrySetForceSolid::SetNewValue(), G4VisCommandGeometrySetForceWireframe::SetNewValue(), G4VisCommandGeometrySetVisibility::SetNewValue(), G4VisCommandSceneActivateModel::SetNewValue(), G4VisCommandSceneAddAxes::SetNewValue(), G4VisCommandSceneAddLogicalVolume::SetNewValue(), G4VisCommandSetVolumeForField::SetNewValue(), G4VisCommandsTouchableSet::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), G4VisCommandViewerDefaultHiddenEdge::SetNewValue(), and G4VtkMessenger::SetNewValue().

ConvertToDimensioned3Vector()

G4ThreeVector G4UIcommand::ConvertToDimensioned3Vector ( const char * st )

static

Definition at line 463 of file G4UIcommand.cc.

{
  G4double vx;
  G4double vy;
  G4double vz;
  char unts[30];
  std::istringstream is(st);
  is >> vx >> vy >> vz >> unts;
  G4String unt = unts;
  G4double uv = ValueOf(unt);
  return G4ThreeVector(vx * uv, vy * uv, vz * uv);
}

Referenced by G4UIcmdWith3VectorAndUnit::GetNew3VectorValue(), G4GenericMessenger::SetNewValue(), and G4AttCheck::Standard().

ConvertToDimensionedDouble()

G4double G4UIcommand::ConvertToDimensionedDouble ( const char * st )

static

Definition at line 439 of file G4UIcommand.cc.

{
  G4double vl;
  char unts[30];
 
  std::istringstream is(st);
  is >> vl >> unts;
  G4String unt = unts;
 
  return (vl * ValueOf(unt));
}

Referenced by G4UIcmdWithADoubleAndUnit::GetNewDoubleValue(), G4TrajectoryDrawerUtils::GetPointsAndTimes(), G4GenericMessenger::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), G4VisCommandViewerInterpolate::SetNewValue(), and G4AttCheck::Standard().

ConvertToDouble()

G4double G4UIcommand::ConvertToDouble ( const char * st )

static

Definition at line 433 of file G4UIcommand.cc.

{
  return G4UIparsing::StoT<G4double>(st);
}

Referenced by G4UIcmdWith3VectorAndUnit::DoIt(), G4UIcmdWithADoubleAndUnit::DoIt(), G4UIcmdWithADouble::GetNewDoubleValue(), G4VisCommandsTouchableSet::SetNewValue(), and G4VisCommandsViewerSet::SetNewValue().

ConvertToInt()

G4int G4UIcommand::ConvertToInt ( const char * st )

static

Definition at line 421 of file G4UIcommand.cc.

{
  return G4UIparsing::StoT<G4int>(st);
}

Referenced by G4UIcmdWithAnInteger::GetNewIntValue(), G4DNAChemistryManager::SetNewValue(), G4HnMessenger::SetNewValue(), G4NtupleMessenger::SetNewValue(), G4PlotMessenger::SetNewValue(), G4VisCommandsTouchableSet::SetNewValue(), and G4VisCommandsViewerSet::SetNewValue().

ConvertToLongInt()

G4long G4UIcommand::ConvertToLongInt ( const char * st )

static

Definition at line 427 of file G4UIcommand.cc.

{
  return G4UIparsing::StoT<G4long>(st);
}

Referenced by G4UIcmdWithALongInt::GetNewLongIntValue().

ConvertToString() [1/7]

G4String G4UIcommand::ConvertToString ( const G4ThreeVector & vec )

static

Definition at line 390 of file G4UIcommand.cc.

{
  std::ostringstream os;
  if (G4UImanager::DoublePrecisionStr()) {
    os << std::setprecision(17);
  }
  os << vec.x() << " " << vec.y() << " " << vec.z();
  return os.str();
}

ConvertToString() [2/7]

G4String G4UIcommand::ConvertToString ( const G4ThreeVector & vec, const char * unitName )

static

Definition at line 401 of file G4UIcommand.cc.

{
  G4double uv = ValueOf(unitName);
 
  std::ostringstream os;
  if (G4UImanager::DoublePrecisionStr()) {
    os << std::setprecision(17);
  }
  os << vec.x() / uv << " " << vec.y() / uv << " " << vec.z() / uv << " " << unitName;
  return os.str();
}

ConvertToString() [3/7]

G4String G4UIcommand::ConvertToString ( G4bool boolVal )

static

Definition at line 350 of file G4UIcommand.cc.

{
  return boolVal ? "1" : "0";
}

Referenced by G4tgrParameterMgr::AddParameterNumber(), G4tgbRotationMatrix::BuildG4RotMatrix(), G4tgbPlaceParameterisation::CheckNExtraData(), G4tgbVolume::CheckNoSolidParams(), G4tgrUtils::CheckWLsize(), G4UIcmdWith3VectorAndUnit::ConvertToStringWithDefaultUnit(), G4UIcmdWithADoubleAndUnit::ConvertToStringWithDefaultUnit(), G4ClonedRichTrajectory::CreateAttValues(), G4ClonedSmoothTrajectory::CreateAttValues(), G4ClonedTrajectory::CreateAttValues(), G4RichTrajectory::CreateAttValues(), G4SmoothTrajectory::CreateAttValues(), G4Trajectory::CreateAttValues(), G4TheMTRayTracer::CreateBitMap(), G4TrajectoriesModel::CreateCurrentAttValues(), G4UIcmdWith3VectorAndUnit::DoIt(), G4UIcmdWithADoubleAndUnit::DoIt(), G4tgrFileIn::DumpException(), G4tgbGeometryDumper::DumpPVParameterised(), G4tgbGeometryDumper::DumpPVPlacement(), G4tgbGeometryDumper::DumpRotationMatrix(), G4tgbVolume::FindOrConstructG4Solid(), G4MolecularConfiguration::G4MolecularConfiguration(), G4MolecularConfiguration::G4MolecularConfiguration(), G4MolecularConfiguration::G4MolecularConfiguration(), G4tgrSolidMultiUnion::G4tgrSolidMultiUnion(), G4tgrMaterialSimple::GetComponent(), G4DNAChemistryManager::GetCurrentValue(), G4HepRepMessenger::GetCurrentValue(), G4PersistencyCenterMessenger::GetCurrentValue(), G4VITSteppingVerbose::GetCurrentValue(), G4tgrUtils::GetDouble(), G4tgrMaterialSimple::GetFraction(), G4ScoreLogColorMap::GetMapColor(), G4tgrUtils::GetRotationFromDirection(), G4tgrVolume::GetVolume(), G4EnergySplitter::GetVoxelID(), G4MolecularConfiguration::IonizeMolecule(), G4MolecularConfiguration::MoveOneElectron(), G4DNAMolecularReactionTable::PrintTable(), G4MolecularConfiguration::RemoveElectron(), G4GenericMessenger::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), G4AttCheck::Standard(), G4EmTableUtil::StoreMscTable(), and G4TheMTRayTracer::Trace().

ConvertToString() [4/7]

G4String G4UIcommand::ConvertToString ( G4double doubleValue )

static

Definition at line 368 of file G4UIcommand.cc.

{
  std::ostringstream os;
  if (G4UImanager::DoublePrecisionStr()) {
    os << std::setprecision(17);
  }
  os << doubleValue;
  return os.str();
}

ConvertToString() [5/7]

G4String G4UIcommand::ConvertToString ( G4double doubleValue, const char * unitName )

static

Definition at line 379 of file G4UIcommand.cc.

{
  std::ostringstream os;
  if (G4UImanager::DoublePrecisionStr()) {
    os << std::setprecision(17);
  }
  os << doubleValue / ValueOf(unitName) << " " << unitName;
  return os.str();
}

ConvertToString() [6/7]

G4String G4UIcommand::ConvertToString ( G4int intValue )

static

Definition at line 356 of file G4UIcommand.cc.

{
  return G4UIparsing::TtoS(intValue);
}

ConvertToString() [7/7]

G4String G4UIcommand::ConvertToString ( G4long longValue )

static

Definition at line 362 of file G4UIcommand.cc.

{
  return G4UIparsing::TtoS(longValue);
}

DoIt()

G4int G4UIcommand::DoIt ( const G4String & parameterList )

virtual

Reimplemented in G4UIcmdWith3VectorAndUnit, and G4UIcmdWithADoubleAndUnit.

Definition at line 122 of file G4UIcommand.cc.

{
  G4String correctParameters;
  std::size_t n_parameterEntry = parameter.size();
  if (n_parameterEntry != 0) {
    G4String aToken;
    G4String correctToken;
    G4Tokenizer parameterToken(parameterList);
    for (std::size_t i_thParameter = 0; i_thParameter < n_parameterEntry; ++i_thParameter) {
      if (i_thParameter > 0) {
        correctParameters.append(" ");
      }
      aToken = parameterToken();
      if (aToken.length() > 0 && aToken[0] == '"') {
        while (aToken.back() != '"' || (aToken.length() == 1 && aToken[0] == '"')) {
          G4String additionalToken = parameterToken();
          if (additionalToken.empty()) {
            return G4int(fParameterUnreadable + i_thParameter);
          }
          aToken += " ";
          aToken += additionalToken;
        }
      }
      else if (i_thParameter == n_parameterEntry - 1
               && parameter[i_thParameter]->GetParameterType() == 's')
      {
        G4String anotherToken;
        while (!((anotherToken = parameterToken()).empty())) {
          std::size_t idxs = anotherToken.find('#');
          if (idxs == std::string::npos) {
            aToken += " ";
            aToken += anotherToken;
          }
          else if (idxs > 0) {
            aToken += " ";
            aToken += anotherToken.substr(0, idxs);
            break;
          }
          else {
            break;
          }
        }
      }
 
      if (aToken.empty() || aToken == "!") {
        if (parameter[i_thParameter]->IsOmittable()) {
          if (parameter[i_thParameter]->GetCurrentAsDefault()) {
            G4Tokenizer cvSt(messenger->GetCurrentValue(this));
            G4String parVal;
            for (std::size_t ii = 0; ii < i_thParameter; ++ii) {
              parVal = cvSt();
              if (parVal[0] == '"') {
                while (parVal.back() != '"') {
                  G4String additionalToken = cvSt();
                  if (additionalToken.empty()) {
                    return G4int(fParameterUnreadable + i_thParameter);
                  }
                  parVal += " ";
                  parVal += additionalToken;
                }
              }
            }
            G4String aCVToken = cvSt();
            if (aCVToken[0] == '"') {
              while (aCVToken.back() != '"') {
                G4String additionalToken = cvSt();
                if (additionalToken.empty()) {
                  return G4int(fParameterUnreadable + i_thParameter);
                }
                aCVToken += " ";
                aCVToken += additionalToken;
              }
            }
            correctParameters.append(aCVToken);
          }
          else {
            correctParameters.append(parameter[i_thParameter]->GetDefaultValue());
          }
        }
        else {
          return G4int(fParameterUnreadable + i_thParameter);
        }
      }
      else {
        G4int stat = parameter[i_thParameter]->CheckNewValue(aToken);
        if (stat != 0) {
          return stat + G4int(i_thParameter);
        }
        correctParameters.append(aToken);
      }
    }
  }
 
  if (CheckNewValue(correctParameters) != 0) {
    return fParameterOutOfRange + 99;
  }
 
  if (workerThreadOnly && G4Threading::IsMasterThread()) {
    return 0;
  }
 
  messenger->SetNewValue(this, std::move(correctParameters));
  return 0;
}

Referenced by G4UImanager::ApplyCommand(), G4UIcmdWith3VectorAndUnit::DoIt(), and G4UIcmdWithADoubleAndUnit::DoIt().

GetCommandName()

const G4String & G4UIcommand::GetCommandName ( ) const

inline

Definition at line 126 of file G4UIcommand.hh.

{ return commandName; }

Referenced by G4UItcsh::CompleteCommand(), G4UIcommandTree::CompleteCommandPath(), G4UIcommandTree::CreateHTML(), G4GenericMessenger::GetCurrentValue(), G4VUIshell::ListCommand(), G4GenericMessenger::SetNewValue(), G4HnMessenger::SetNewValue(), G4NtupleMessenger::SetNewValue(), G4PlotMessenger::SetNewValue(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

GetCommandPath()

const G4String & G4UIcommand::GetCommandPath ( ) const

inline

Definition at line 125 of file G4UIcommand.hh.

{ return commandPath; }

Referenced by G4UIcommandTree::AddNewCommand(), G4UImessenger::AddUIcommand(), operator!=(), operator==(), G4UIcommandTree::RemoveCommand(), and G4ScoringMessenger::SetNewValue().

GetCommandType()

CommandType G4UIcommand::GetCommandType ( ) const

inline

Definition at line 193 of file G4UIcommand.hh.

{ return commandType; }

GetCurrentValue()

G4String G4UIcommand::GetCurrentValue

(

)

Definition at line 228 of file G4UIcommand.cc.

{
  return messenger->GetCurrentValue(this);
}

GetFailureDescription()

const G4String & G4UIcommand::GetFailureDescription ( )

inline

Definition at line 170 of file G4UIcommand.hh.

{ return failureDescription; }

Referenced by G4UImanager::ApplyCommand().

GetGuidanceEntries()

std::size_t G4UIcommand::GetGuidanceEntries ( ) const

inline

Definition at line 123 of file G4UIcommand.hh.

{ return commandGuidance.size(); }

Referenced by G4VVisCommand::CopyGuidanceFrom(), G4UIcommandTree::CreateHTML(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

GetGuidanceLine()

const G4String & G4UIcommand::GetGuidanceLine ( G4int i ) const

inline

Definition at line 124 of file G4UIcommand.hh.

{ return commandGuidance[i]; }

Referenced by G4VVisCommand::CopyGuidanceFrom(), G4UIcommandTree::CreateHTML(), G4OpenGLViewerMessenger::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

GetMessenger()

G4UImessenger * G4UIcommand::GetMessenger ( ) const

inline

Definition at line 130 of file G4UIcommand.hh.

{ return messenger; }

GetParameter()

G4UIparameter * G4UIcommand::GetParameter ( G4int i ) const

inline

Definition at line 128 of file G4UIcommand.hh.

{ return parameter[i]; }

Referenced by G4UIcmdWith3VectorAndUnit::ConvertToStringWithBestUnit(), G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit(), G4UIcmdWith3VectorAndUnit::ConvertToStringWithDefaultUnit(), G4UIcmdWithADoubleAndUnit::ConvertToStringWithDefaultUnit(), G4VVisCommand::CopyParametersFrom(), G4UIcommandTree::CreateHTML(), G4UIcmdWith3VectorAndUnit::DoIt(), G4UIcmdWithADoubleAndUnit::DoIt(), G4UIcmdWithAString::SetCandidates(), G4UIcmdWith3VectorAndUnit::SetDefaultUnit(), G4UIcmdWithADoubleAndUnit::SetDefaultUnit(), G4UIcmdWith3Vector::SetDefaultValue(), G4UIcmdWith3VectorAndUnit::SetDefaultValue(), G4UIcmdWithABool::SetDefaultValue(), G4UIcmdWithADouble::SetDefaultValue(), G4UIcmdWithADoubleAndUnit::SetDefaultValue(), G4UIcmdWithALongInt::SetDefaultValue(), G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcmdWithAString::SetDefaultValue(), G4UIcmdWithNucleusLimits::SetDefaultValue(), G4UIcmdWith3Vector::SetParameterName(), G4UIcmdWith3VectorAndUnit::SetParameterName(), G4UIcmdWithABool::SetParameterName(), G4UIcmdWithADouble::SetParameterName(), G4UIcmdWithADoubleAndUnit::SetParameterName(), G4UIcmdWithALongInt::SetParameterName(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcmdWithAString::SetParameterName(), G4UIcmdWithNucleusLimits::SetParameterName(), G4UIcmdWith3VectorAndUnit::SetUnitCandidates(), G4UIcmdWithADoubleAndUnit::SetUnitCandidates(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

GetParameterEntries()

std::size_t G4UIcommand::GetParameterEntries ( ) const

inline

Definition at line 127 of file G4UIcommand.hh.

{ return parameter.size(); }

Referenced by G4VVisCommand::CopyParametersFrom(), G4UIcommandTree::CreateHTML(), G4HnMessenger::SetNewValue(), G4InteractorMessenger::SetNewValue(), G4NtupleMessenger::SetNewValue(), G4PlotMessenger::SetNewValue(), G4ToolsSGOffscreenViewer::Messenger::SetNewValue(), G4ToolsSGViewer< SG_SESSION, SG_VIEWER >::Messenger::SetNewValue(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

GetRange()

const G4String & G4UIcommand::GetRange ( ) const

inline

Definition at line 122 of file G4UIcommand.hh.

{ return rangeExpression; }

Referenced by G4UIcommandTree::CreateHTML().

GetStateList()

std::vector< G4ApplicationState > * G4UIcommand::GetStateList ( )

inline

Definition at line 129 of file G4UIcommand.hh.

{ return &availabelStateList; }

Referenced by G4UIcommandTree::CreateHTML().

GetTitle()

const G4String G4UIcommand::GetTitle ( ) const

inline

Definition at line 147 of file G4UIcommand.hh.

    {
      return (commandGuidance.empty()) ? G4String("...Title not available...") : commandGuidance[0];
    }

IfCommandFailed()

G4int G4UIcommand::IfCommandFailed ( )

inline

Definition at line 169 of file G4UIcommand.hh.

{ return commandFailureCode; }

Referenced by G4UImanager::ApplyCommand().

IsAvailable()

G4bool G4UIcommand::IsAvailable

(

)

Definition at line 268 of file G4UIcommand.cc.

{
  G4ApplicationState currentState = G4StateManager::GetStateManager()->GetCurrentState();
 
  for (const auto& s : availabelStateList) {
    if (s == currentState) {
      return true;
    }
  }
 
  return false;
}

Referenced by G4UImanager::ApplyCommand().

IsWorkerThreadOnly()

G4bool G4UIcommand::IsWorkerThreadOnly ( ) const

inline

Definition at line 157 of file G4UIcommand.hh.

{ return workerThreadOnly; }

Referenced by G4UIcommandTree::RemoveCommand().

List()

void G4UIcommand::List ( )

virtual

Definition at line 323 of file G4UIcommand.cc.

{
  G4cout << G4endl;
  G4cout << G4endl;
  if (commandPath.back() != '/') {
    G4cout << "Command " << commandPath << G4endl;
  }
  if (workerThreadOnly) {
    G4cout << "    ---- available only in worker thread" << G4endl;
  }
 
  G4cout << "Guidance :" << G4endl;
  for (const auto& i_thGuidance : commandGuidance) {
    G4cout << i_thGuidance << G4endl;
  }
 
  if (!rangeExpression.empty()) {
    G4cout << " Range of parameters : " << rangeExpression << G4endl;
  }
 
  for (const auto& i_thParameter : parameter) {
    i_thParameter->List();
  }
  G4cout << G4endl;
}

Referenced by G4VBasicShell::TerminalHelp().

operator!=()

G4bool G4UIcommand::operator!=

(

const G4UIcommand &

right

)

const

Definition at line 116 of file G4UIcommand.cc.

{
  return (commandPath != right.GetCommandPath());
}

operator==()

G4bool G4UIcommand::operator==

(

const G4UIcommand &

right

)

const

Definition at line 110 of file G4UIcommand.cc.

{
  return (commandPath == right.GetCommandPath());
}

ResetFailure()

void G4UIcommand::ResetFailure ( )

inline

Definition at line 171 of file G4UIcommand.hh.

    {
      commandFailureCode = 0;
      failureDescription = "";
    }

Referenced by G4UImanager::ApplyCommand(), and G4UIcontrolMessenger::SetNewValue().

SetCommandType()

void G4UIcommand::SetCommandType

(

CommandType

typ

)

Definition at line 76 of file G4UIcommand.cc.

{
  if (messenger == nullptr) {  // this must be a directory
    if (typ != CmdDirectory) {
      G4ExceptionDescription ed;
      ed << "A UI command <" << commandPath << "> is defined without vaild messenger.";
      G4Exception("G4UIcommand::SetCommandType", "UI2031", FatalException, ed);
    }
    else if (commandPath.back() != '/') {
      G4ExceptionDescription ed;
      ed << "G4UIcommand Warning : \n"
         << "  <" << commandPath << "> must be a directory."
         << "  '/' is appended.";
      G4Exception("G4UIcommand::SetCommandType", "UI2032", JustWarning, ed);
      commandPath += "/";
    }
  }
  commandType = typ;
}

Referenced by G4UIcmdWith3Vector::G4UIcmdWith3Vector(), G4UIcmdWith3VectorAndUnit::G4UIcmdWith3VectorAndUnit(), G4UIcmdWithABool::G4UIcmdWithABool(), G4UIcmdWithADouble::G4UIcmdWithADouble(), G4UIcmdWithADoubleAndUnit::G4UIcmdWithADoubleAndUnit(), G4UIcmdWithALongInt::G4UIcmdWithALongInt(), G4UIcmdWithAnInteger::G4UIcmdWithAnInteger(), G4UIcmdWithAString::G4UIcmdWithAString(), G4UIcmdWithoutParameter::G4UIcmdWithoutParameter(), G4UIdirectory::G4UIdirectory(), and G4UIdirectory::G4UIdirectory().

SetDefaultSortFlag()

void G4UIcommand::SetDefaultSortFlag ( G4bool val )

inline

Definition at line 196 of file G4UIcommand.hh.

{ ifSort = val; }

Referenced by G4UIcommandTree::AddNewCommand().

SetGuidance()

void G4UIcommand::SetGuidance ( const char * aGuidance )

inline

Definition at line 145 of file G4UIcommand.hh.

{ commandGuidance.emplace_back(aGuidance); }

Referenced by G4VVisCommand::CopyGuidanceFrom(), G4GenericMessenger::DeclareMethodWithUnit(), G4GenericMessenger::DeclareProperty(), G4GenericMessenger::DeclarePropertyWithUnit(), G4FieldSetupMessenger::G4FieldSetupMessenger(), G4ModelCmdActive< M >::G4ModelCmdActive(), G4ModelCmdAddInt< M >::G4ModelCmdAddInt(), G4ModelCmdAddInterval< M >::G4ModelCmdAddInterval(), G4ModelCmdAddIntervalContext< M >::G4ModelCmdAddIntervalContext(), G4ModelCmdAddString< M >::G4ModelCmdAddString(), G4ModelCmdAddValue< M >::G4ModelCmdAddValue(), G4ModelCmdAddValueContext< M >::G4ModelCmdAddValueContext(), G4ModelCmdDraw< M >::G4ModelCmdDraw(), G4ModelCmdInvert< M >::G4ModelCmdInvert(), G4ModelCmdReset< M >::G4ModelCmdReset(), G4ModelCmdSetAuxPtsFillStyle< M >::G4ModelCmdSetAuxPtsFillStyle(), G4ModelCmdSetAuxPtsSize< M >::G4ModelCmdSetAuxPtsSize(), G4ModelCmdSetAuxPtsSizeType< M >::G4ModelCmdSetAuxPtsSizeType(), G4ModelCmdSetAuxPtsType< M >::G4ModelCmdSetAuxPtsType(), G4ModelCmdSetAuxPtsVisible< M >::G4ModelCmdSetAuxPtsVisible(), G4ModelCmdSetDrawAuxPts< M >::G4ModelCmdSetDrawAuxPts(), G4ModelCmdSetDrawLine< M >::G4ModelCmdSetDrawLine(), G4ModelCmdSetDrawStepPts< M >::G4ModelCmdSetDrawStepPts(), G4ModelCmdSetLineVisible< M >::G4ModelCmdSetLineVisible(), G4ModelCmdSetStepPtsFillStyle< M >::G4ModelCmdSetStepPtsFillStyle(), G4ModelCmdSetStepPtsSize< M >::G4ModelCmdSetStepPtsSize(), G4ModelCmdSetStepPtsSizeType< M >::G4ModelCmdSetStepPtsSizeType(), G4ModelCmdSetStepPtsType< M >::G4ModelCmdSetStepPtsType(), G4ModelCmdSetStepPtsVisible< M >::G4ModelCmdSetStepPtsVisible(), G4ModelCmdSetString< M >::G4ModelCmdSetString(), G4ModelCmdSetTimeSliceInterval< M >::G4ModelCmdSetTimeSliceInterval(), G4ModelCmdVerbose< M >::G4ModelCmdVerbose(), and G4VisCommandModelCreate< Factory >::SetNewValue().

SetParameter()

void G4UIcommand::SetParameter ( G4UIparameter *const newParameter )

inline

Definition at line 136 of file G4UIcommand.hh.

    {
      parameter.push_back(newParameter);
    }

Referenced by G4VVisCommand::CopyParametersFrom(), G4GenericMessenger::DeclareProperty(), G4UIcmdWith3Vector::G4UIcmdWith3Vector(), G4UIcmdWith3VectorAndUnit::G4UIcmdWith3VectorAndUnit(), G4UIcmdWithABool::G4UIcmdWithABool(), G4UIcmdWithADouble::G4UIcmdWithADouble(), G4UIcmdWithADoubleAndUnit::G4UIcmdWithADoubleAndUnit(), G4UIcmdWithALongInt::G4UIcmdWithALongInt(), G4UIcmdWithAnInteger::G4UIcmdWithAnInteger(), G4UIcmdWithAString::G4UIcmdWithAString(), and G4UIcmdWithNucleusLimits::G4UIcmdWithNucleusLimits().

SetRange()

void G4UIcommand::SetRange ( const char * rs )

inline

Definition at line 120 of file G4UIcommand.hh.

{ rangeExpression = rs; }

SetToBeBroadcasted()

void G4UIcommand::SetToBeBroadcasted ( G4bool val )

inline

Definition at line 152 of file G4UIcommand.hh.

{ toBeBroadcasted = val; }

Referenced by G4UIcommandTree::AddNewCommand().

SetToBeFlushed()

void G4UIcommand::SetToBeFlushed ( G4bool val )

inline

Definition at line 154 of file G4UIcommand.hh.

{ toBeFlushed = val; }

SetWorkerThreadOnly()

void G4UIcommand::SetWorkerThreadOnly ( G4bool val = true )

inline

Definition at line 156 of file G4UIcommand.hh.

{ workerThreadOnly = val; }

Referenced by G4UIcommandTree::AddNewCommand().

ToBeBroadcasted()

G4bool G4UIcommand::ToBeBroadcasted ( ) const

inline

Definition at line 153 of file G4UIcommand.hh.

{ return toBeBroadcasted; }

Referenced by G4UIcommandTree::AddNewCommand(), and G4UImanager::ApplyCommand().

ToBeFlushed()

G4bool G4UIcommand::ToBeFlushed ( ) const

inline

Definition at line 155 of file G4UIcommand.hh.

{ return toBeFlushed; }

UnitsList()

G4String G4UIcommand::UnitsList ( const char * unitCategory )

static

Definition at line 294 of file G4UIcommand.cc.

{
  G4UnitsTable& UTbl = G4UnitDefinition::GetUnitsTable();
 
  auto ucatIter = std::find_if(std::cbegin(UTbl), std::cend(UTbl), [&unitCategory](const auto& ud) {
    return ud->GetName() == unitCategory;
  });
 
  if (ucatIter == std::cend(UTbl)) {
    G4cerr << "Unit category <" << unitCategory << "> is not defined." << G4endl;
    return G4String();
  }
 
  G4String symList;
  G4String nameList;
  G4UnitsContainer& UCnt = (*ucatIter)->GetUnitsList();
 
  for (const auto& uDef : UCnt) {
    symList += uDef->GetSymbol();
    symList += " ";
    nameList += uDef->GetName();
    nameList += " ";
  }
  symList += nameList;
  G4StrUtil::rstrip(symList);
  return symList;
}

Referenced by G4UIparameter::SetDefaultUnit(), G4UIcmdWith3VectorAndUnit::SetUnitCategory(), and G4UIcmdWithADoubleAndUnit::SetUnitCategory().

ValueOf()

G4double G4UIcommand::ValueOf ( const char * unitName )

static

Definition at line 282 of file G4UIcommand.cc.

{
  return G4UnitDefinition::GetValueOf(unitName);
}

Referenced by ConvertToDimensioned3Vector(), ConvertToDimensionedDouble(), G4VVisCommand::ConvertToDoublePair(), ConvertToString(), ConvertToString(), G4VVisCommand::ConvertToString(), G4UIcmdWith3VectorAndUnit::DoIt(), G4UIcmdWithADoubleAndUnit::DoIt(), G4UIcmdWith3VectorAndUnit::GetNewUnitValue(), G4UIcmdWithADoubleAndUnit::GetNewUnitValue(), G4EmExtraParametersMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), G4UserPhysicsListMessenger::SetNewValue(), G4VisCommandSceneAddArrow::SetNewValue(), G4VisCommandSceneAddAxes::SetNewValue(), G4VisCommandSceneAddExtent::SetNewValue(), G4VisCommandSceneAddLine::SetNewValue(), G4VisCommandSceneAddLogo::SetNewValue(), G4VisCommandSceneAddScale::SetNewValue(), G4VisCommandSceneAddText::SetNewValue(), G4VisCommandSceneAddVolume::SetNewValue(), G4VisCommandSetExtentForField::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), G4VisCommandViewerAddCutawayPlane::SetNewValue(), and G4VisCommandViewerChangeCutawayPlane::SetNewValue().

Member Data Documentation

commandFailureCode

G4int G4UIcommand::commandFailureCode = 0

protected

Definition at line 205 of file G4UIcommand.hh.

Referenced by CommandFailed(), CommandFailed(), IfCommandFailed(), and ResetFailure().

failureDescription

G4String G4UIcommand::failureDescription = ""

protected

Definition at line 206 of file G4UIcommand.hh.

Referenced by CommandFailed(), CommandFailed(), GetFailureDescription(), and ResetFailure().

ifSort

G4bool G4UIcommand::ifSort = false

protected

Definition at line 208 of file G4UIcommand.hh.

Referenced by G4UIdirectory::IfSort(), SetDefaultSortFlag(), and G4UIdirectory::Sort().

toBeBroadcasted

G4bool G4UIcommand::toBeBroadcasted = false

protected

Definition at line 201 of file G4UIcommand.hh.

Referenced by G4UIcommand(), SetToBeBroadcasted(), and ToBeBroadcasted().

toBeFlushed

G4bool G4UIcommand::toBeFlushed = false

protected

Definition at line 202 of file G4UIcommand.hh.

Referenced by SetToBeFlushed(), and ToBeFlushed().

workerThreadOnly

G4bool G4UIcommand::workerThreadOnly = false

protected

Definition at line 203 of file G4UIcommand.hh.

Referenced by DoIt(), IsWorkerThreadOnly(), List(), and SetWorkerThreadOnly().

---

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

• G4UIcommand.hh
• G4UIcommand.cc