source: trunk/documents/UserDoc/DocBookUsersGuides/IntroductionToGeant4/xml/AllResources/.ls/random.txt @ 904

/control/manual /random
Command directory path : /random/


Guidance :
Random number status control commands.

 Sub-directories : 
 Commands : 
   setDirectoryName * Define the directory name of the rndm status files.
   setSavingFlag * The randomNumberStatus will be saved at :
   saveThisRun * copy currentRun.rndm to runXXX.rndm
   saveThisEvent * copy currentEvent.rndm to runXXXevtYYY.rndm
   resetEngineFrom * Reset the status of the rndm engine from a file.


Command /random/setDirectoryName
Guidance :
Define the directory name of the rndm status files.
Directory must be creates before storing the files.

Parameter : fileName
 Parameter type  : s
 Omittable       : True
 Default value   : ./



Command /random/setSavingFlag
Guidance :
The randomNumberStatus will be saved at :
begining of run (currentRun.rndm) and begining of event (currentEvent.rndm) 

Parameter : flag
 Parameter type  : b
 Omittable       : True
 Default value   : 1



Command /random/saveThisRun
Guidance :
copy currentRun.rndm to runXXX.rndm



Command /random/saveThisEvent
Guidance :
copy currentEvent.rndm to runXXXevtYYY.rndm



Command /random/resetEngineFrom
Guidance :
Reset the status of the rndm engine from a file.
See CLHEP manual for detail.
The engine status must be stored beforehand.
Directory of the status file should be set by /random/setDirectoryName.

Parameter : fileName
 Parameter type  : s
 Omittable       : True
 Default value   : currentRun.rndm