public abstract class CGeneralConstant
extends java.lang.Object
Different constant values are stored in this static class. This is independent from all other classes in different packages and is therefore replaced. This class is intended to be abstract, because the special constant class will extends this one and overwrite the protected with a private constructor to initialize this one.
This general and abstract class performs one method, which tells the special library or project if the write action is performed or not.
Modifier and Type | Field and Description |
---|---|
protected static CGeneralConstant |
_thisConstant
This is the protected instance of this class, which is used like a
singleton.
|
static java.lang.String |
APPLICATION_NAME
The name of this application.
|
static java.lang.String |
APPLICATION_PASSWORD
Is the super user password for all applications.
|
static java.lang.String |
AUTHOR
The author(s) user name.
|
static java.lang.String |
BUILDING
Building/
|
static java.lang.String |
CLA_ARMED1
The command line argument of ARMED.
|
static java.lang.String |
CLA_ARMED2
The command line argument of ARMED.
|
static java.lang.String |
CLA_ENABLE_DEBUG_TICKER
Enables the displaying of the debug ticker time by setting its argument
to
true (i.e. |
static java.lang.String |
CLA_INITDELAY
Created new command line argument which tells the application the delay
time before starting the application if a CDI Server error occurs.
|
static java.lang.String |
CLA_LOG
The command line argument of LOG.
|
static java.lang.String |
CLA_MODE
The command line argument of MODE.
|
static java.lang.String |
CLA_TAB
The command line argument of TAB.
|
static java.lang.String |
CLAZZ |
static java.lang.String |
DEBUG_DEBUG
The debug logging level.
|
static java.lang.String |
DEBUG_ERROR
The error logging level.
|
static java.lang.String |
DEBUG_FATAL
The fatal logging level.
|
static java.lang.String |
DEBUG_INFO
The info logging level.
|
static java.lang.String |
DEBUG_WARN
The warn logging level.
|
static java.lang.String |
DESCRIPTION_CHANNEL
This is the constant final string field of the conversion factor of the
receive float value of the CDI table under the column of DESCRIPTION.
|
static java.lang.String |
DESCRIPTION_RECV
This is the constant final string field of the conversion factor of the
receive float value of the CDI table under the column of DESCRIPTION.
|
static java.lang.String |
DESCRIPTION_SEND
This is the constant final string field of the conversion factor of the
receive float value of the CDI table under the column of DESCRIPTION.
|
static java.lang.String |
DEVELOPER
Developer(s) full name.
|
static java.lang.String |
EMAIL
E-Mail address of the author (only one is specified).
|
static java.lang.String |
ERROR
The following constant is usually used to print out an error message.
|
static int |
ERROR_BASE
The start parameter of the error number of the enumeration
EErrorExt . |
static java.lang.String |
ERROR_RUNTIME |
static java.lang.String |
ERROR_RUNTIME_TITLE |
static java.lang.String |
ERROR_TINE |
static java.lang.String |
ERROR_TINE_TITLE |
static java.lang.String |
ERROR_TOOLTIP
The following constant is usually only used for reporting error messages
as a tool tip.
|
static java.lang.String |
GROUP
Group.
|
static javax.swing.Icon |
ICON_ANIMATE_ERRORMESSAGE_16x16
An animated normal icon shown when an error has occurred.
|
static javax.swing.Icon |
ICON_ANIMATE_ERRORMESSAGE_32x32
An animated big icon shown when an error has occurred.
|
static javax.swing.Icon |
ICON_EMPTY_16x16
An empty icon with the dimension of 16x16.
|
static javax.swing.Icon |
ICON_EMPTY_32x32
An empty icon with the dimension of 32x32.
|
static javax.swing.Icon |
ICON_GREEN_CIRCLE_16x16
A normal green icon.
|
static javax.swing.Icon |
ICON_GREEN_CIRCLE_32x32
A big green icon.
|
static javax.swing.Icon |
ICON_MAGENTA_CIRCLE_16x16
A big icon shown when an error or warning has occurred.
|
static javax.swing.Icon |
ICON_MAGENTA_CIRCLE_32x32
The yellow icon shown when an error or warning has occurred.
|
static javax.swing.Icon |
ICON_MESSAGE_ERROR_32x32
Error icon shown in the error dialog box.
|
static javax.swing.Icon |
ICON_MESSAGE_FATAL_32x32
Fatal error icon shown in the fatal error dialog box.
|
static javax.swing.Icon |
ICON_MESSAGE_INFORMATION_32x32
Information icon shown in the information dialog box.
|
static javax.swing.Icon |
ICON_MESSAGE_QUESTION_32x32
Question icon shown in the question dialog box.
|
static javax.swing.Icon |
ICON_MESSAGE_WARNING_32x32
Warning icon shown in the warning dialog box.
|
static javax.swing.Icon |
ICON_RED_CIRCLE_16x16
A normal icon shown when an error has occurred.
|
static javax.swing.Icon |
ICON_RED_CIRCLE_32x32
A big icon shown when an error has occurred.
|
static javax.swing.Icon |
ICON_YELLOW_CIRCLE_16x16
The yellow icon shown when an error or warning has occurred.
|
static javax.swing.Icon |
ICON_YELLOW_CIRCLE_32x32
A big icon shown when an error or warning has occurred.
|
static java.util.logging.Level |
LOG_LEVEL
Sets the java current logging level to be INFO.
|
static java.lang.String |
MAILINGLIST
Mailing list.
|
static java.util.Map<java.lang.Integer,java.lang.String> |
MAP_STATUS_FILE |
static java.lang.String |
NEAR_OPERATE_ACTIVE
Near operate state is active.
|
static java.lang.String |
PATTERN_CAVITY_PRECISION
Pattern for controlling the cavity numeric precision number or a
character value.
|
static java.lang.String |
PATTERN_CONTROL_PRECISION
Pattern for controlling the control precision.
|
static java.lang.String |
PATTERN_DATA_PRECISION
The normal data element precision read from the CDI table.
|
static java.lang.String |
PATTERN_DEVICEGROUP_LINK1
Pattern for controlling the device group of a TINE link.
|
static java.lang.String |
PATTERN_DEVICEGROUP_LINK2
Pattern for controlling the device group of a TINE link.
|
static java.lang.String |
PATTERN_ERROR_KEY
Pattern for controlling the error key.
|
static java.lang.String |
PATTERN_ERROR_VALUE
Pattern for controlling the error value.
|
static java.lang.String |
PATTERN_IGNORE_ERROR
Pattern.
|
static java.lang.String |
PATTERN_NUMBER_PRECISION
Normal number precision of floating point fields.
|
static java.lang.String |
PATTERN_SWITCH_PRECISION
Pattern for controlling the switch precision.
|
static java.lang.String |
PHONE
Phone number(s).
|
static java.lang.String |
RELEASE_DATE
Release date.
|
static java.lang.String |
ROOM
Room.
|
static int |
STATUS_FILE_INITIALIZE_WARNING
Constant file status field: Initialize warning, i.e.
|
static int |
STATUS_FILE_IO_EXCEPTION
Constant file status field: IO exception.
|
static int |
STATUS_FILE_JAXB_EXCEPTION
Constant file status field: JAXB exception.
|
static int |
STATUS_FILE_LOAD_DEFAULT_WARNING
Constant file status field: Load Default, i.e.
|
static int |
STATUS_FILE_MARSHAL_EXCEPTION
Constant file status field: Marshal exception.
|
static int |
STATUS_FILE_NOT_OPERATING_WARNING
Constant file status field: Not Operating, i.e.
|
static int |
STATUS_FILE_RUNTIME_EXCEPTION
Constant file status field: Runtime exception.
|
static int |
STATUS_FILE_SUCCESS
Constant file status field: Success
|
static int |
STATUS_FILE_TINE_EXCEPTION
Constant file status field: TINE exception.
|
static int |
STATUS_FILE_UNMARSHAL_EXCEPTION
Constant file status field: Unmarshal exception.
|
static int |
TIME_SLICE_SET_GUI_FRAMETITLE
Time slice after initializing the application and setting the frame title
to the appropriated one.
|
static java.lang.String |
TINE_APPLICATION_NAME
TINE application name.
|
static java.lang.String |
TINE_CDI_MATCH
The string for preliminary TINE address must match the following string
value if it is a CDI call.
|
static int |
TINE_LENGHT_OF_DEVICENAME
The length of the TINE device name.
|
static int |
TINE_WAIT_CAVITY_SWITCH
This is the waiting time between the sending of the current slider
value.
|
static int |
TOOL_TIP_DISPLAYED_IN_MS
The delay time for showing tool tips on screen in milliseconds.
|
static java.lang.String |
UNDEFINED
For undefined values.
|
static java.lang.String |
UNDEFINED_TOOLTIP
For undefined values, tool tip text
|
static java.lang.String |
VALID_EMAIL
Verifies if the string values is a valid e-mail address.
|
static java.lang.String |
VERSION
The version number of this release.
|
Modifier | Constructor and Description |
---|---|
protected |
CGeneralConstant(boolean isCDIWriteArmed_,
boolean isTINEWriteArmed_,
boolean isEventWriteArmed_,
int loopCDIArguments_,
boolean isDebug_,
boolean isDebugGraphic_,
java.util.Set<java.lang.Integer> tineIgnoreError_)
This protected constructor sets all write values as boolean if they
are performed (
true ) or not (false ). |
Modifier and Type | Method and Description |
---|---|
static boolean |
ignoreTINEError(int errorCode_)
In the property file you can also define a list of TINE error codes,
each separated with a comma, which this application will ignore and never
report them on console or in a log file.
|
static boolean |
isDebug(EDebug debug_)
Returns the debug value of the corresponding enumeration instance
as a
boolean instance. |
static boolean |
isWriteArmed(EServer server_)
This static method returns on the delivered enumeration of the server
the corresponding write action.
|
static int |
loopCDIArguments()
Returns the loop value for getting CDI arguments.
|
public static final java.lang.String CLAZZ
public static final java.lang.String VERSION
public static final java.lang.String APPLICATION_NAME
public static final java.lang.String DEVELOPER
public static final java.lang.String AUTHOR
public static final java.lang.String PHONE
public static final java.lang.String GROUP
public static final java.lang.String BUILDING
public static final java.lang.String ROOM
public static final java.lang.String EMAIL
public static final java.lang.String MAILINGLIST
public static final java.lang.String RELEASE_DATE
public static final java.lang.String TINE_APPLICATION_NAME
public static final int TIME_SLICE_SET_GUI_FRAMETITLE
Time slice after initializing the application and setting the frame title to the appropriated one. This title includes beside the caption also the version number.
The CAM (Console Application Manager) will verify an ID from the application to identify it, where currently the title is taken. To be sure that the title is always the same, I set the real title only after a time slice.
public static javax.swing.Icon ICON_EMPTY_32x32
public static javax.swing.Icon ICON_EMPTY_16x16
public static javax.swing.Icon ICON_GREEN_CIRCLE_32x32
public static javax.swing.Icon ICON_GREEN_CIRCLE_16x16
public static javax.swing.Icon ICON_RED_CIRCLE_32x32
public static javax.swing.Icon ICON_RED_CIRCLE_16x16
public static javax.swing.Icon ICON_YELLOW_CIRCLE_32x32
public static javax.swing.Icon ICON_YELLOW_CIRCLE_16x16
public static javax.swing.Icon ICON_MAGENTA_CIRCLE_16x16
public static javax.swing.Icon ICON_MAGENTA_CIRCLE_32x32
public static javax.swing.Icon ICON_ANIMATE_ERRORMESSAGE_32x32
public static javax.swing.Icon ICON_ANIMATE_ERRORMESSAGE_16x16
public static javax.swing.Icon ICON_MESSAGE_QUESTION_32x32
public static javax.swing.Icon ICON_MESSAGE_INFORMATION_32x32
public static javax.swing.Icon ICON_MESSAGE_WARNING_32x32
public static javax.swing.Icon ICON_MESSAGE_ERROR_32x32
public static javax.swing.Icon ICON_MESSAGE_FATAL_32x32
public static final int STATUS_FILE_SUCCESS
public static final int STATUS_FILE_RUNTIME_EXCEPTION
public static final int STATUS_FILE_IO_EXCEPTION
public static final int STATUS_FILE_UNMARSHAL_EXCEPTION
public static final int STATUS_FILE_MARSHAL_EXCEPTION
public static final int STATUS_FILE_JAXB_EXCEPTION
public static final int STATUS_FILE_TINE_EXCEPTION
public static final int STATUS_FILE_NOT_OPERATING_WARNING
public static final int STATUS_FILE_LOAD_DEFAULT_WARNING
public static final int STATUS_FILE_INITIALIZE_WARNING
public static final java.util.Map<java.lang.Integer,java.lang.String> MAP_STATUS_FILE
public static final int ERROR_BASE
EErrorExt
.public static final int TINE_LENGHT_OF_DEVICENAME
protected static CGeneralConstant _thisConstant
public static final java.lang.String DESCRIPTION_RECV
public static final java.lang.String DESCRIPTION_SEND
public static final java.lang.String DESCRIPTION_CHANNEL
public static final java.lang.String ERROR_TINE
public static final java.lang.String ERROR_TINE_TITLE
public static final java.lang.String ERROR_RUNTIME
public static final java.lang.String ERROR_RUNTIME_TITLE
public static final int TINE_WAIT_CAVITY_SWITCH
public static final java.lang.String TINE_CDI_MATCH
The string for preliminary TINE address must match the following string value if it is a CDI call. The value of \\x2e is a dot (".") and \\x2d is a minus ("-").
More information can be found at here. The ASCII code table can be found here.
public static final java.lang.String VALID_EMAIL
Verifies if the string values is a valid e-mail address. The value of \\x2e is a dot (".") and \\x40 is the at-sign ("@").
More information can be found at here. The ASCII code table can be found here.
public static final java.lang.String PATTERN_CAVITY_PRECISION
Pattern for controlling the cavity numeric precision number or a character value. The number precision is of the following format: ^%(+|<space>)?\d?\d.\d)?[fg])$. The character string is of the following format: ^%\d?s$.
More information can be found at here. The ASCII code table can be found here.
public static final java.lang.String PATTERN_NUMBER_PRECISION
Normal number precision of floating point fields. The number is formated by the following format: %^((+|<space>)?\d?\d.\d)?[fg]$.
More information can be found on here. The ASCII code table can be found here.
public static final java.lang.String PATTERN_ERROR_KEY
Pattern for controlling the error key. The formated value is: \d?\d\d.\d\d(.\d)?$. This is NOT a precision value! x2E='.'
More information can be found at here. The ASCII code table can be found here.
public static final java.lang.String PATTERN_ERROR_VALUE
More information can be found on here. The ASCII code table can be found here.
public static final java.lang.String PATTERN_DEVICEGROUP_LINK1
Pattern for controlling the device group of a TINE link.
More information can be found on here. The ASCII code table can be found here.
public static final java.lang.String PATTERN_DEVICEGROUP_LINK2
Pattern for controlling the device group of a TINE link.
More information can be found on here. The ASCII code table can be found here.
public static final java.lang.String PATTERN_CONTROL_PRECISION
Pattern for controlling the control precision.
More information can be found on here.
public static final java.lang.String PATTERN_SWITCH_PRECISION
Pattern for controlling the switch precision.
More information can be found on here.
public static final java.lang.String PATTERN_DATA_PRECISION
The normal data element precision read from the CDI table.
More information can be found on here.
public static final java.lang.String PATTERN_IGNORE_ERROR
Pattern. Every string element which matches this pattern will be stored in a set. These set is afterwards take to control the TINE error code if it fits these set. If yes it will not report the error on the console or log file.
More information can be found on here.
public static final java.util.logging.Level LOG_LEVEL
de.desy.mst.libs.accelerator.logging
.public static final java.lang.String CLA_ENABLE_DEBUG_TICKER
true
(i.e. AppArguments.setNumber(CLA_ENABLE_DEBUG_TICKER, new DBoolean(true)))
or disables it by setting its argument to false
(i.e.
AppArguments.setNumber(CLA_ENABLE_DEBUG_TICKER, new DBoolean(false))).public static final java.lang.String CLA_MODE
public static final java.lang.String CLA_TAB
public static final java.lang.String CLA_ARMED1
public static final java.lang.String CLA_ARMED2
public static final java.lang.String CLA_LOG
public static final java.lang.String CLA_INITDELAY
public static final java.lang.String DEBUG_DEBUG
public static final java.lang.String DEBUG_INFO
public static final java.lang.String DEBUG_WARN
public static final java.lang.String DEBUG_ERROR
public static final java.lang.String DEBUG_FATAL
public static final java.lang.String APPLICATION_PASSWORD
public static final java.lang.String ERROR
public static final java.lang.String ERROR_TOOLTIP
public static final java.lang.String UNDEFINED
public static final java.lang.String UNDEFINED_TOOLTIP
public static final java.lang.String NEAR_OPERATE_ACTIVE
public static final int TOOL_TIP_DISPLAYED_IN_MS
protected CGeneralConstant(boolean isCDIWriteArmed_, boolean isTINEWriteArmed_, boolean isEventWriteArmed_, int loopCDIArguments_, boolean isDebug_, boolean isDebugGraphic_, java.util.Set<java.lang.Integer> tineIgnoreError_)
true
) or not (false
).isCDIWriteArmed_
- Is the write action on the CDI server.isTINEWriteArmed_
- Is the write action on the TINE server.isEventWriteArmed_
- Is the write action on the EVENT ARCVIVE
server.loopCDIArguments_
- Is the loop value for getting CDI arguments.
These value can be from 1 up to 3. If the value is not between
these values it will be set to 3.isDebug_
- Is the normal debug value as a boolean
.isDebugGraphic_
- Draws a red border around the component if this
value is set.tineIgnoreError_
- Is a set of errors which the application will
ignore on reporting it. This should never be null
!public static final boolean isWriteArmed(EServer server_)
server_
- Is the enumeration of the server. If the server doesn't
exist a EnumerationNotUsedException
is thrown.public static final boolean isDebug(EDebug debug_)
boolean
instance.debug_
- Is the debug enumeration. This shows which things you
wanted to debug (normal or graphical).boolean
debug value.public static final int loopCDIArguments()
LOOP_CDI_ARGUMENTS
.public static final boolean ignoreTINEError(int errorCode_)
errorCode_
- Is the TINE error code.true
if the error code exists otherwise
a false
is returned.14-September-2016 18:23 Deutsches Elektronen-Synchrotron DESY in der Helmholtz-Gemeinschaft