G4UIcommand Class Reference

#include <G4UIcommand.hh>

Inheritance diagram for G4UIcommand:

Public Member Functions
	G4UIcommand ()
	G4UIcommand (const char *theCommandPath, G4UImessenger *theMessenger, G4bool tBB=true)
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
void	SetToBeBroadcasted (G4bool val)
G4bool	ToBeBroadcasted () const
void	SetToBeFlushed (G4bool val)
G4bool	ToBeFlushed () const
void	SetWorkerThreadOnly (G4bool val=true)
G4bool	IsWorkerThreadOnly () 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)

Protected Attributes
G4bool	toBeBroadcasted
G4bool	toBeFlushed
G4bool	workerThreadOnly

Detailed Description

Definition at line 51 of file G4UIcommand.hh.

Constructor & Destructor Documentation

G4UIcommand::G4UIcommand

(

)

Definition at line 42 of file G4UIcommand.cc.

  : messenger(0), toBeBroadcasted(false), toBeFlushed(false), workerThreadOnly(false),
    bp(0), token(IDENTIFIER), paramERR(0)
{
}

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

Definition at line 48 of file G4UIcommand.cc.

:messenger(theMessenger),toBeBroadcasted(tBB),toBeFlushed(false), workerThreadOnly(false),
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 ( )

virtual

Definition at line 100 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();
}

Here is the call graph for this function:

Member Function Documentation

void G4UIcommand::AvailableForStates

(

G4ApplicationState

s1

)

Definition at line 240 of file G4UIcommand.cc.

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

Here is the caller graph for this function:

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

Definition at line 246 of file G4UIcommand.cc.

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

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

Definition at line 254 of file G4UIcommand.cc.

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

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

Definition at line 264 of file G4UIcommand.cc.

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

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

Definition at line 276 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);
}

G4String G4UIcommand::CategoryOf ( const char *  unitName )

static

Definition at line 316 of file G4UIcommand.cc.

{
   return G4UnitDefinition::GetCategory(unitName);
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4int G4UIcommand::CheckNewValue ( const char *  newValue )

protected

Definition at line 508 of file G4UIcommand.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

G4ThreeVector G4UIcommand::ConvertTo3Vector ( const char *  st )

static

Definition at line 475 of file G4UIcommand.cc.

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

Here is the caller graph for this function:

G4bool G4UIcommand::ConvertToBool ( const char *  st )

static

Definition at line 437 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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4ThreeVector G4UIcommand::ConvertToDimensioned3Vector ( const char *  st )

static

Definition at line 485 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);
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4UIcommand::ConvertToDimensionedDouble ( const char *  st )

static

Definition at line 463 of file G4UIcommand.cc.

