The QTPlgDataCarrier class is an abstract class that defines properties, methods and events constituting the bulk of a data transfer service provided by the QTPlugin.
Worth of note is that you can use QTPlgDataCarrier class instances directly from the Realbasic GUI.
The class has not constructor at all (you can always use the Realbasic common constructor syntax, of course, but you will obtain an usless object). Its destructor, will be implicitly invoked every time one of its derived classes will be destroyed.
specifies the location of data;
if not otherwise stated, you can use objects that specify
only
specifies if the class instance is performing an asynchronous task
enables or disables the automatic idling of data during an asynchronous transfer process. If this property is set to true, then you do not need anymore to use a Timer control to
call repeatedly the method
while playing data. The internal timer interval is set up to the value of the
class property. This property can be modified only if there is no asynchronous data transfer in progress (that is the
property is false)
return the status of the currently running process (if any). This property returns one of the
defined by the class
specifies the total amount of data, expressed in bytes, that have to be transferred
specifies how many bytes have been already copied during an asynchronous copy
indicates how far the transfer has progressed. Its value ranges between
0.0 and 1.0
specifies the interval (in milliseconds) at which the currently asynchronous running process
()
an asynchronous transfer of data has successfully begun. You should launch a timer process to ensure processing time to the
running process here
(percentDone as double)
displays the percent amount of transferred data. The value returned here is the same you can obtain by inspecting the
property. Also, you can use the
and
class properties to provide more details about the
currently running process
(err as integer)
an error has occurred during the transfer of data and the process failed. This being the case, the target storage of the transferred data
is deleted
()
the transfer of data has completed successfully or the client application has aborted it. In the latter case the target storage of
the transferred data is deleted
()
use this method to begin an asynchronous transfer of data. If the preparation of the resources required to the transfer completes
successfully, this method fires the event; otherwise
a event is fired
()
by this method you ensure processing time to the currently asynchronous running process, if any; otherwise this method has no
effect. If the tranfser of data is running without errors a
event is sent to the client application, otherwise a
event is sent. If the
property is true, you do not need to call this method
()
use this method to kill the currently asynchronous running process, if any, and delete the target data storage
created by the process; otherwise this method has no effect. If this method completes successfully, a
event is fired
an error has occurred during the trasfer of data
the class is not processing any data
the preliminaries required by an asynchronous transfer of data have been completed successfully and the transfer is up to begin
an asynchronous transfer of data is in progress
the transfer is finished successfully