G4UIcommand Class Reference

#include <G4UIcommand.hh>

Inheritance diagram for G4UIcommand:

Public Member Functions
	G4UIcommand ()
	G4UIcommand (const char *theCommandPath, G4UImessenger *theMessenger)
virtual	~G4UIcommand ()
G4int	operator== (const G4UIcommand &right) const
G4int	operator!= (const G4UIcommand &right) const
virtual G4int	DoIt (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
G4int	GetGuidanceEntries () const
const G4String &	GetGuidanceLine (G4int i) const
const G4String &	GetCommandPath () const
const G4String &	GetCommandName () const
G4int	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

Static Public Member Functions
static G4String	ConvertToString (G4bool boolVal)
static G4String	ConvertToString (G4int intValue)
static G4String	ConvertToString (G4double doubleValue)
static G4String	ConvertToString (G4double doubleValue, const char *unitName)
static G4String	ConvertToString (G4ThreeVector vec)
static G4String	ConvertToString (G4ThreeVector vec, const char *unitName)
static G4bool	ConvertToBool (const char *st)
static G4int	ConvertToInt (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)

Detailed Description

Definition at line 51 of file G4UIcommand.hh.

Constructor & Destructor Documentation

G4UIcommand() [1/2]

G4UIcommand::G4UIcommand

(

)

Definition at line 41 of file G4UIcommand.cc.

  : messenger(0), bp(0), token(IDENTIFIER), paramERR(0)
{
}

G4UIcommand() [2/2]

G4UIcommand::G4UIcommand	(	const char *	theCommandPath,
		G4UImessenger *	theMessenger
	)

Definition at line 46 of file G4UIcommand.cc.

:messenger(theMessenger),token(IDENTIFIER),paramERR(0)
{
  G4String comStr = theCommandPath;
  if(!theMessenger)
  { // this must be a directory
    if(comStr(comStr.length()-1)!='/')
    {
      G4cerr << "G4UIcommand Warning : " << G4endl;
      G4cerr << "  <" << theCommandPath << "> must be a directory." << G4endl;
      G4cerr << "  '/' is appended." << G4endl;
      comStr += "/";
    }
  }
  G4UIcommandCommonConstructorCode (comStr);
  G4String nullString;
  availabelStateList.clear();
  availabelStateList.push_back(G4State_PreInit);
  availabelStateList.push_back(G4State_Init);
  availabelStateList.push_back(G4State_Idle);
  availabelStateList.push_back(G4State_GeomClosed);
  availabelStateList.push_back(G4State_EventProc);
  availabelStateList.push_back(G4State_Abort);
}

~G4UIcommand()

G4UIcommand::~G4UIcommand ( )

virtual

Definition at line 83 of file G4UIcommand.cc.

{
  G4UImanager* fUImanager = G4UImanager::GetUIpointer();
  if(fUImanager) fUImanager->RemoveCommand(this);
  
  G4int n_parameterEntry = parameter.size();
  for( G4int i_thParameter=0; i_thParameter < n_parameterEntry; i_thParameter++ )
  { delete parameter[i_thParameter]; }
  parameter.clear();
}

Member Function Documentation

AvailableForStates() [1/5]

void G4UIcommand::AvailableForStates

(

G4ApplicationState

s1

)

Definition at line 219 of file G4UIcommand.cc.

{
  availabelStateList.clear();
  availabelStateList.push_back(s1);
}

Referenced by G4QMessenger::Add(), G4AdjointSimMessenger::G4AdjointSimMessenger(), G4AnalysisMessenger::G4AnalysisMessenger(), G4EmMessenger::G4EmMessenger(), G4EmQMessenger::G4EmQMessenger(), G4EnergyLossMessenger::G4EnergyLossMessenger(), G4ErrorMessenger::G4ErrorMessenger(), G4EvManMessenger::G4EvManMessenger(), G4FastSimulationMessenger::G4FastSimulationMessenger(), G4GDMLMessenger::G4GDMLMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4GMocrenMessenger::G4GMocrenMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4NeutronKillerMessenger::G4NeutronKillerMessenger(), G4OpticalPhysicsMessenger::G4OpticalPhysicsMessenger(), G4ParticleMessenger::G4ParticleMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4PolarizationMessenger::G4PolarizationMessenger(), G4ProcessManagerMessenger::G4ProcessManagerMessenger(), G4ProcessTableMessenger::G4ProcessTableMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), G4RunMessenger::G4RunMessenger(), G4StackingMessenger::G4StackingMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), GFlashShowerModelMessenger::GFlashShowerModelMessenger(), and G4GenericMessenger::Command::SetStates().

