#include <G4ModelApplyCommandsT.hh>

Inheritance diagram for G4ModelCmdApplyStringColour< M >:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const

	G4ModelCmdApplyStringColour (M *model, const G4String &placement, const G4String &cmdName)

G4String	GetCurrentValue (G4UIcommand *command)

G4bool	operator!= (const G4UImessenger &messenger) const

G4bool	operator== (const G4UImessenger &messenger) const

G4String	Placement ()

void	SetNewValue (G4UIcommand *command, G4String newValue)

virtual	~G4ModelCmdApplyStringColour ()

Protected Member Functions
void	AddUIcommand (G4UIcommand *newCommand)

virtual void	Apply (const G4String &, const G4Colour &)=0

G4String	BtoS (G4bool b)

G4UIcommand *	ComponentCommand ()

template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)

void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)

G4String	DtoS (G4double a)

G4String	ItoS (G4int i)

M *	Model ()

G4bool	StoB (G4String s)

G4double	StoD (G4String s)

G4int	StoI (G4String s)

G4long	StoL (G4String s)

G4UIcommand *	StringCommand ()

Protected Attributes
G4UIdirectory *	baseDir = nullptr

G4String	baseDirName = ""

G4bool	commandsShouldBeInMaster = false

Private Attributes
G4UIcommand *	fpComponentCmd

G4String	fPlacement

M *	fpModel

G4UIcommand *	fpStringCmd

Detailed Description

template<typename M>
class G4ModelCmdApplyStringColour< M >

Definition at line 50 of file G4ModelApplyCommandsT.hh.

Constructor & Destructor Documentation

◆ G4ModelCmdApplyStringColour()

template<typename M >

G4ModelCmdApplyStringColour< M >::G4ModelCmdApplyStringColour	(	M *	model,
		const G4String &	placement,
		const G4String &	cmdName
	)

Definition at line 76 of file G4ModelApplyCommandsT.hh.

  :G4VModelCommand<M>(model, placement)
{
  //Set variable colour through a string
  G4String dir = placement+"/"+model->Name()+"/"+cmdName;
  G4UIparameter* param(0);
 
  fpStringCmd = new G4UIcommand(dir, this);
  fpStringCmd->SetGuidance("Set variable colour through a string");   
  
  param = new G4UIparameter("Variable", 's', false);
  fpStringCmd->SetParameter(param);
 
  param = new G4UIparameter("Value", 's', false);
  fpStringCmd->SetParameter(param);
 
  //Set variable colour through RGBA components
  G4String componentDir = dir+"RGBA";
  
  fpComponentCmd = new G4UIcommand(componentDir, this);
  fpComponentCmd->SetGuidance("Set variable colour through red, green, blue and alpha components");   
  param = new G4UIparameter("Variable", 's', false);
  fpComponentCmd->SetParameter(param);
 
  param = new G4UIparameter("Red component", 'd', false);
  fpComponentCmd->SetParameter(param);
 
  param = new G4UIparameter("Green component", 'd', false);
  fpComponentCmd->SetParameter(param);
 
  param = new G4UIparameter("Blue component", 'd', false);
  fpComponentCmd->SetParameter(param);
 
  param = new G4UIparameter("Alpha component", 'd', false);
  fpComponentCmd->SetParameter(param);
} 

References G4ModelCmdApplyStringColour< M >::fpComponentCmd, G4ModelCmdApplyStringColour< M >::fpStringCmd, G4UIcommand::SetGuidance(), and G4UIcommand::SetParameter().

◆ ~G4ModelCmdApplyStringColour()

template<typename M >

G4ModelCmdApplyStringColour< M >::~G4ModelCmdApplyStringColour

virtual

Definition at line 114 of file G4ModelApplyCommandsT.hh.

{ 
  delete fpStringCmd;
  delete fpComponentCmd;
}

Member Function Documentation

◆ AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand * newCommand )

protectedinherited

Definition at line 149 of file G4UImessenger.cc.

{
  G4cerr << "Warning : Old style definition of G4UIcommand <"
         << newCommand->GetCommandPath() << ">." << G4endl;
}

References G4cerr, G4endl, and G4UIcommand::GetCommandPath().

◆ Apply()

template<typename M >

virtual void G4ModelCmdApplyStringColour< M >::Apply	(	const G4String &	,
		const G4Colour &
	)

protectedpure virtual

Implemented in G4ModelCmdSetStringColour< M >.

◆ BtoS()

G4String G4UImessenger::BtoS ( G4bool b )

protectedinherited

Definition at line 98 of file G4UImessenger.cc.

{
  G4String vl = "0";
  if(b)
    vl = "true";
  return vl;
}

