org.vishia.gral.base

Class GralGraphicOrder

java.lang.Object

org.vishia.gral.base.GralGraphicOrder

Direct Known Subclasses:

GralWidgetBase.TimeOrderCreateImplWidget

public abstract class GralGraphicOrder
extends java.lang.Object

This is the base class for user classes, which contains code, that should be executed in the graphic thread.
This class is both, an EventConsumer to EventConsumer#processEvent(EventObject) for the graphic (the first task) as also contains the data for the graphic event by implementation of Payload.

• In this manner the activator of the event can store some data for event execution in the order,
• then send the event to the graphic thread, the event refers this as payload.
• then process the event exact with the same instance.

The instance of this class contains the TimeOrder which is necessary for the management of the execution time using the GralMng as org.vishia.event.EventTimerThread. The time order facility can be used to send the event not immediately but with delay, so that a renew of the order can be done if the time is not yet elapsed.
That are all necessities for a graphic oder.
Because this class inherits from EventConsumer the operation EventConsumer#processEvent(EventObject) need to be overridden in the inherit class.. Whereby the argument event is type of the overridden type itself. Hence it is not necessary to evaluate, it is this itself. The 'processEvent(...)' does the necessary work.

The event instance itself of type 'EventWithDst', see EventWithDst. is also referenced as composite here, hence any possible order has its specific event. It is used and activated if the source of the event becomes active.

Because the event is used on the same device between threads, communication via a serial line is not necessary. Hence the Payload#serialize() and ~deserialize() are dummy implementations.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) <any>	ev
(package private) GralMng	gralMng
(package private) java.lang.String	sInfo
(package private) TimeOrder	timeOrder
static java.lang.String	version Version and history.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GralGraphicOrder(java.lang.String name, GralMng gralMng) Super constructor for all graphic time orders.

Method Summary

Modifier and Type	Method and Description
GralGraphicOrder	clean()
boolean	deserialize(byte[] data)
EventThread_ifc	evThread()
byte[]	serialize()
void	setStackInfo() Set the info from where the call comes (on calling this operation):
java.lang.String	srcInfo() Used for debugging and messaging: gets an information from where the order was created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

public static final java.lang.String version

Version and history.

• 2023-07-24 Hartmut correct concept of 2023-02-01: Because now EventConsumerAwait needs a Payload derived from org.vishia.event.PayloadBack and this is as first type argument the GralGraphicOrder itself, the formally refactoring was not possible (two extends will be necessary, from GralGraphicOrder extends PayloadBack extends EventConsumerAwait). But it is substantial a false concept, because this class is not a consumer of a callback event, it is a consumer of a forwarded command event. The EventConsumerAwait#awaitExecution(long, boolean) was never used also.
  It was a slightly refactoring to implement a simple EventConsumer instead the EventConsumerAwait for all stuff.
• 2023-02-21 Hartmut chg renamed from GralGraphicEventTimeOrder and changed of concept. This order refers now the event, it is not an event. This was also done because deviation from EventConsumerAwait for #awaitExecution(long) as essential operation. All is adapted and runs.
• 2023-02-12 Hartmut new setStackInfo() and sInfo possible as information from the event producer to the event dst to inform from where and why comes the event proper usable to search and improve in software.
• 2023-02-08 Hartmut now because the GralMng is also the org.vishia.event.EventTimerThread the operation EnqueueInGraphicThread is no more necessary. The event can immediately executed in the graphic thread.
• 2015-01-10 Hartmut renamed from GralDispatchCallbackWorker
• 2012-02-14 Hartmut corr: #addToGraphicThread(GralGraphicThread, int): For time saving: If an instance is added already and its new execution time is up to 5 ms later, nothing is done. It saves time for more as one call of this routine in a fast loop.
• 2012-02-14 Hartmut corr: It was happen that an instance was designated with #bAdded==true but it wasn't added, Therefore on #addToGraphicThread(GralGraphicThread, int) it is removed from list and added newly. It is more save.
• 2012-01-26 Hartmut chg: rename removeFromGraphicThread(GralGraphicThread) to #removeFromQueue(GralGraphicThread). It is a better naming because it is removed from the queue in the graphic thread. This class is only used in that queue.
• 2012-01-15 Hartmut new: #name to identify, proper for debugging
• 2012-01-08 Hartmut new: #addToGraphicThread(GralGraphicThread, int) and #removeFromQueue(GralGraphicThread) as thread-safe functions which marks the instance as added (for delayed execution, for re-using).
• 2011-02-21 Hartmut created.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are indent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

gralMng

final GralMng gralMng

sInfo

java.lang.String sInfo

ev

final <any> ev

timeOrder

final TimeOrder timeOrder

Constructor Detail

GralGraphicOrder

protected GralGraphicOrder(java.lang.String name,
                           GralMng gralMng)

Super constructor for all graphic time orders. Usual a anonymous class is used for the instance:

  private final GralGraphicTimeOrder repaintRequ = new GralGraphicTimeOrder("GralWidget.repaintRequ"){
    QOverride public void executeOrder() {
      repaintGthread();
    }
    QOverride public String toString(){ return name + ":" + GralWidget.this.name; }
  };
 

Parameters:

name - The name is only used for showing in debugging.

Method Detail

setStackInfo

public void setStackInfo()

Set the info from where the call comes (on calling this operation):

srcInfo

public java.lang.String srcInfo()

Used for debugging and messaging: gets an information from where the order was created.

Returns:

evThread

public EventThread_ifc evThread()

clean

public GralGraphicOrder clean()

serialize

public byte[] serialize()

deserialize

public boolean deserialize(byte[] data)