G4 command that takes up to three string values. More...

#include <TG4UICmdWithAComplexString.h>

Inheritance diagram for TG4UICmdWithAComplexString:

Public Member Functions
	TG4UICmdWithAComplexString (const G4String &theCommandPath, G4UImessenger *theMessenger)

virtual	~TG4UICmdWithAComplexString ()

void	SetParameterName (const G4String &name, G4bool omittable)

void	SetDefaultValue (const G4String &defVal)

G4String	GetNewStringValue (const G4String &paramString)

Detailed Description

G4 command that takes up to three string values.

Concrete class of G4UIcommand. The command defined by this class takes up to three string values. General information of G4UIcommand is given in G4UIcommand.hh.

Author: I. Hrivnacova; IPN, Orsay

Definition at line 29 of file TG4UICmdWithAComplexString.h.

Constructor & Destructor Documentation

◆ TG4UICmdWithAComplexString()

TG4UICmdWithAComplexString::TG4UICmdWithAComplexString	(	const G4String &	theCommandPath,
		G4UImessenger *	theMessenger )

Standard constructor. The command string with full path directory and the pointer to the messenger must be given.

Definition at line 20 of file TG4UICmdWithAComplexString.cxx.

◆ ~TG4UICmdWithAComplexString()

TG4UICmdWithAComplexString::~TG4UICmdWithAComplexString ( )

virtual

Destructor

Definition at line 37 of file TG4UICmdWithAComplexString.cxx.

Member Function Documentation

◆ SetParameterName()

void TG4UICmdWithAComplexString::SetParameterName	(	const G4String &	name,
		G4bool	omittable )

Set the parameter names for the parameters. The "omittable" is set only for the first parameter, for the second and third it is always true. The "currentAsDefault" flag is valid only if "omittable" is true. If this flag is true, the current values are used as the default values when user ommits the parameters. If this flag is false, the values given by the next SetDefaultValue() method are used.

Definition at line 47 of file TG4UICmdWithAComplexString.cxx.

Referenced by TG4RunMessenger::TG4RunMessenger().

◆ SetDefaultValue()

void TG4UICmdWithAComplexString::SetDefaultValue ( const G4String & defVal )

Set the default values of the parameters. These default values are used when user of this command ommits some of the parameter values, and "ommitable" is true and "currentAsDefault" is false.

Definition at line 77 of file TG4UICmdWithAComplexString.cxx.

Referenced by TG4RunMessenger::TG4RunMessenger().

◆ GetNewStringValue()

G4String TG4UICmdWithAComplexString::GetNewStringValue ( const G4String & paramString )

Return the parameter string

Definition at line 95 of file TG4UICmdWithAComplexString.cxx.

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

source/global/include/TG4UICmdWithAComplexString.h
source/global/src/TG4UICmdWithAComplexString.cxx

Public Member Functions