◆ CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const

inlineinherited

Definition at line 77 of file G4UImessenger.hh.

    {
      return commandsShouldBeInMaster;
    }

References G4UImessenger::commandsShouldBeInMaster.

Referenced by G4UIcommand::G4UIcommandCommonConstructorCode().

◆ ComponentCommand()

template<typename M >

G4UIcommand * G4ModelCmdApplyStringColour< M >::ComponentCommand ( )

inlineprotected

Definition at line 66 of file G4ModelApplyCommandsT.hh.

66{return fpComponentCmd;}

References G4ModelCmdApplyStringColour< M >::fpComponentCmd.

◆ CreateCommand()

template<typename T >

T * G4UImessenger::CreateCommand	(	const G4String &	cname,
		const G4String &	dsc
	)

protectedinherited

Definition at line 110 of file G4UImessenger.hh.

{
  G4String path;
  if(cname[0] != '/')
  {
    path = baseDirName + cname;
    if(path[0] != '/')
      path = "/" + path;
  }
 
  T* command = new T(path.c_str(), this);
  command->SetGuidance(dsc.c_str());
 
  return command;
}

References G4UImessenger::baseDirName.

◆ CreateDirectory()

void G4UImessenger::CreateDirectory	(	const G4String &	path,
		const G4String &	dsc,
		G4bool	commandsToBeBroadcasted = `true`
	)

protectedinherited

Definition at line 156 of file G4UImessenger.cc.

{
  G4UImanager* ui = G4UImanager::GetUIpointer();
 
  G4String fullpath = path;
  if(fullpath.back() != '/')
    fullpath.append("/");
 
  G4UIcommandTree* tree = ui->GetTree()->FindCommandTree(fullpath.c_str());
  if(tree != nullptr)
  {
    baseDirName = tree->GetPathName();
  }
  else
  {
    baseDir     = new G4UIdirectory(fullpath.c_str(), commandsToBeBroadcasted);
    baseDirName = fullpath;
    baseDir->SetGuidance(dsc.c_str());
  }
}

References G4UImessenger::baseDir, G4UImessenger::baseDirName, G4UIcommandTree::FindCommandTree(), G4UIcommandTree::GetPathName(), G4UImanager::GetTree(), G4UImanager::GetUIpointer(), and G4UIcommand::SetGuidance().

Referenced by G4MoleculeShootMessenger::G4MoleculeShootMessenger(), and G4UImessenger::G4UImessenger().

◆ DtoS()

G4String G4UImessenger::DtoS ( G4double a )

protectedinherited

Definition at line 90 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << a;
  return G4String(os.str());
}

Referenced by G4ScoreQuantityMessenger::FilterCommands(), and G4UIcontrolMessenger::SetNewValue().

◆ GetCurrentValue()

G4String G4VModelCommand< M >::GetCurrentValue ( G4UIcommand * command )

virtualinherited

Reimplemented from G4UImessenger.

Definition at line 55 of file G4VModelCommand.hh.

{
  return "";
}

◆ ItoS()

G4String G4UImessenger::ItoS ( G4int i )

protectedinherited

Definition at line 82 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << i;
  return G4String(os.str());
}

Referenced by G4GenericMessenger::DeclareMethod(), and G4ParticleGunMessenger::GetCurrentValue().

◆ Model()

M * G4VModelCommand< M >::Model

protectedinherited

Definition at line 61 of file G4VModelCommand.hh.

{
  return fpModel;
}

◆ operator!=()

G4bool G4UImessenger::operator!= ( const G4UImessenger & messenger ) const

inherited

Definition at line 76 of file G4UImessenger.cc.

{
  return this != &messenger;
}

◆ operator==()

G4bool G4UImessenger::operator== ( const G4UImessenger & messenger ) const

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ Placement()

G4String G4VModelCommand< M >::Placement

inherited

Definition at line 56 of file G4VModelCommand.hh.

{
  return fPlacement;
}

◆ SetNewValue()

template<typename M >

void G4ModelCmdApplyStringColour< M >::SetNewValue	(	G4UIcommand *	command,
		G4String	newValue
	)

virtual

Reimplemented from G4UImessenger.

Definition at line 121 of file G4ModelApplyCommandsT.hh.

