Log formatter event, defines the object to format message string. More...

Inheritance diagram for app.LogFormatter.LogFormatterEvent:

Collaboration diagram for app.LogFormatter.LogFormatterEvent:

Public Member Functions
def	__init__ (self, event, objectsList, descriptionText)
	constructor initialize fields More...

def	__str__ (self)

Public Attributes
	event

	objects

	description

Static Public Attributes
string	OBJECT_DUMP_DELIMITER = "\n"

string	MESSAGE_PREFIX = ""

Detailed Description

Log formatter event, defines the object to format message string.

The LogFormatterEvent object used to create log message string representation according with special format.

Definition at line 16 of file LogFormatter.py.

Constructor & Destructor Documentation

◆ init()

def app.LogFormatter.LogFormatterEvent.__init__	(	self,
		event,
		objectsList,
		descriptionText
	)

constructor initialize fields

Parameters

event	Event object instance to dump itself and eventObj inside
objectsList	List of objects to dump

Definition at line 27 of file LogFormatter.py.

   def __init__(self, event, objectsList, descriptionText):
     self.event = event
     self.objects = objectsList
     self.description = descriptionText
 
 

Member Function Documentation

◆ str()

def app.LogFormatter.LogFormatterEvent.__str__ ( self )

Definition at line 33 of file LogFormatter.py.

   def __str__(self):
     ret = self.MESSAGE_PREFIX + str(vars(self.event))
 
     if self.event.eventObj and hasattr(self.event.eventObj, "__dict__"):
       ret = ret + self.OBJECT_DUMP_DELIMITER + str(vars(self.event.eventObj)) + self.OBJECT_DUMP_DELIMITER
       for obj in self.objects:
         ret = ret + self.OBJECT_DUMP_DELIMITER + str(vars(obj)) + self.OBJECT_DUMP_DELIMITER
 
     ret = ret + self.description + self.OBJECT_DUMP_DELIMITER
 
     return ret

Member Data Documentation

◆ description

app.LogFormatter.LogFormatterEvent.description

Definition at line 30 of file LogFormatter.py.

◆ event

app.LogFormatter.LogFormatterEvent.event

Definition at line 28 of file LogFormatter.py.

◆ MESSAGE_PREFIX

string app.LogFormatter.LogFormatterEvent.MESSAGE_PREFIX = ""

static

Definition at line 19 of file LogFormatter.py.

◆ OBJECT_DUMP_DELIMITER

string app.LogFormatter.LogFormatterEvent.OBJECT_DUMP_DELIMITER = "\n"

static

Definition at line 18 of file LogFormatter.py.

◆ objects

app.LogFormatter.LogFormatterEvent.objects

Definition at line 29 of file LogFormatter.py.

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

sources/hce/app/LogFormatter.py

Public Member Functions

Public Attributes

Static Public Attributes