|
Stage command API |
Pipelines v2.1 |
|
This Application Programming
Interface is intended to provide a mechanism which will allow you to create a
new user stage command to augment
the current builtin stage set. The
API contains; an MS Visual Studio VC++ 9.0 wizard; which creates a fully
functional skeletal stage; which reads records from its primary input stream
and writes records to its primary output stream. And a set of stage command
classes that provide stage initialisation extraction routines, a console
class which provides synchronised screen output and a number of stage command
functions which support your stage during its runtime phase. |
Home |
|
Classes |
The following table lists the
documents which describe each of the stage command API classes that are
provided by Pipelines. Throughout this API documentation; references may be
made to the phrase stage command, stage command class, stage command class object and class object; however, these terms are
used interchangeably and are intended to represent the same entity.
|
Class |
In support of stage.. |
Description |
|
|
|
|
CApplMessage |
Initialisation and runtime |
A console class; providing synchronised screen output. |
CCharRange |
Initialisation |
A
character range extraction class. |
CCharString |
Initialisation |
A character string extraction class. |
CExtractRange |
Runtime |
A
column, word or field range extraction class. |
CDblString |
Initialisation |
A double string extraction class. |
CIntRange |
Initialisation |
An
integer range extraction class. |
CIntString |
Initialisation |
An integer string extraction class. |
CProcess |
Runtime |
The
base class of your stage. |
CRegExpression |
Initialisation |
A class used to parse and evaluate a stage command regular
expression. |
CRexx |
Runtime |
A
class used to manipulate ooRexx variables, stems and arrays. |
CStage |
Initialisation and runtime |
Your stage. |
CStageInitInfo |
Initialisation |
A
class which is used to communicate with the CStageManager; during your
stages' initialisation phase. |
CManager |
Initialisation and runtime |
The StageManager which launched your stage. |
CStream |
Initialisation
and runtime |
Your
stages' input and output streams. |
CToken |
Initialisation |
A simple token or delimited phrase extraction class. |
|
Notes |
I would be very interested
to hear from anyone who has intensions to develop, or indeed anyone who has
developed a new stage command. I would be delighted to include any new stage
command in a further release of Pipelines. However, at this stage in the
project; you would need to send me the source code; so that I can make sure
that it builds correctly against future CStageManager enhancements. I would of
course respect the intellectual property rights of your development and this
would be detailed in a collaborative list of contributors' document and in the
property page of your stage DLL.
If however, you would
like to develop new Stage command(s) for your own personal use/needs and you
would prefer not to send me the source; then that's fine. But you will need to make
sure that you re-build your stage against every future release of Pipelines; as
I continually make changes and improvements to the CStageManager – the central
input/output stream service mechanism.
If you have any
questions relating to this API, or about developing a stage command; please
contact me: tenfiftytwo.
|
|