AvailableForStates() [2/5]

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

Definition at line 225 of file G4UIcommand.cc.

{
  availabelStateList.clear();
  availabelStateList.push_back(s1);
  availabelStateList.push_back(s2);
}

AvailableForStates() [3/5]

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

Definition at line 233 of file G4UIcommand.cc.

{
  availabelStateList.clear();
  availabelStateList.push_back(s1);
  availabelStateList.push_back(s2);
  availabelStateList.push_back(s3);
}

AvailableForStates() [4/5]

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

Definition at line 243 of file G4UIcommand.cc.

{
  availabelStateList.clear();
  availabelStateList.push_back(s1);
  availabelStateList.push_back(s2);
  availabelStateList.push_back(s3);
  availabelStateList.push_back(s4);
}

AvailableForStates() [5/5]

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

Definition at line 255 of file G4UIcommand.cc.

{
  availabelStateList.clear();
  availabelStateList.push_back(s1);
  availabelStateList.push_back(s2);
  availabelStateList.push_back(s3);
  availabelStateList.push_back(s4);
  availabelStateList.push_back(s5);
}

CategoryOf()

G4String G4UIcommand::CategoryOf ( const char *  unitName )

static

Definition at line 295 of file G4UIcommand.cc.

{
   return G4UnitDefinition::GetCategory(unitName);
}

Referenced by G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit(), G4UIcmdWith3VectorAndUnit::ConvertToStringWithBestUnit(), G4EnergyLossMessenger::G4EnergyLossMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4UIcmdWith3VectorAndUnit::SetDefaultUnit(), and G4UIcmdWithADoubleAndUnit::SetDefaultUnit().

CheckNewValue()

G4int G4UIcommand::CheckNewValue ( const char *  newValue )

protected

Definition at line 473 of file G4UIcommand.cc.

{
   yystype result;
   // if( TypeCheck(newValue) == 0 ) return 1;
   if( ! rangeString.isNull() )
   { if( RangeCheck(newValue) == 0 ) return fParameterOutOfRange; }
   return 0;  // succeeded
}

Referenced by DoIt().

ConvertTo3Vector()

G4ThreeVector G4UIcommand::ConvertTo3Vector ( const char *  st )

static

Definition at line 441 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 403 of file G4UIcommand.cc.

{
  G4String v = st;
  v.toUpper();
  G4bool vl = false;
  if( v=="Y" || v=="YES" || v=="1" || v=="T" || v=="TRUE" )
  { vl = true; }
  return vl;
}

Referenced by G4UIcmdWithABool::GetNewBoolValue(), G4VisCommandAbortReviewKeptEvents::SetNewValue(), G4VisCommandEnable::SetNewValue(), G4VisCommandGeometrySetDaughtersInvisible::SetNewValue(), G4VisCommandGeometrySetForceAuxEdgeVisible::SetNewValue(), G4VisCommandGeometrySetForceSolid::SetNewValue(), G4VisCommandGeometrySetForceWireframe::SetNewValue(), G4VisCommandGeometrySetVisibility::SetNewValue(), G4VisCommandSceneActivateModel::SetNewValue(), G4VisCommandSceneAddLogicalVolume::SetNewValue(), G4VisCommandsTouchableSet::SetNewValue(), G4VisCommandViewerDefaultHiddenEdge::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), and G4AnalysisMessenger::SetNewValue().

ConvertToDimensioned3Vector()

G4ThreeVector G4UIcommand::ConvertToDimensioned3Vector ( const char *  st )

static

Definition at line 451 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 429 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(), and G4AttCheck::Standard().

ConvertToDouble()

G4double G4UIcommand::ConvertToDouble ( const char *  st )

static

Definition at line 421 of file G4UIcommand.cc.

{
  G4double vl;
  std::istringstream is(st);
  is >> vl;
  return vl;
}

Referenced by G4UIcmdWith3VectorAndUnit::DoIt(), G4UIcmdWithADoubleAndUnit::DoIt(), G4UIcmdWithADouble::GetNewDoubleValue(), G4VisCommandGeometrySetColour::SetNewValue(), G4VisCommandSetColour::SetNewValue(), G4VisCommandSetTextColour::SetNewValue(), and G4VisCommandsTouchableSet::SetNewValue().

ConvertToInt()

G4int G4UIcommand::ConvertToInt ( const char *  st )

static

Definition at line 413 of file G4UIcommand.cc.

{
  G4int vl;
  std::istringstream is(st);
  is >> vl;
  return vl;
}

Referenced by G4UIcmdWithAnInteger::GetNewIntValue(), G4VisCommandsTouchableSet::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), and G4TrackingMessenger::SetNewValue().

