summaryrefslogtreecommitdiff
path: root/common/OpString.idl
blob: d2260ce5150171bb8c6e5486a6b87fa8ddb1c396 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
#ifndef OPERATIONAL_STRING_IDL
#define OPERATIONAL_STRING_IDL

#include "DAnCE/Deployment/Deployment_DeploymentPlan.idl"
#include "QoS.idl"
#include "Time.idl"
#include "Goal.idl"


module CIAO
{
  module RACE
    {

      // A task instance in an opstring.
      struct InstanceDescription
      {
        // Universally unique ID of the instance.
        string UUID;

        // Human-readable name (for debugging, not identification).
        string name;

        // Node to which instance is deployed.
        string node;


        // Reference to the concrete implementation used by this instance -
        // index into the Deployment::MonolithicDeploymentDescriptions of
        // the operational string that implements this instance.
        unsigned long implementationRef;

        // ID of task performed by instance (in Task Network).
        string taskId;

        // Supported type ID of task (in Repository Manager).
        string taskTypeId;

        // Specific type ID of suggested component (in Repository Manager).
        string suggestedImpl;

        // Initial values of component configuration parameters.
        ::Deployment::Properties configProperty;

        // Expected time range of instance start.
        TimeWindow startWindow;

        // Expected time range of instance finish.
        TimeWindow endWindow;
      };

      typedef sequence <InstanceDescription> InstanceDescriptions;

      typedef ::Deployment::PlanConnectionDescriptions DataLinkDescriptions;

      // Type of an ordering link in opstring (data links handled separately).
      // CAUSAL: causal link; must be obeyed for correct functionality.
      // SCHEDULING: scheduling link introduced during scheduling to prevent
      //             potential resource violations; can be ignored if
      //             additional scheduling is done.
      // THREAT: threat link, introduced to avoid a causal link threat;
      //         must be obeyed for correct functionality.
      enum ConnectionType
      {
        CAUSAL,
        SCHEDULING,
        THREAT
      };

      // A link specifying an ordering between two instances (the endpoints).
      struct OrderLinkDescription
      {
        // Human-readable name (for debugging, not identification).
        string name;

        // Type of link.
        ConnectionType type;

        // Identifies ports of task instances external to this operational
        // string as an endpoint of this link.
        ::Deployment::ComponentExternalPortEndpoints externalEndpoint;

        // Identifies ports of task instances within this operational
        // string as an endpoint of this link.
        ::Deployment::PlanSubcomponentPortEndpoints internalEndpoint;

        // Identifies a location outside the operational string as an
        // endpoint of the link.
        ::Deployment::ExternalReferenceEndpoints externalReference;

      };

      typedef sequence <OrderLinkDescription> OrderLinkDescriptions;

      // Operational String.
      struct OperationalString
      {
        // Universally unique ID of opstring.
        // (Should correspond to goal UUID).
        string UUID;

        // Human-readable name (for debugging, not identification).
        string label;

        // Goal achieved by this opstring.
        GoalStructure goal;

        // Task instances in opstring.
        InstanceDescriptions instance;

        // Data links (between task instances) in opstring.
        DataLinkDescriptions dataLink;

        // Ordering links (between task instances) in opstring.
        OrderLinkDescriptions orderLink;

        // Priority of this opstring.
        // (Should be derived from expected utility of goal).
        long priority;

        // QoS requirements.
        QoSSpecifications QoSRequirement;

        // Expected time range for start of opstring execution.
        TimeWindow startWindow;

        // Expected time range for end of opstring execution.
        TimeWindow endWindow;

        // Properties for deployment of opstring.
        ::Deployment::Properties infoProperty;

        // Component implementations used in this opstring.
        ::Deployment::MonolithicDeploymentDescriptions implementation;

        // Implementation artifacts related to this opstring.
        ::Deployment::ArtifactDeploymentDescriptions artifact;

      };

  };
};

#endif /* OPERATIONAL_STRING_IDL */