Parameters used in the Cut Generator process. More...

#include <BCP_cg_param.hpp>

Inheritance diagram for BCP_cg_par:

Public Types
enum	chr_params { MessagePassingIsSerial, ReportWhenDefaultIsExecuted, CgVerb_First, CgVerb_Last, end_of_chr_params }
	Character parameters. More...

enum	int_params { NiceLevel, end_of_int_params }
	Integer parameters. More...

enum	dbl_params { dbl_dummy, end_of_dbl_params }
	There are no double parameters. More...

enum	str_params { LogFileName, end_of_str_params }
	String parameters. More...

enum	str_array_params { str_array_dummy, end_of_str_array_params }
	There are no string array parameters. More...

Detailed Description

Parameters used in the Cut Generator process.

These parameters can be set in the original parameter file by including the following line:
BCP_{parameter name} {parameter value}.

Definition at line 12 of file BCP_cg_param.hpp.

Member Enumeration Documentation

enum BCP_cg_par::chr_params

Character parameters.

All of these variables are used as booleans (true = 1, false = 0).

Enumerator
MessagePassingIsSerial	Indicates whether message passing is serial (all processes are on the same processor) or not. Values: true (1), false (0). Default: 1.
ReportWhenDefaultIsExecuted	Print out a message when the default version of an overridable method is executed. Default: 1.
CgVerb_First	Just a marker for the first CgVerb.
CgVerb_Last	Just a marker for the last CgVerb.
end_of_chr_params

Definition at line 15 of file BCP_cg_param.hpp.

enum BCP_cg_par::int_params

Integer parameters.

Enumerator

NiceLevel

The "nice" level the process should run at.

On Linux and on AIX this value should be between -20 and 20. The higher this value the less resource the process will receive from the system. Note that

The process starts with 0 priority and it can only be increased.
If the load is low on the machine (e.g., when all other processes are interactive like netscape or text editors) then even with 20 priority the process will use close to 100% of the cpu, and the interactive processes will be noticably more responsive than they would be if this process ran with 0 priority.

See Also: the man page of the setpriority system function.

end_of_int_params

Definition at line 32 of file BCP_cg_param.hpp.

enum BCP_cg_par::dbl_params

There are no double parameters.

Enumerator
dbl_dummy
end_of_dbl_params

Definition at line 54 of file BCP_cg_param.hpp.

enum BCP_cg_par::str_params

String parameters.

Enumerator

LogFileName

The file where the output from this process should be logged.

To distinguish the output of this CG process from that of the others, the string "-cg-<process_id>" is appended to the given logfile name to form the real filename.

end_of_str_params

Definition at line 61 of file BCP_cg_param.hpp.

enum BCP_cg_par::str_array_params

There are no string array parameters.

Enumerator
str_array_dummy
end_of_str_array_params

Definition at line 72 of file BCP_cg_param.hpp.

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

/tmp/Bcp-1.4.4/Bcp/src/include/BCP_cg_param.hpp

Public Types

Detailed Description

Member Enumeration Documentation