ConvertToString() [1/6]

G4String G4UIcommand::ConvertToString ( G4bool  boolVal )

static

Definition at line 349 of file G4UIcommand.cc.

{
  G4String vl = "0";
  if(boolVal) vl = "1";
  return vl;
}

Referenced by G4tgrParameterMgr::AddParameterNumber(), G4tgbRotationMatrix::BuildG4RotMatrix(), G4tgbPlaceParameterisation::CheckNExtraData(), G4tgbVolume::CheckNoSolidParams(), G4tgrUtils::CheckWLsize(), G4UIcmdWithADoubleAndUnit::ConvertToStringWithDefaultUnit(), G4UIcmdWith3VectorAndUnit::ConvertToStringWithDefaultUnit(), G4SmoothTrajectory::CreateAttValues(), G4Trajectory::CreateAttValues(), G4TrajectoriesModel::CreateCurrentAttValues(), G4UIcmdWith3VectorAndUnit::DoIt(), G4UIcmdWithADoubleAndUnit::DoIt(), G4tgrFileIn::DumpException(), G4tgbGeometryDumper::DumpPVParameterised(), G4tgbGeometryDumper::DumpPVPlacement(), G4tgbGeometryDumper::DumpRotationMatrix(), G4tgbVolume::FindOrConstructG4Solid(), G4tgrMaterialSimple::GetComponent(), G4ScoringMessenger::GetCurrentValue(), G4EvManMessenger::GetCurrentValue(), G4ParticleGunMessenger::GetCurrentValue(), G4GeometryMessenger::GetCurrentValue(), G4UIcontrolMessenger::GetCurrentValue(), G4DecayTableMessenger::GetCurrentValue(), G4ParticleMessenger::GetCurrentValue(), G4ParticlePropertyMessenger::GetCurrentValue(), G4tgrMessenger::GetCurrentValue(), G4ProductionCutsTableMessenger::GetCurrentValue(), G4PolarizationMessenger::GetCurrentValue(), G4MatScanMessenger::GetCurrentValue(), G4RunMessenger::GetCurrentValue(), G4UserPhysicsListMessenger::GetCurrentValue(), G4TrackingMessenger::GetCurrentValue(), G4GMocrenMessenger::GetCurrentValue(), G4HepRepMessenger::GetCurrentValue(), G4VisCommandViewerDolly::GetCurrentValue(), G4VisCommandViewerScale::GetCurrentValue(), G4VisCommandViewerZoom::GetCurrentValue(), G4RTMessenger::GetCurrentValue(), G4tgrUtils::GetDouble(), G4tgrMaterialSimple::GetFraction(), G4ScoreLogColorMap::GetMapColor(), G4MolecularConfiguration::GetName(), G4tgrUtils::GetRotationFromDirection(), G4tgrVolume::GetVolume(), G4EnergySplitter::GetVoxelID(), G4MolecularConfiguration::IonizeMolecule(), G4MolecularConfiguration::MoveOneElectron(), G4DNAMolecularReactionTable::PrintTable(), G4MolecularConfiguration::RemoveElectron(), G4GenericMessenger::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), and G4AttCheck::Standard().

ConvertToString() [2/6]

G4String G4UIcommand::ConvertToString ( G4double  doubleValue )

static

Definition at line 364 of file G4UIcommand.cc.

{
  std::ostringstream os;
  os << doubleValue;
  G4String vl = os.str();
  return vl;
}

ConvertToString() [3/6]

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

static

Definition at line 372 of file G4UIcommand.cc.

{
  G4String unt = unitName;
  G4double uv = ValueOf(unitName);
 
  std::ostringstream os;
  os << doubleValue/uv << " " << unitName;
  G4String vl = os.str();
  return vl;
}

ConvertToString() [4/6]

G4String G4UIcommand::ConvertToString ( G4int  intValue )

static

Definition at line 356 of file G4UIcommand.cc.

{
  std::ostringstream os;
  os << intValue;
  G4String vl = os.str();
  return vl;
}

ConvertToString() [5/6]

G4String G4UIcommand::ConvertToString ( G4ThreeVector  vec )

static

Definition at line 383 of file G4UIcommand.cc.

{
  std::ostringstream os;
  os << vec.x() << " " << vec.y() << " " << vec.z();
  G4String vl = os.str();
  return vl;
}

ConvertToString() [6/6]

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

static

Definition at line 391 of file G4UIcommand.cc.

{
  G4String unt = unitName;
  G4double uv = ValueOf(unitName);
 
  std::ostringstream os;
  os << vec.x()/uv << " " << vec.y()/uv << " " << vec.z()/uv
     << " " << unitName;
  G4String vl = os.str();
  return vl;
}

