Instance.hpp 5.74 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/*
 * Copyright (C) 2014-2021 DBIS Group - TU Ilmenau, All Rights Reserved.
 *
 * This file is part of the PipeFabric package.
 *
 * PipeFabric is free software: you can redistribute it and/or modify it under the terms of the GNU
 * General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * PipeFabric is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with PipeFabric. If not,
 * see <http://www.gnu.org/licenses/>.
 */

aliahmadbutt4's avatar
aliahmadbutt4 committed
18

Kai-Uwe Sattler's avatar
Kai-Uwe Sattler committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
#ifndef Instance_hpp_
#define Instance_hpp_
#include <iostream>
#include <boost/atomic.hpp>
#include <boost/intrusive_ptr.hpp>
#include <boost/detail/quick_allocator.hpp>
#include "boost/date_time/posix_time/posix_time.hpp"

#include "core/Tuple.hpp"

using namespace boost::posix_time;
namespace pfabric {
/**
 * @brief An Instance class which presents the  CEP event to be stored in the system and outputted later
 * Hence, this class will add the state name (when this event matches a particular state in the NFA ) and the event sequence to the original tuple
 * Sequence is necessary to mark the order of this event in the complex event.
 */
//class Instance;
37
template<class TinPtr, class ToutPtr>
Kai-Uwe Sattler's avatar
Kai-Uwe Sattler committed
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class Instance {
	typedef pfabric::Tuple<std::string, int> FooterTuple;
	typedef boost::intrusive_ptr<FooterTuple> FooterTuplePtr;
private:
	/**
	 * Reference counter for intrusive pointer as a means for coordinating multiple threads
	 *
	 */
	mutable boost::atomic<int> refCount;
	/**
	 * The state name in which original event matches a particular state
	 */
	std::string state;
	/**
	 * Instance sequence in complex event necessary for repetition state
	 */
	int sequenceInComplex;
	/**
	 * The original tuple(event) to be stored
	 */
	TinPtr originalEvent;

public:

62
	typedef boost::intrusive_ptr<Instance<TinPtr, ToutPtr>> InstancePtr;
Kai-Uwe Sattler's avatar
Kai-Uwe Sattler committed
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
	/**
	 * A constructor: receive the original CEP event and map it to an instance
	 * @param event the original CEP event
	 */
	Instance(TinPtr event) :
			refCount(0) {
		assert(event);
		this->originalEvent = event;
		this->state = "";
		this->sequenceInComplex = 0;
	}
	/**
	 * Virtual destructor
	 */
	virtual ~Instance() {
	}
	/**
	 * Get the original tuple (event) from this instance
	 * @return as above
	 */
	TinPtr getOriginalEvent() const {
		return this->originalEvent;
	}
	/**
	 * Set the original tuple (event) for this instance
	 * @param as above
	 */
	void setOriginalEvent(TinPtr originalEvent) {
		this->originalEvent = originalEvent;
	}
	/**
	 * Set the sequence of this event in the complex event
	 * @return as above
	 */
	int getSequenceInComplex() const {
		return this->sequenceInComplex;
	}
	/**
	 * Set the sequence of this event in the complex event
	 * @param as above
	 *
	 */
	void setSequenceInComplex(int sequenceInComplex) {
		this->sequenceInComplex = sequenceInComplex;
	}
	/**
	 * Get the state name where this the original event matches a particular state
	 * @return the state name
	 */
	std::string getState() const {
		return this->state;
	}
	/**
	 * Set the name
	 * @param state the state name
	 */
	void setState(std::string state) {
		this->state = state;
	}
	/**
	 * Convert this Instance to a normal tuple for further processing since PipeFabric deals with tuples
	 * not events.
	 * @return tuple construction
	 */
127
	TinPtr convertInstanceToTuple() {
Kai-Uwe Sattler's avatar
Kai-Uwe Sattler committed
128
129
130
131
132
		/**
		 * A tuple contains the sate name and the sequence should be combined with the original
		 * event data. The timestamp of this instance is the timestamp of the original event
		 */
		FooterTuplePtr foot = makeTuplePtr(state, sequenceInComplex);
133
134
135
136
		//ToutPtr res(
			//	new Tout(std::tuple_cat(originalEvent->data(), foot->data())));
		//res->setTimestamp(originalEvent->getTimestamp());
		return originalEvent;
Kai-Uwe Sattler's avatar
Kai-Uwe Sattler committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
	}

	/**
	 * get the timestamp for this Instance, it is equal to  the timestamp of the original tuple
	 * timestamp
	 * @retun as above
	 */
	Timestamp getInstanceTimestamp() {
		return this->originalEvent->getTimestamp();
	}

	/**
	 * Output member variable information.
	 * @param os the output stream handle.
	 */
aliahmadbutt4's avatar
aliahmadbutt4 committed
152
	void print(std::ostream& os = std::cout) {
Kai-Uwe Sattler's avatar
Kai-Uwe Sattler committed
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
		os << "[ " << this->sequenceInComplex << "," << this->state << " ,";
		//this->originalEvent->print(os);
		os << " ]\n";
	}

	/**
	 * The total size of this instance (the size of original tuple + 2);
	 * retrun as above
	 */
	int size() {
		return originalEvent->size() + 2;
	}

	/**
	 * Get the timestamp for this Instance as ptime, it is equal to original tuple
	 * timestamp
	 * @return as above
	 */
	ptime getInstanceTimestampAsPtime();
//	friend void intrusive_ptr_add_ref(Instance * p) {
//		p->ref_count++;
//	}
//	friend void intrusive_ptr_release(Instance * p) {
//		if (--p->ref_count == 0) {
//			delete p;
//		}
//	}
	/**
	 * The intrusive_ptr class stores a pointer to an object with
	 * an embedded reference count (refCount).
	 * This function increments the reference count by one
	 *
	 */
	friend void intrusive_ptr_add_ref(const Instance *x) {
		x->refCount.fetch_add(1, boost::memory_order_relaxed);
	}
	/**
	 *  This function is responsible for destroying the instance object
	 *  when its reference count reaches zero
	 */
	friend void intrusive_ptr_release(const Instance *x) {
		if (x->refCount.fetch_sub(1, boost::memory_order_release) == 1) {
			boost::atomic_thread_fence(boost::memory_order_acquire);
			delete x;
		}
	}
};

} /* namespace pfabric */
#endif /* Instance_hpp_ */