class FileClient
Package: swiss.avm.up.core.config.br.loggerconfig.javamodel.FileClient
Direct Known Subclasses: FileClientBaseLog, FileClientDataLog, FileClientMessageLog, AFileClientStateLog
abstract class FileClient extends LogFileConfig
Properties
comment
Describes the intent of this Resource.
TextLiteral[0..1]
A Literal that accepts multiple lines of text.
fileClientName
StringLiteral[0..1]
fileCreateCondition
0 -> no condition, 1 -> create file when data received
IntegerLiteral[1..1]
A literal which accepts 32-bit integral number values.
logfilePath
subdirectory for saving the logfiles
StringLiteral[1..1]
logfilePrefix
base name that is extended by date
StringLiteral[0..1]
logfileTimeStamp
Defines the formatting of the file timestamp. Make sure that the file timestamp is unique in the log period.
Time/date formatting:
%a Short name of the weekday - Sun
%A Weekday name - Sunday
%b Short name of the month - Mar
%B Month name - March
%c Date and time display - Sun Aug 19 02:56: 02 2012
%d Day of the month (01-31) - 19
%f Milliseconds (0-999) - 657
%H Hour in 24h format (00-23) - 14
%I Hour in 12h format (01-12) - 05
%m Month as decimal number (01-12) - 08
%M Minute (00-59) - 55
%p AM or PM Name - PM
%S Second (00-61) - 02
%w Day of the week as decimal number with Sunday as 0 (0-6) - 4
%x Date representation - 08/19/12
%X Time representation - 02: 50:06
%y Year, last two digits (00-99) - 01
%Y Year - 2020
%% The % character - %
If nothing is set, the default (%Y%m%d_%H%M%S) is used.
StringLiteral[0..1]
maxEntriesInFile
max. nr of entries in one logfile. If nr of values is bigger than this value, a new logfile will be created. If the value is 0, there is no action
IntegerLiteral[1..1]
A literal which accepts 32-bit integral number values.
maxFileSize
[MB] max size of one logfile. Is size of logffile bigger than this value, a new logfile will be generated. If this value is 0, the property has no action
DoubleLiteral[1..1]
A literal that accepts numbers with fractions.
maxLogFiles
maximal nr of logfiles which are created from file client (p.e. after reboot)
IntegerLiteral[1..1]
A literal which accepts 32-bit integral number values.
maxTimeToWrite
[s] file write cycle - max time in s, until from temp. buffer is written to the file
IntegerLiteral[1..1]
A literal which accepts 32-bit integral number values.
name
The name of this Resource.
StringLiteral[1..1]
newFileOnRestart
0 - write in current file further on by restart, 1 - write in new file by restart
IntegerLiteral[1..1]
A literal which accepts 32-bit integral number values.
queueLen
base log queue length
IntegerLiteral[1..1]
A literal which accepts 32-bit integral number values.
Method Summary
getLogFileExtension
Return:
StringLiteral
getName
@ConfigCommonFunctions
getTemplate
Return:
AFileClientTemplate
indexOf
@TemplateFunction
Return:
IntegerLiteral