DoIt()

G4int G4UIcommand::DoIt ( G4String  parameterList )

virtual

Reimplemented in G4UIcmdWith3VectorAndUnit, and G4UIcmdWithADoubleAndUnit.

Definition at line 104 of file G4UIcommand.cc.

{
  G4String correctParameters;
  G4int n_parameterEntry = parameter.size();
  if( n_parameterEntry != 0 )
  {
    G4String aToken;
    G4String correctToken;
    G4Tokenizer parameterToken( parameterList );
    for( G4int 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(aToken.length()-1) != '"'
               || ( aToken.length()==1 && aToken(0)=='"' ))
        {
          G4String additionalToken = parameterToken();
          if( additionalToken.isNull() )
          { return fParameterUnreadable+i_thParameter; }
          aToken += " ";
          aToken += additionalToken;
        }
      }
      else if(i_thParameter==n_parameterEntry-1 && parameter[i_thParameter]->GetParameterType()=='s')
      {
        G4String anotherToken;
        while(!((anotherToken=parameterToken()).isNull()))
        {
          G4int idxs = anotherToken.index("#");
          if(idxs==G4int(std::string::npos))
          {
            aToken += " ";
            aToken += anotherToken;
          }
          else if(idxs>0)
          {
            aToken += " ";
            aToken += anotherToken(0,idxs);
            break;
          }
          else
          { break; }
        }
      }
 
      if( aToken.isNull() || aToken == "!" )
      {
        if(parameter[i_thParameter]->IsOmittable())
        { 
          if(parameter[i_thParameter]->GetCurrentAsDefault())
          {
            G4Tokenizer cvSt(messenger->GetCurrentValue(this));
            G4String parVal;
            for(G4int ii=0;ii<i_thParameter;ii++)
            {
          parVal = cvSt();
          if (parVal(0)=='"')
        {
          while( parVal(parVal.length()-1) != '"' )
            {
              G4String additionalToken = cvSt();
              if( additionalToken.isNull() )
            { return fParameterUnreadable+i_thParameter; }
              parVal += " ";
              parVal += additionalToken;
            }
        }
        }
        G4String aCVToken = cvSt();
        if (aCVToken(0)=='"')
        {
          while( aCVToken(aCVToken.length()-1) != '"' )
          {
        G4String additionalToken = cvSt();
        if( additionalToken.isNull() )
        { return fParameterUnreadable+i_thParameter; }
        aCVToken += " ";
        aCVToken += additionalToken;
          }
          // aCVToken.strip(G4String::both,'"');
        }
            correctParameters.append(aCVToken);
          }
          else
          { correctParameters.append(parameter[i_thParameter]->GetDefaultValue()); }
        }
        else
        { return fParameterUnreadable+i_thParameter; }
      }
      else
      {
        G4int stat = parameter[i_thParameter]->CheckNewValue( aToken );
        if(stat) return stat+i_thParameter;
        correctParameters.append(aToken);
      }
    }
  }
 
  if(CheckNewValue( correctParameters ))
  { return fParameterOutOfRange+99; }
 
  messenger->SetNewValue( this, correctParameters );
  return 0;
}

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

GetCommandName()

const G4String & G4UIcommand::GetCommandName ( ) const

inline

Definition at line 136 of file G4UIcommand.hh.

      { return commandName; }

Referenced by G4UIcommandTree::CreateHTML(), G4GenericMessenger::GetCurrentValue(), and G4GenericMessenger::SetNewValue().

GetCommandPath()

const G4String & G4UIcommand::GetCommandPath ( ) const

inline

Definition at line 134 of file G4UIcommand.hh.

      { return commandPath; }