{
  G4Colour myColour;
  G4String parameter;
  
  if (cmd == fpStringCmd) {
    G4String colour;
    std::istringstream is (newValue);
    is >> parameter >> colour;
    
    // Colour key should exist
    if (!G4Colour::GetColour(colour, myColour)) {
      G4ExceptionDescription ed;
      ed << "G4Colour with key "<<colour<<" does not exist ";
      G4Exception
    ("G4ModelCmdApplyStringColour<M>::SetNewValue",
     "modeling0106", JustWarning, ed);
      return;
    }
  }
  
  if (cmd == fpComponentCmd) {
    G4double red(0), green(0), blue(0), alpha(0);
    std::istringstream is (newValue);
    is >> parameter >> red >> green >> blue >> alpha;
    
    G4Colour colour(red, green, blue, alpha);
    myColour = colour;
  }
 
  Apply(parameter, myColour);
  G4VVisManager* visManager = G4VVisManager::GetConcreteInstance();
  if (visManager) visManager->NotifyHandlers();
}

References alpha, G4Exception(), G4Colour::GetColour(), G4VVisManager::GetConcreteInstance(), JustWarning, and G4VVisManager::NotifyHandlers().

◆ StoB()

G4bool G4UImessenger::StoB ( G4String s )

protectedinherited

Definition at line 137 of file G4UImessenger.cc.

{
  G4String v = G4StrUtil::to_upper_copy(str);
  G4bool vl = false;
  if(v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE")
  {
    vl = true;
  }
  return vl;
}

References G4StrUtil::to_upper_copy().

Referenced by G4LocalThreadCoutMessenger::SetNewValue(), G4CascadeParamMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoD()

G4double G4UImessenger::StoD ( G4String s )

protectedinherited

Definition at line 127 of file G4UImessenger.cc.

{
  G4double vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoreQuantityMessenger::FParticleWithEnergyCommand(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4VisCommandSceneAddText::SetNewValue(), G4VisCommandSceneAddText2D::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4PolarizationMessenger::SetNewValue().

◆ StoI()

G4int G4UImessenger::StoI ( G4String s )

protectedinherited

Definition at line 107 of file G4UImessenger.cc.

{
  G4int vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoringMessenger::Fill1D(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4ParticleGunMessenger::IonLevelCommand(), G4GeneralParticleSourceMessenger::IonLvlCommand(), G4ScoringMessenger::MeshBinCommand(), G4LocalThreadCoutMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4GMocrenMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoL()

G4long G4UImessenger::StoL ( G4String s )

protectedinherited

Definition at line 117 of file G4UImessenger.cc.

{
  G4long vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4RunMessenger::SetNewValue().

◆ StringCommand()

template<typename M >

G4UIcommand * G4ModelCmdApplyStringColour< M >::StringCommand ( )

inlineprotected

Definition at line 65 of file G4ModelApplyCommandsT.hh.

65{return fpStringCmd;}

References G4ModelCmdApplyStringColour< M >::fpStringCmd.

Field Documentation

◆ baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr

protectedinherited

Definition at line 102 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateDirectory(), and G4UImessenger::~G4UImessenger().

◆ baseDirName

G4String G4UImessenger::baseDirName = ""

protectedinherited

Definition at line 103 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateCommand(), and G4UImessenger::CreateDirectory().

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protectedinherited

Definition at line 104 of file G4UImessenger.hh.

Referenced by G4UImessenger::CommandsShouldBeInMaster(), and G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger().

◆ fpComponentCmd

template<typename M >

G4UIcommand* G4ModelCmdApplyStringColour< M >::fpComponentCmd

private

Definition at line 71 of file G4ModelApplyCommandsT.hh.

Referenced by G4ModelCmdApplyStringColour< M >::ComponentCommand(), and G4ModelCmdApplyStringColour< M >::G4ModelCmdApplyStringColour().

◆ fPlacement

G4String G4VModelCommand< M >::fPlacement

privateinherited

Definition at line 67 of file G4VModelCommand.hh.

◆ fpModel

M * G4VModelCommand< M >::fpModel

privateinherited

Definition at line 66 of file G4VModelCommand.hh.

◆ fpStringCmd

template<typename M >

G4UIcommand* G4ModelCmdApplyStringColour< M >::fpStringCmd

private

Definition at line 70 of file G4ModelApplyCommandsT.hh.

Referenced by G4ModelCmdApplyStringColour< M >::G4ModelCmdApplyStringColour(), and G4ModelCmdApplyStringColour< M >::StringCommand().

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

source/visualization/modeling/include/G4ModelApplyCommandsT.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4ModelCmdApplyStringColour()

◆ ~G4ModelCmdApplyStringColour()

Member Function Documentation

◆ AddUIcommand()

◆ Apply()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ ComponentCommand()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ ItoS()

◆ Model()

◆ operator!=()

◆ operator==()

◆ Placement()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

◆ StringCommand()

Field Documentation

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster

◆ fpComponentCmd

◆ fPlacement

◆ fpModel

◆ fpStringCmd