Bug 1680: Automatic checkin of merge of branch MAC-20110530-1_0-release-branch svn-18437 - svn-18473) in trunk

Bug 1680: Automatic checkin of merge of branch MAC-20110530-1_0-release-branch svn-18345 - svn-18361) in trunk

Bug 1680: Automatic checkin of merge of branch MAC-20110418-1_0-release-branch svn-17889 - svn-18014) in trunk

 + ParentControl: better handling of out of band QUIT events.
 + BeamServer: better handling of timer-events during substates
 + StationControl: better handling of QUIT events.
 + ObservationControl:
   * Parameter 'reportType' = Full|Changes for managing reports during heartbeat
   * Parameter heartbeatInterval moved from SAS to config file
   * Nices reporting of child-states.
 + deleteTree: also clear VICkvt table when a tree is deleted.

+ Update to PythonControl to allow clients that can not communicate.
+ Added 'result' field to CONTROL_CONNECT message to pass failures.
+ Fixed stopping garbagecontroller timer in ChildControl
+ Fixed emergency stop timer in ParentControl
+ ObservationControl reports more detailed how an observation ends.

Bug 1680: Automatic checkin of merge of branch MAC-20110418-1_0-release-branch (svn-17856 - svn-17871) in trunk

Bug 1607: Checkin of merge of branch MAC-20101206-1_0-release-branch (svn-17633 - svn-17649) in trunk after resolving conflicts with ParentControl.cc and ControllerDefines.cc

later when registerTask was called..

Bug 1000: Introduced a TestTask that makes it easier to test the behaviour of a GCFTask. See headerfile for usage.

Moved Protocol numbers to MACIO/Protocodefs.h

Made a ControllerProtMenu that allows you to send CONTROL events to a simple TCPport. Works without the ChildController task.

Bug 1000: Observation will be aborted in a nice way when the process is killed with -6 (-s SIGABRT).

result, all GNU Autotools related files have now also been removed from the
trunk. 

Bug 1448: Fixed remaining MAC sources, so that they also compile with the new package-version structure

easy access to a package's source/binary directory. This is now
handled by lofar_add_package().

- New lofar_package() macro replaces lofar_add_package(). The new macro
  supports recursive addition of LOFAR packages, using the dependencies passed
  as arguments. For example: 
    lofar_package(Blob 1.0 DEPENDS Common) 
  will add the package Common to the build (unless it was already added).
  This new features enables a "top-down" package specification order, which is
  required for building subsystems.

- New lofar_add_package() macro replaces lofar_add_subdirectory(). This macro
  uses a ${pkg}_SOURCE_DIR variable to locate the source directory of the
  package <pkg>. This information is needed, as we cannot simply include
  actual subdirectories anymore, because dependent package(s) might be located
  in a different directory tree.

- New file LofarPackageList.cmake, which sets the ${pkg}_SOURCE_DIR variables.
  This file is generated by a script gen_LofarPackageList_cmake.sh, which must
  be rerun when LOFAR packages are added, moved, or removed.

Bug 1284: The availability of the receivers is only known at the stations, so this info is moved from
'Observation' to 'StnObservation' in PVSS.
When the scripts in PVSS are updated the code in the ObsClaimer.cc should be removed.

Fixed some small issues.

Some major changes are made in GCF/TM:
 1) GCFScheduler replaces all global GCFTask functions and variables.
 2) An event-queue is introduced
 3) Return value NEXT_STATE is added
 4) The function autoOpen is added to TCP ports
 5) 'fast' mode available for low level drivers.

Ad. 1
The GCFTask class had a lot of global functions and variables that were 
not bound to one task but were multi-task items. All these things are 
moved to a new class GCFScheduler. This class is a singleton class.
Consequence of this is that 'init', 'run' and 'stop' are not longer 
connected to the GCFTask class but are now part of the Scheduler.

old code:
	GCFTask::init(argc, argv, argv[0]);

	myTask	a("a");
	myTasl	b("b");
	a.start();
	b.start();

	GCFTask::run();

new code:
	GCFScheduler::instance()->init(argc, argv, argv[0]);

	myTask	a("a");
	myTasl	b("b");
	a.start();
	b.start();

	GCFScheduler::instance()->run();

In the same the stop function should be called with GCFScheduler::instance()->stop();


Ad. 2
The events are now stored in a queue before they are passed to the tasks. 
This has two benefits:
 - The code does not have to be re-entrant anymore because TRAN drops the 
   F_EXIT and F_ENTRY in the queue in stead of executing them during the TRAN-line.
 - The values for GCFEvent::TResult you return DO MATTER NOW. See Ad 3.

The disadvantage of the queue is that the scheduler has to make a copy of 
the event before placing it in the queue. To avoid needless copies all events
that are NO framework events (F_FSM_PROTOCOL and F_PORT_PROTOCOL) are passed 
immediately to the task. When the task returns HANDLED we save ourselves the 
effort of a copy. When anything else is returned the event is treated accordingly. See Ad 3.


Ad. 3
Since there is a queue now, the value returned by the task matters:
HANDLED: event is removed from the queue.
NEXT_STATE: event is parked on the queue until the task changes state with TRAN(...). 
After the F_ENTRY event all events that were parked with NEXT_STATE are passed 
to the task again.
NOT_HANDLED: this value will become OBSOLETE since it doesn't tell the scheduler 
what to do. FOR NOW the event will be destroyed.

Remark: In the future the return values may be extended with values like 
HOLD_x_SEC or HOLD_x_EVENTS.


Ad. 4
To simplify opening or reopening a port the function autoOpen is added to TCPPorts.
syntax: autoOpen(nrRetries, maxTimeout, reconnectInterval)

This function does several retries to setup the connection. The user can choose 
the use the nrRetries and reconnectInterval arguments or use the maxTimeout 
(and reconnectinterval) arguments:
  nrRetries        : -1 = infinite ; How often to retry the open when it fails.
  reconnectInterval: After how many seconds after a fail a reconnect attempt will be made.
  timeout          : -1 = infinite ; How long the auto-open attempts may last.

When both nrRetries and timeout are specified the condition that will be met first will 
stop the auto open sequence.

When the connection is made an F_CONNECTED events is send like open() does. When the 
connection can not be made within the given limitations a F_DISCONNECTED is returned.

Note: autoOpen(0,0) acts the same as open()


Ad. 5
Lowlevel drivers like the RSPDriver which heavily lean on FSMs (several 100's)  may 
not be happy with the eventqueue because statetransitions are handled via the queue. 
These drivers can call 'disableQueue()' after calling GCFScheduler::instance()->init(..). 
The queue mechanisme is than completely bypassed and everything works like the 
old-situation again.


Internal notes:
The boolean that the open() function returned was not really straitforward defined 
and therefor not used anywhere (as far as I know). The value that is returned now is 
true when a CONNECT or DISCONNECT message in placed in the queue and false when the 
ServiceBrokerTask needs so more time to give a result.