Referenced by G4UIcommandTree::AddNewCommand(), G4UImessenger::AddUIcommand(), G4ScoreQuantityMessenger::CheckMeshPS(), operator!=(), operator==(), G4UIcommandTree::RemoveCommand(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4GenericMessenger::Command::SetUnit().

GetCurrentValue()

G4String G4UIcommand::GetCurrentValue

(

)

Definition at line 214 of file G4UIcommand.cc.

{
  return messenger->GetCurrentValue(this);
}

Referenced by G4UImanager::GetCurrentValues().

GetGuidanceEntries()

G4int G4UIcommand::GetGuidanceEntries ( ) const

inline

Definition at line 130 of file G4UIcommand.hh.

      { return commandGuidance.size(); }

Referenced by G4UIcommandTree::CreateHTML(), and G4GenericMessenger::Command::SetUnit().

GetGuidanceLine()

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

inline

Definition at line 132 of file G4UIcommand.hh.

      { return commandGuidance[i]; }

Referenced by G4UIcommandTree::CreateHTML(), and G4GenericMessenger::Command::SetUnit().

GetMessenger()

G4UImessenger * G4UIcommand::GetMessenger ( ) const

inline

Definition at line 144 of file G4UIcommand.hh.

      { return messenger; }

Referenced by G4GenericMessenger::Command::SetUnit().

GetParameter()

G4UIparameter * G4UIcommand::GetParameter ( G4int  i ) const

inline

Definition at line 140 of file G4UIcommand.hh.

      { return parameter[i]; }

Referenced by G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit(), G4UIcmdWith3VectorAndUnit::ConvertToStringWithBestUnit(), G4UIcmdWithADoubleAndUnit::ConvertToStringWithDefaultUnit(), G4UIcmdWith3VectorAndUnit::ConvertToStringWithDefaultUnit(), G4UIcommandTree::CreateHTML(), G4UIcmdWith3VectorAndUnit::DoIt(), G4UIcmdWithADoubleAndUnit::DoIt(), G4UImanager::GetCurrentStringValue(), G4ProcessTableMessenger::GetCurrentValue(), G4UIcmdWithAString::SetCandidates(), G4UIcmdWith3VectorAndUnit::SetDefaultUnit(), G4UIcmdWithADoubleAndUnit::SetDefaultUnit(), G4UIcmdWithAString::SetDefaultValue(), G4UIcmdWithABool::SetDefaultValue(), G4UIcmdWithADouble::SetDefaultValue(), G4UIcmdWithADoubleAndUnit::SetDefaultValue(), G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcmdWithNucleusLimits::SetDefaultValue(), G4UIcmdWith3Vector::SetDefaultValue(), G4UIcmdWith3VectorAndUnit::SetDefaultValue(), G4UIcmdWithABool::SetParameterName(), G4UIcmdWithADouble::SetParameterName(), G4UIcmdWithADoubleAndUnit::SetParameterName(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcmdWithAString::SetParameterName(), G4UIcmdWithNucleusLimits::SetParameterName(), G4UIcmdWith3Vector::SetParameterName(), G4UIcmdWith3VectorAndUnit::SetParameterName(), G4UIcmdWith3VectorAndUnit::SetUnitCandidates(), and G4UIcmdWithADoubleAndUnit::SetUnitCandidates().

GetParameterEntries()

G4int G4UIcommand::GetParameterEntries ( ) const

inline

Definition at line 138 of file G4UIcommand.hh.

      { return parameter.size(); }

Referenced by G4UIcommandTree::CreateHTML(), G4UImanager::GetCurrentStringValue(), and G4InteractorMessenger::SetNewValue().

GetRange()

const G4String & G4UIcommand::GetRange ( ) const

inline

Definition at line 128 of file G4UIcommand.hh.

      { return rangeString; };

Referenced by G4UIcommandTree::CreateHTML(), and G4GenericMessenger::Command::SetUnit().

GetStateList()

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

inline

Definition at line 142 of file G4UIcommand.hh.

      { return &availabelStateList; }

Referenced by G4UIcommandTree::CreateHTML().

GetTitle()

const G4String G4UIcommand::GetTitle ( ) const

inline

Definition at line 165 of file G4UIcommand.hh.

      {
      if(commandGuidance.size() == 0)
      { return G4String("...Title not available..."); }
      else
      { return commandGuidance[0]; }
      }

Referenced by G4UIcommandTree::GetTitle().

IsAvailable()

G4bool G4UIcommand::IsAvailable

(

)

Definition at line 269 of file G4UIcommand.cc.

{
  G4bool av = false;
  G4ApplicationState currentState 
   = G4StateManager::GetStateManager()->GetCurrentState();
   
  G4int nState = availabelStateList.size();
  for(G4int i=0;i<nState;i++)
  {
    if(availabelStateList[i]==currentState)
    {
      av = true;
      break;
    }
  }
 
  return av;
}

Referenced by G4UImanager::ApplyCommand().

List()

void G4UIcommand::List ( )

virtual

Definition at line 328 of file G4UIcommand.cc.

{
  G4cout << G4endl;
  G4cout << G4endl;
  if(commandPath(commandPath.length()-1)!='/')
  { G4cout << "Command " << commandPath << G4endl; }
  G4cout << "Guidance :" << G4endl;
  G4int n_guidanceEntry = commandGuidance.size();
  for( G4int i_thGuidance=0; i_thGuidance < n_guidanceEntry; i_thGuidance++ )
  { G4cout << commandGuidance[i_thGuidance] << G4endl; }
  if( ! rangeString.isNull() )
  { G4cout << " Range of parameters : " << rangeString << G4endl; }
  G4int n_parameterEntry = parameter.size();
  if( n_parameterEntry > 0 )
  {
    for( G4int i_thParameter=0; i_thParameter<n_parameterEntry; i_thParameter++ )
    { parameter[i_thParameter]->List(); }
  }
  G4cout << G4endl;
}

Referenced by G4UIcommandTree::ListCurrent(), G4UIcommandTree::ListCurrentWithNum(), and G4VBasicShell::TerminalHelp().

operator!=()

G4int G4UIcommand::operator!=

(

const G4UIcommand &

right

)

const

Definition at line 99 of file G4UIcommand.cc.

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

operator==()

G4int G4UIcommand::operator==

(

const G4UIcommand &

right

)

const

Definition at line 94 of file G4UIcommand.cc.

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

SetGuidance()

void G4UIcommand::SetGuidance ( const char *  aGuidance )

inline

Definition at line 156 of file G4UIcommand.hh.

      {
        commandGuidance.push_back( G4String( aGuidance ) );
      }

Referenced by G4QMessenger::Add(), G4CascadeParamMessenger::CreateDirectory(), G4GenericMessenger::DeclareMethod(), G4GenericMessenger::DeclareProperty(), G4AdjointSimMessenger::G4AdjointSimMessenger(), G4AnalysisMessenger::G4AnalysisMessenger(), G4DecayTableMessenger::G4DecayTableMessenger(), G4DMmessenger::G4DMmessenger(), G4EmMessenger::G4EmMessenger(), G4EmQMessenger::G4EmQMessenger(), G4EnergyLossMessenger::G4EnergyLossMessenger(), G4ErrorMessenger::G4ErrorMessenger(), G4EvManMessenger::G4EvManMessenger(), G4FastSimulationMessenger::G4FastSimulationMessenger(), G4GDMLMessenger::G4GDMLMessenger(), G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger(), G4GenericMessenger::G4GenericMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4GMocrenMessenger::G4GMocrenMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4INCLXXInterfaceMessenger::G4INCLXXInterfaceMessenger(), G4InteractorMessenger::G4InteractorMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4ModelCmdActive< M >::G4ModelCmdActive(), G4ModelCmdAddInt< M >::G4ModelCmdAddInt(), G4ModelCmdAddInterval< M >::G4ModelCmdAddInterval(), G4ModelCmdAddIntervalContext< M >::G4ModelCmdAddIntervalContext(), G4ModelCmdAddString< M >::G4ModelCmdAddString(), G4ModelCmdAddValue< M >::G4ModelCmdAddValue(), G4ModelCmdAddValueContext< M >::G4ModelCmdAddValueContext(), G4ModelCmdApplyColour< M >::G4ModelCmdApplyColour(), G4ModelCmdApplyStringColour< M >::G4ModelCmdApplyStringColour(), G4ModelCmdCreateContextDir< M >::G4ModelCmdCreateContextDir(), 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(), G4NeutronKillerMessenger::G4NeutronKillerMessenger(), G4NistMessenger::G4NistMessenger(), G4OpticalPhysicsMessenger::G4OpticalPhysicsMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ParticleMessenger::G4ParticleMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4PersistencyCenterMessenger::G4PersistencyCenterMessenger(), G4PolarizationMessenger::G4PolarizationMessenger(), G4ProcessManagerMessenger::G4ProcessManagerMessenger(), G4ProcessTableMessenger::G4ProcessTableMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), G4RadioactiveDecaymessenger::G4RadioactiveDecaymessenger(), G4RunMessenger::G4RunMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4SDmessenger::G4SDmessenger(), G4StackingMessenger::G4StackingMessenger(), G4tgrMessenger::G4tgrMessenger(), G4TrackingMessenger::G4TrackingMessenger(), G4UIcontrolMessenger::G4UIcontrolMessenger(), G4UnitsMessenger::G4UnitsMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4VisCommandDrawTree::G4VisCommandDrawTree(), G4VisCommandDrawView::G4VisCommandDrawView(), G4VisCommandDrawVolume::G4VisCommandDrawVolume(), G4VisCommandGeometrySetColour::G4VisCommandGeometrySetColour(), G4VisCommandGeometrySetDaughtersInvisible::G4VisCommandGeometrySetDaughtersInvisible(), G4VisCommandGeometrySetForceAuxEdgeVisible::G4VisCommandGeometrySetForceAuxEdgeVisible(), G4VisCommandGeometrySetForceLineSegmentsPerCircle::G4VisCommandGeometrySetForceLineSegmentsPerCircle(), G4VisCommandGeometrySetForceSolid::G4VisCommandGeometrySetForceSolid(), G4VisCommandGeometrySetForceWireframe::G4VisCommandGeometrySetForceWireframe(), G4VisCommandGeometrySetLineStyle::G4VisCommandGeometrySetLineStyle(), G4VisCommandGeometrySetLineWidth::G4VisCommandGeometrySetLineWidth(), G4VisCommandGeometrySetVisibility::G4VisCommandGeometrySetVisibility(), G4VisCommandListManagerList< Manager >::G4VisCommandListManagerList(), G4VisCommandListManagerSelect< Manager >::G4VisCommandListManagerSelect(), G4VisCommandManagerMode< Manager >::G4VisCommandManagerMode(), G4VisCommandModelCreate< Factory >::G4VisCommandModelCreate(), G4VisCommandOpen::G4VisCommandOpen(), G4VisCommandSetColour::G4VisCommandSetColour(), G4VisCommandSetLineWidth::G4VisCommandSetLineWidth(), G4VisCommandSetTextColour::G4VisCommandSetTextColour(), G4VisCommandSetTextLayout::G4VisCommandSetTextLayout(), G4VisCommandSetTouchable::G4VisCommandSetTouchable(), G4VisCommandSpecify::G4VisCommandSpecify(), G4VisCommandsTouchableSet::G4VisCommandsTouchableSet(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), G4VisCommandViewerDefaultHiddenEdge::G4VisCommandViewerDefaultHiddenEdge(), G4VisCommandViewerDefaultStyle::G4VisCommandViewerDefaultStyle(), GFlashShowerModelMessenger::GFlashShowerModelMessenger(), G4GenericMessenger::Command::SetGuidance(), G4GenericMessenger::SetGuidance(), G4VisCommandModelCreate< Factory >::SetNewValue(), and G4GenericMessenger::Command::SetUnit().

SetParameter()

void G4UIcommand::SetParameter ( G4UIparameter *const  newParameter )

inline

Definition at line 147 of file G4UIcommand.hh.

      {
  parameter.push_back( newParameter );
  newVal.resize( parameter.size() );
      }

Referenced by G4GenericMessenger::DeclareMethod(), G4GenericMessenger::DeclareProperty(), G4AdjointSimMessenger::G4AdjointSimMessenger(), G4EnergyLossMessenger::G4EnergyLossMessenger(), G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger(), G4GMocrenMessenger::G4GMocrenMessenger(), G4InteractorMessenger::G4InteractorMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4ModelCmdApplyColour< M >::G4ModelCmdApplyColour(), G4ModelCmdApplyStringColour< M >::G4ModelCmdApplyStringColour(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4PolarizationMessenger::G4PolarizationMessenger(), G4ProcessManagerMessenger::G4ProcessManagerMessenger(), G4ProcessTableMessenger::G4ProcessTableMessenger(), G4RadioactiveDecaymessenger::G4RadioactiveDecaymessenger(), G4RunMessenger::G4RunMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4UIcmdWith3Vector::G4UIcmdWith3Vector(), G4UIcmdWith3VectorAndUnit::G4UIcmdWith3VectorAndUnit(), G4UIcmdWithABool::G4UIcmdWithABool(), G4UIcmdWithADouble::G4UIcmdWithADouble(), G4UIcmdWithADoubleAndUnit::G4UIcmdWithADoubleAndUnit(), G4UIcmdWithAnInteger::G4UIcmdWithAnInteger(), G4UIcmdWithAString::G4UIcmdWithAString(), G4UIcmdWithNucleusLimits::G4UIcmdWithNucleusLimits(), G4UIcontrolMessenger::G4UIcontrolMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4VisCommandGeometrySetColour::G4VisCommandGeometrySetColour(), G4VisCommandGeometrySetDaughtersInvisible::G4VisCommandGeometrySetDaughtersInvisible(), G4VisCommandGeometrySetForceAuxEdgeVisible::G4VisCommandGeometrySetForceAuxEdgeVisible(), G4VisCommandGeometrySetForceLineSegmentsPerCircle::G4VisCommandGeometrySetForceLineSegmentsPerCircle(), G4VisCommandGeometrySetForceSolid::G4VisCommandGeometrySetForceSolid(), G4VisCommandGeometrySetForceWireframe::G4VisCommandGeometrySetForceWireframe(), G4VisCommandGeometrySetLineStyle::G4VisCommandGeometrySetLineStyle(), G4VisCommandGeometrySetLineWidth::G4VisCommandGeometrySetLineWidth(), G4VisCommandGeometrySetVisibility::G4VisCommandGeometrySetVisibility(), G4VisCommandOpen::G4VisCommandOpen(), G4VisCommandSceneAddArrow::G4VisCommandSceneAddArrow(), G4VisCommandSceneAddAxes::G4VisCommandSceneAddAxes(), G4VisCommandSceneAddLine::G4VisCommandSceneAddLine(), G4VisCommandSceneAddLogo::G4VisCommandSceneAddLogo(), G4VisCommandSceneAddScale::G4VisCommandSceneAddScale(), G4VisCommandSceneAddText::G4VisCommandSceneAddText(), G4VisCommandSceneAddText2D::G4VisCommandSceneAddText2D(), G4VisCommandSetColour::G4VisCommandSetColour(), G4VisCommandSetTextColour::G4VisCommandSetTextColour(), G4VisCommandSetTouchable::G4VisCommandSetTouchable(), G4VisCommandSpecify::G4VisCommandSpecify(), G4VisCommandsTouchableSet::G4VisCommandsTouchableSet(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), G4VisCommandViewerAddCutawayPlane::G4VisCommandViewerAddCutawayPlane(), and G4VisCommandViewerChangeCutawayPlane::G4VisCommandViewerChangeCutawayPlane().

SetRange()

void G4UIcommand::SetRange ( const char *  rs )

inline

Definition at line 120 of file G4UIcommand.hh.

      { rangeString = rs; }

Referenced by G4QMessenger::Add(), G4AnalysisMessenger::G4AnalysisMessenger(), G4DecayTableMessenger::G4DecayTableMessenger(), G4EnergyLossMessenger::G4EnergyLossMessenger(), G4EvManMessenger::G4EvManMessenger(), G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger(), G4GeometryMessenger::G4GeometryMessenger(), G4HadronicEPTestMessenger::G4HadronicEPTestMessenger(), G4INCLXXInterfaceMessenger::G4INCLXXInterfaceMessenger(), G4NistMessenger::G4NistMessenger(), G4OpticalPhysicsMessenger::G4OpticalPhysicsMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ParticleMessenger::G4ParticleMessenger(), G4ParticlePropertyMessenger::G4ParticlePropertyMessenger(), G4PersistencyCenterMessenger::G4PersistencyCenterMessenger(), G4PolarizationMessenger::G4PolarizationMessenger(), G4ProcessManagerMessenger::G4ProcessManagerMessenger(), G4ProcessTableMessenger::G4ProcessTableMessenger(), G4ProductionCutsTableMessenger::G4ProductionCutsTableMessenger(), G4RadioactiveDecaymessenger::G4RadioactiveDecaymessenger(), G4RunMessenger::G4RunMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4StackingMessenger::G4StackingMessenger(), G4tgrMessenger::G4tgrMessenger(), G4TrackingMessenger::G4TrackingMessenger(), G4UIcontrolMessenger::G4UIcontrolMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4VisCommandSetLineWidth::G4VisCommandSetLineWidth(), G4GenericMessenger::Command::SetRange(), and G4GenericMessenger::Command::SetUnit().

UnitsList()

G4String G4UIcommand::UnitsList ( const char *  unitCategory )

static

Definition at line 300 of file G4UIcommand.cc.

{
  G4String retStr;
  G4UnitsTable& UTbl = G4UnitDefinition::GetUnitsTable();
  size_t i;
  for(i=0;i<UTbl.size();i++)
  { if(UTbl[i]->GetName()==unitCategory) break; }
  if(i==UTbl.size())
  { 
    G4cerr << "Unit category <" << unitCategory << "> is not defined." << G4endl;
    return retStr;
  }
  G4UnitsContainer& UCnt = UTbl[i]->GetUnitsList();
  retStr = UCnt[0]->GetSymbol();
  G4int je = UCnt.size();
  for(G4int j=1;j<je;j++)
  {
    retStr += " ";
    retStr += UCnt[j]->GetSymbol();
  }
  for(G4int k=0;k<je;k++)
  {
    retStr += " ";
    retStr += UCnt[k]->GetName();
  }
  return retStr;
}

Referenced by G4EnergyLossMessenger::G4EnergyLossMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4UIcmdWith3VectorAndUnit::SetUnitCategory(), and G4UIcmdWithADoubleAndUnit::SetUnitCategory().

ValueOf()

G4double G4UIcommand::ValueOf ( const char *  unitName )

static

Definition at line 288 of file G4UIcommand.cc.

{
   G4double value = 0.;
   value = G4UnitDefinition::GetValueOf(unitName);
   return value;              
}

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

---

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

• G4UIcommand.hh
• G4UIcommand.cc