{
  G4double vl;
  char unts[30];

  std::istringstream is(st);
  is >> vl >> unts;
  G4String unt = unts;

  return (vl*ValueOf(unt));
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4UIcommand::ConvertToDouble ( const char *  st )

static

Definition at line 455 of file G4UIcommand.cc.

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

Here is the caller graph for this function:

G4int G4UIcommand::ConvertToInt ( const char *  st )

static

Definition at line 447 of file G4UIcommand.cc.

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

Here is the caller graph for this function:

G4String G4UIcommand::ConvertToString ( G4bool  boolVal )

static

Definition at line 372 of file G4UIcommand.cc.

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

G4String G4UIcommand::ConvertToString ( G4int  intValue )

static

Definition at line 379 of file G4UIcommand.cc.

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

G4String G4UIcommand::ConvertToString ( G4double  doubleValue )

static

Definition at line 387 of file G4UIcommand.cc.

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

Here is the call graph for this function:

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

static

Definition at line 398 of file G4UIcommand.cc.

{
  G4String unt = unitName;
  G4double uv = ValueOf(unitName);

  std::ostringstream os;
  if(G4UImanager::DoublePrecisionStr())
  { os << std::setprecision(17) << doubleValue/uv << " " << unitName; }
  else
  { os << doubleValue/uv << " " << unitName; }
  G4String vl = os.str();
  return vl;
}

Here is the call graph for this function:

G4String G4UIcommand::ConvertToString ( G4ThreeVector  vec )

static

Definition at line 412 of file G4UIcommand.cc.

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

Here is the call graph for this function:

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

static

Definition at line 423 of file G4UIcommand.cc.

{
  G4String unt = unitName;
  G4double uv = ValueOf(unitName);

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

Here is the call graph for this function:

G4int G4UIcommand::DoIt ( G4String  parameterList )

virtual

Reimplemented in G4UIcmdWith3VectorAndUnit, and G4UIcmdWithADoubleAndUnit.

Definition at line 123 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; }

  if(workerThreadOnly && G4Threading::IsMasterThread()) return 0;

  messenger->SetNewValue( this, correctParameters );
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

const G4String& G4UIcommand::GetCommandName ( ) const

inline

Definition at line 141 of file G4UIcommand.hh.

      { return commandName; }

Here is the caller graph for this function:

const G4String& G4UIcommand::GetCommandPath ( ) const

inline

Definition at line 139 of file G4UIcommand.hh.

      { return commandPath; }

Here is the caller graph for this function:

G4String G4UIcommand::GetCurrentValue

(

)

Definition at line 235 of file G4UIcommand.cc.

{
  return messenger->GetCurrentValue(this);
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4int G4UIcommand::GetGuidanceEntries ( ) const

inline

Definition at line 135 of file G4UIcommand.hh.

      { return commandGuidance.size(); }

Here is the caller graph for this function:

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

inline

Definition at line 137 of file G4UIcommand.hh.

      { return commandGuidance[i]; }

Here is the caller graph for this function:

G4UImessenger* G4UIcommand::GetMessenger ( ) const

inline

Definition at line 149 of file G4UIcommand.hh.

      { return messenger; }

Here is the caller graph for this function:

G4UIparameter* G4UIcommand::GetParameter ( G4int  i ) const

inline

Definition at line 145 of file G4UIcommand.hh.

      { return parameter[i]; }

Here is the caller graph for this function:

G4int G4UIcommand::GetParameterEntries ( ) const

inline

Definition at line 143 of file G4UIcommand.hh.

      { return parameter.size(); }

Here is the caller graph for this function:

const G4String& G4UIcommand::GetRange ( ) const

inline

Definition at line 133 of file G4UIcommand.hh.

      { return rangeString; };

Here is the caller graph for this function:

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

inline

Definition at line 147 of file G4UIcommand.hh.

      { return &availabelStateList; }

Here is the caller graph for this function:

const G4String G4UIcommand::GetTitle ( ) const

inline

Definition at line 170 of file G4UIcommand.hh.

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

Here is the caller graph for this function:

G4bool G4UIcommand::IsAvailable

(

)

Definition at line 290 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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4bool G4UIcommand::IsWorkerThreadOnly ( ) const

inline

Definition at line 194 of file G4UIcommand.hh.

    { return workerThreadOnly; }

Here is the caller graph for this function:

void G4UIcommand::List ( )

virtual

Definition at line 349 of file G4UIcommand.cc.

{
  G4cout << G4endl;
  G4cout << G4endl;
  if(commandPath(commandPath.length()-1)!='/')
  { G4cout << "Command " << commandPath << G4endl; }
  if(workerThreadOnly)
  { G4cout << "    ---- available only in worker thread" << 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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4int G4UIcommand::operator!=

(

const G4UIcommand &

right

)

const

Definition at line 116 of file G4UIcommand.cc.

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

Here is the call graph for this function:

G4int G4UIcommand::operator==

(

const G4UIcommand &

right

)

const

Definition at line 111 of file G4UIcommand.cc.

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

Here is the call graph for this function:

void G4UIcommand::SetGuidance ( const char *  aGuidance )

inline

Definition at line 161 of file G4UIcommand.hh.

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

void G4UIcommand::SetParameter ( G4UIparameter *const  newParameter )

inline

Definition at line 152 of file G4UIcommand.hh.

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

Here is the caller graph for this function:

void G4UIcommand::SetRange ( const char *  rs )

inline

Definition at line 125 of file G4UIcommand.hh.

      { rangeString = rs; }

Here is the caller graph for this function:

void G4UIcommand::SetToBeBroadcasted ( G4bool  val )

inline

Definition at line 184 of file G4UIcommand.hh.

    { toBeBroadcasted = val; }

Here is the caller graph for this function:

void G4UIcommand::SetToBeFlushed ( G4bool  val )

inline

Definition at line 188 of file G4UIcommand.hh.

    { toBeFlushed = val; }

Here is the caller graph for this function:

void G4UIcommand::SetWorkerThreadOnly ( G4bool  val = true )

inline

Definition at line 192 of file G4UIcommand.hh.

    { workerThreadOnly = val; }

Here is the caller graph for this function:

G4bool G4UIcommand::ToBeBroadcasted ( ) const

inline

Definition at line 186 of file G4UIcommand.hh.

    { return toBeBroadcasted; }

Here is the caller graph for this function:

G4bool G4UIcommand::ToBeFlushed ( ) const

inline

Definition at line 190 of file G4UIcommand.hh.

    { return toBeFlushed; }

G4String G4UIcommand::UnitsList ( const char *  unitCategory )

static

Definition at line 321 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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4UIcommand::ValueOf ( const char *  unitName )

static

Definition at line 309 of file G4UIcommand.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

G4bool G4UIcommand::toBeBroadcasted

protected

Definition at line 179 of file G4UIcommand.hh.

G4bool G4UIcommand::toBeFlushed

protected

Definition at line 180 of file G4UIcommand.hh.

G4bool G4UIcommand::workerThreadOnly

protected

Definition at line 181 of file G4UIcommand.hh.

---

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

• geant4.10.03.p01/source/intercoms/include/G4UIcommand.hh
• geant4.10.03.p01/source/intercoms/src/G4UIcommand.cc