You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by ms...@apache.org on 2019/05/10 13:43:36 UTC
[plc4x] 07/09: Nested Class Builder CMakelists with central import
of Boost
This is an automated email from the ASF dual-hosted git repository.
msommer pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
commit 2ab73c335e88f06bfdb765f6d83ce81774a5241f
Author: Markus Sommer <ms...@apache.org>
AuthorDate: Fri May 10 15:30:19 2019 +0200
Nested Class Builder
CMakelists with central import of Boost
---
plc4cpp/protocols/driver-bases/base/CMakeLists.txt | 7 +-
.../cpp/base/connection/AbstractPlcConnection.cpp | 31 ++++-
.../cpp/base/connection/AbstractPlcConnection.h | 5 +-
.../plc4x/cpp/base/connection/PlcFieldHandler.h | 2 +-
.../cpp/base/messages/DefaultPlcReadRequest.cpp | 100 +++++++++-------
.../cpp/base/messages/DefaultPlcReadRequest.h | 35 ++++--
.../cpp/base/messages/DefaultPlcWriteRequest.cpp | 127 ++++++++++-----------
.../cpp/base/messages/DefaultPlcWriteRequest.h | 11 +-
.../cpp/base/messages/InternalPlcFieldRequest.h | 2 +-
9 files changed, 194 insertions(+), 126 deletions(-)
diff --git a/plc4cpp/protocols/driver-bases/base/CMakeLists.txt b/plc4cpp/protocols/driver-bases/base/CMakeLists.txt
index e3157a7..3c5d607 100644
--- a/plc4cpp/protocols/driver-bases/base/CMakeLists.txt
+++ b/plc4cpp/protocols/driver-bases/base/CMakeLists.txt
@@ -22,7 +22,9 @@ set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)
-add_library(plc4cpp-protocols-driver-base-base src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.cpp
+add_library(plc4cpp-protocols-driver-base-base
+ src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.cpp
+ #src/main/cpp/org/apache/plc4x/cpp/base/connection/BoostConnection.cpp
src/main/cpp/org/apache/plc4x/cpp/base/connection/ChannelFactory.cpp
src/main/cpp/org/apache/plc4x/cpp/base/connection/DefaultPlcFieldHandler.cpp
src/main/cpp/org/apache/plc4x/cpp/base/connection/PlcFieldHandler.cpp
@@ -63,3 +65,6 @@ add_library(plc4cpp-protocols-driver-base-base src/main/cpp/org/apache/plc4x/cpp
Import the headers for boost and the plc4cpp-api module
]]
target_include_directories (plc4cpp-protocols-driver-base-base PUBLIC target/dependencies/include)
+target_include_directories (plc4cpp-protocols-driver-base-base PUBLIC ${Boost_INCLUDE_DIRS})
+target_include_directories (plc4cpp-protocols-driver-base-base PUBLIC ../../../api/src/main/cpp)
+target_include_directories (plc4cpp-protocols-driver-base-base PUBLIC ../../../utils/logger/src/main/cpp)
diff --git a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.cpp b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.cpp
index af47faa..6a6eab0 100644
--- a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.cpp
+++ b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.cpp
@@ -18,6 +18,7 @@ under the License.
*/
#include "AbstractPlcConnection.h"
+#include <org/apache/plc4x/cpp/api/exceptions/PlcUnsupportedOperationException.h>
namespace org
{
@@ -31,9 +32,11 @@ namespace org
{
namespace connection
{
- PlcConnectionMetadata& AbstractPlcConnection::getMetadata()
+ using namespace org::apache::plc4x::cpp::api::exceptions;
+
+ PlcConnectionMetadata* AbstractPlcConnection::getMetadata()
{
- return *this;
+ return this;
}
bool AbstractPlcConnection::canRead()
{
@@ -47,6 +50,30 @@ namespace org
{
return false;
}
+
+ PlcReadRequest::Builder* AbstractPlcConnection::readRequestBuilder()
+ {
+ BOOST_THROW_EXCEPTION(PlcUnsupportedOperationException("The connection does not support reading"));
+ }
+
+
+
+ /*@Override
+ public PlcWriteRequest.Builder writeRequestBuilder() {
+ throw new PlcUnsupportedOperationException("The connection does not support writing");
+ }
+
+ @Override
+ public PlcSubscriptionRequest.Builder subscriptionRequestBuilder() {
+ throw new PlcUnsupportedOperationException("The connection does not support subscription");
+ }
+
+ @Override
+ public PlcUnsubscriptionRequest.Builder unsubscriptionRequestBuilder() {
+ throw new PlcUnsupportedOperationException("The connection does not support subscription");
+ }*/
+
+
}
}
}
diff --git a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.h b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.h
index e7b0683..c17e933 100644
--- a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.h
+++ b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/AbstractPlcConnection.h
@@ -48,7 +48,7 @@ namespace org
{
public:
- PlcConnectionMetadata& getMetadata();
+ PlcConnectionMetadata* getMetadata();
bool canRead();
bool canWrite();
bool canSubscribe();
@@ -57,8 +57,7 @@ namespace org
virtual void close() = 0;
virtual bool send(unsigned char* pBytesToSend, int iNumBytesToSend) = 0;
- // Todo: Check if required
- //PlcReadRequest.Builder readRequestBuilder();
+ PlcReadRequest::Builder* readRequestBuilder();
// PlcWriteRequest.Builder writeRequestBuilder();
// PlcSubscriptionRequest.Builder subscriptionRequestBuilder();
// PlcUnsubscriptionRequest.Builder nsubscriptionRequestBuilder();
diff --git a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/PlcFieldHandler.h b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/PlcFieldHandler.h
index b26339f..3ee2257 100644
--- a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/PlcFieldHandler.h
+++ b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/connection/PlcFieldHandler.h
@@ -58,7 +58,7 @@ namespace org
public:
- virtual PlcField createField(std::string strFieldQuery) = 0;
+ virtual PlcField* createField(std::string strFieldQuery) = 0;
virtual BaseDefaultFieldItem<bool>* encodeBoolean(PlcField plcField, std::vector<void*> pValues) = 0;
diff --git a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcReadRequest.cpp b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcReadRequest.cpp
index 21005b7..82a53ad 100644
--- a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcReadRequest.cpp
+++ b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcReadRequest.cpp
@@ -39,81 +39,103 @@ namespace org
}
// =========================================================
- DefaultPlcReadRequest::DefaultPlcReadRequest(PlcReader* reader, std::map<std::string, PlcField> fields)
+ DefaultPlcReadRequest::DefaultPlcReadRequest(PlcReader* plcReader, std::map<std::string, PlcField*> mplcFields)
{
- this->_reader = reader;
- this->_fields = fields;
+ _plcReader = plcReader;
+ _mplcFields = mplcFields;
}
+ // ====================================================
+ PlcReader* DefaultPlcReadRequest::getReader()
+ {
+ return _plcReader;
+ }
+
// ==========================================================
int DefaultPlcReadRequest::getNumberOfFields()
{
- return _fields.size();
+ return _mplcFields.size();
}
// =========================================================
- PlcField* DefaultPlcReadRequest::getField(std::string name)
+ PlcField* DefaultPlcReadRequest::getField(std::string strName)
{
- // sgl: check 1st, whether the key is contained in vector
- // (otherwise an exception is thrown)...
- std::map<std::string, PlcField>::iterator iterator = _fields.find(name);
+ PlcField* plcField = nullptr;
+
+ std::map<std::string, PlcField*>::iterator iterator = _mplcFields.find(strName);
- if (iterator == _fields.end())
+ if (iterator != _mplcFields.end())
{
- return nullptr;
+ plcField = iterator->second;
}
- return &(iterator->second);
-
+ return plcField;
}
// ======================================================
- std::map<std::string, PlcField> DefaultPlcReadRequest::getNamedFields()
- {
- // Todo:
- /*return fields.entrySet()
- .stream()
- .map(stringPlcFieldEntry->Pair.of(stringPlcFieldEntry.getKey(), stringPlcFieldEntry.getValue()))
- .collect(Collectors.toCollection(LinkedList::new));
-*/
- return std::map<std::string, PlcField>();
- }
-
- // ====================================================
- PlcReader* DefaultPlcReadRequest::getReader()
+ std::map<std::string, PlcField*> DefaultPlcReadRequest::getNamedFields()
{
- return _reader;
+ return std::map<std::string, PlcField*>();
}
// =====================================================
- std::vector<PlcField> DefaultPlcReadRequest::getFields()
+ std::vector<PlcField*> DefaultPlcReadRequest::getFields()
{
- // TODO: check if already exists...
- std::pair<std::string, PlcField> me;
- std::vector<PlcField> vNames;
+ std::pair<std::string, PlcField*> me;
+ std::vector<PlcField*> vplcFields;
- BOOST_FOREACH(me, _fields)
+ BOOST_FOREACH(me, _mplcFields)
{
- vNames.push_back(me.second);
+ vplcFields.push_back(me.second);
}
- return vNames;
+ return vplcFields;
}
// =========================================================
std::vector<std::string> DefaultPlcReadRequest::getFieldNames()
{
// TODO: check if already exists...
- std::pair<std::string, PlcField> me;
- std::vector<std::string> vNames;
+ std::pair<std::string, PlcField*> me;
+ std::vector<std::string> vstrNames;
- BOOST_FOREACH(me, _fields)
+ BOOST_FOREACH(me, _mplcFields)
{
- vNames.push_back(me.first);
+ vstrNames.push_back(me.first);
}
- return vNames;
- }
+ return vstrNames;
+ }
+
+ DefaultPlcReadRequest::Builder::Builder(PlcReader* plcReader, PlcFieldHandler* plcFieldHandler)
+ {
+ _plcReader = plcReader;
+ _plcFieldHandler = plcFieldHandler;
+ }
+
+ DefaultPlcReadRequest::Builder* DefaultPlcReadRequest::Builder::addItem(std::string strName, std::string strFieldQuery)
+ {
+ std::map<std::string, std::string>::iterator iterator = _mFields.find(strName);
+ if (iterator != _mFields.end())
+ {
+ BOOST_THROW_EXCEPTION(PlcRuntimeException("Duplicate field definition '" + strName + "'"));
+ }
+ _mFields.insert(std::pair<std::string,std::string>(strName, strFieldQuery));
+ return this;
+ }
+
+ PlcReadRequest* DefaultPlcReadRequest::Builder::build()
+ {
+ std::map<std::string, PlcField*> mParsedFields;
+ std::pair<std::string, std::string> me;
+
+ BOOST_FOREACH(me, _mFields)
+ {
+ PlcField* parsedField = _plcFieldHandler->createField(me.second);
+ mParsedFields.insert(std::pair<std::string, PlcField*>(me.first, parsedField));
+ }
+ return new DefaultPlcReadRequest(_plcReader, mParsedFields);
+ }
}
}
}
diff --git a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcReadRequest.h b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcReadRequest.h
index ef31dd1..4ce2c9c 100644
--- a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcReadRequest.h
+++ b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcReadRequest.h
@@ -24,11 +24,12 @@ under the License.
#include "InternalPlcFieldRequest.h"
#include "PlcReader.h"
#include <org/apache/plc4x/cpp/api/model/PlcField.h>
+#include "../connection/PlcFieldHandler.h"
#include <map>
#include <boost/foreach.hpp>
-using namespace org::apache::plc4x::cpp::api::messages;
+
namespace org
@@ -43,8 +44,10 @@ namespace org
{
namespace messages
{
-
- class DefaultPlcReadRequest : public InternalPlcReadRequest //, public InternalPlcFieldRequest
+ using namespace org::apache::plc4x::cpp::api::messages;
+ using namespace org::apache::plc4x::cpp::base::connection;
+
+ class DefaultPlcReadRequest : public InternalPlcReadRequest
{
public:
// Todo:
@@ -55,21 +58,37 @@ namespace org
// Todo: implement java Builder-pattern for C++
- DefaultPlcReadRequest(PlcReader* reader, std::map<std::string, PlcField> fields);
+ DefaultPlcReadRequest(PlcReader* plcReader, std::map<std::string, PlcField*> mplcFields);
int getNumberOfFields();
std::vector<std::string> getFieldNames();
PlcField* getField(std::string name);
- std::vector<PlcField> getFields();
- std::map<std::string, PlcField> getNamedFields();
+ std::vector<PlcField*> getFields();
+ std::map<std::string, PlcField*> getNamedFields();
+
+ class Builder
+ {
+ public:
+ Builder(PlcReader* plcReader, PlcFieldHandler* plcFieldHandler);
+ Builder* addItem(std::string strName, std::string strFieldQuery);
+ PlcReadRequest* build();
+
+ private:
+ PlcReader* _plcReader;
+ PlcFieldHandler* _plcFieldHandler;
+ std::map<std::string, std::string> _mFields;
+ };
+
protected:
+
PlcReader* getReader();
private:
+
DefaultPlcReadRequest();
- PlcReader* _reader;
- std::map<std::string, PlcField> _fields;
+ PlcReader* _plcReader;
+ std::map<std::string, PlcField*> _mplcFields;
};
}
}
diff --git a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcWriteRequest.cpp b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcWriteRequest.cpp
index bccc0c3..e0d6f9d 100644
--- a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcWriteRequest.cpp
+++ b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcWriteRequest.cpp
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License.
*/
-#include "DefaultPlcReadRequest.h"
+#include "DefaultPlcWriteRequest.h"
namespace org
{
@@ -32,86 +32,83 @@ namespace org
namespace messages
{
// =========================================================
- DefaultPlcReadRequest::DefaultPlcReadRequest()
+ DefaultPlcWriteRequest::DefaultPlcWriteRequest()
{
}
// =========================================================
- DefaultPlcReadRequest::DefaultPlcReadRequest(PlcReader* reader, std::map<std::string, PlcField> fields)
+ DefaultPlcWriteRequest::DefaultPlcWriteRequest(PlcWriter* plcWriter, std::map<std::string, PlcField*> mplcFields)
{
- this->_reader = reader;
- this->_fields = fields;
+ _plcWriter = plcWriter;
+ _mplcFields = mplcFields;
}
- // ==========================================================
- int DefaultPlcReadRequest::getNumberOfFields()
- {
- return _fields.size();
- }
+ // ====================================================
+ PlcWriter* DefaultPlcWriteRequest::getWriter()
+ {
+ return _plcWriter;
+ }
- // =========================================================
- PlcField* DefaultPlcReadRequest::getField(std::string name)
- {
- // sgl: check 1st, whether the key is contained in vector
- // (otherwise an exception is thrown)...
- std::map<std::string, PlcField>::iterator iterator = _fields.find(name);
+ // ==========================================================
+ int DefaultPlcWriteRequest::getNumberOfFields()
+ {
+ return _mplcFields.size();
+ }
- if (iterator == _fields.end())
- {
- return nullptr;
- }
+ // =========================================================
+ PlcField* DefaultPlcWriteRequest::getField(std::string strName)
+ {
+ PlcField* plcField = nullptr;
- return &(iterator->second);
-
- }
+ std::map<std::string, PlcField*>::iterator iterator = _mplcFields.find(strName);
- // ======================================================
- std::map<std::string, PlcField> DefaultPlcReadRequest::getNamedFields()
- {
- // Todo:
- /*return fields.entrySet()
- .stream()
- .map(stringPlcFieldEntry->Pair.of(stringPlcFieldEntry.getKey(), stringPlcFieldEntry.getValue()))
- .collect(Collectors.toCollection(LinkedList::new));
-*/
- return std::map<std::string, PlcField>();
- }
+ if (iterator != _mplcFields.end())
+ {
+ plcField = iterator->second;
+ }
- // ====================================================
- PlcReader* DefaultPlcReadRequest::getReader()
- {
- return _reader;
- }
+ return plcField;
- // =====================================================
- std::vector<PlcField> DefaultPlcReadRequest::getFields()
- {
- // TODO: check if already exists...
- std::pair<std::string, PlcField> me;
- std::vector<PlcField> vNames;
+ }
- BOOST_FOREACH(me, _fields)
- {
- vNames.push_back(me.second);
- }
+ // ======================================================
+ std::map<std::string, PlcField*> DefaultPlcWriteRequest::getNamedFields()
+ {
+ return std::map<std::string, PlcField*>();
+ }
- return vNames;
- }
+ // =====================================================
+ std::vector<PlcField*> DefaultPlcWriteRequest::getFields()
+ {
+ std::pair<std::string, PlcField*> me;
+ std::vector<PlcField*> vplcFields;
- // =========================================================
- std::vector<std::string> DefaultPlcReadRequest::getFieldNames()
- {
- // TODO: check if already exists...
- std::pair<std::string, PlcField> me;
- std::vector<std::string> vNames;
-
- BOOST_FOREACH(me, _fields)
- {
- vNames.push_back(me.first);
- }
-
- return vNames;
- }
+ BOOST_FOREACH(me, _mplcFields)
+ {
+ vplcFields.push_back(me.second);
+ }
+
+ return vplcFields;
+ }
+
+ // =========================================================
+ std::vector<std::string> DefaultPlcWriteRequest::getFieldNames()
+ {
+ // TODO: check if already exists...
+ std::pair<std::string, PlcField*> me;
+ std::vector<std::string> vstrNames;
+
+ BOOST_FOREACH(me, _mplcFields)
+ {
+ vstrNames.push_back(me.first);
+ }
+
+ return vstrNames;
+ }
+
+
+
+
}
}
}
diff --git a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcWriteRequest.h b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcWriteRequest.h
index 163c64b..a349dbe 100644
--- a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcWriteRequest.h
+++ b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/DefaultPlcWriteRequest.h
@@ -54,22 +54,21 @@ namespace org
// Todo: implement java Builder-pattern for C++
- DefaultPlcWriteRequest(PlcWriter* writer, std::map<std::string, PlcField> fields);
+ DefaultPlcWriteRequest(PlcWriter* writer, std::map<std::string, PlcField*> fields);
int getNumberOfFields();
std::vector<std::string> getFieldNames();
PlcField* getField(std::string name);
- std::vector<PlcField> getFields();
- std::map<std::string, PlcField> getNamedFields();
+ std::vector<PlcField*> getFields();
+ std::map<std::string, PlcField*> getNamedFields();
// Todo: implement callback to: execute() { _writer.write(this); }
protected:
PlcWriter* getWriter();
-
private:
DefaultPlcWriteRequest();
- PlcWriter* _writer;
- std::map<std::string, PlcField> _fields;
+ PlcWriter* _plcWriter;
+ std::map<std::string, PlcField*> _mplcFields;
};
}
}
diff --git a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/InternalPlcFieldRequest.h b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/InternalPlcFieldRequest.h
index 9247d54..37415ca 100644
--- a/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/InternalPlcFieldRequest.h
+++ b/plc4cpp/protocols/driver-bases/base/src/main/cpp/org/apache/plc4x/cpp/base/messages/InternalPlcFieldRequest.h
@@ -41,7 +41,7 @@ namespace org
class InternalPlcFieldRequest : public InternalPlcRequest, PlcFieldRequest
{
public:
- virtual std::map<std::string, PlcField> getNamedFields() = 0;
+ virtual std::map<std::string, PlcField*> getNamedFields() = 0;
InternalPlcFieldRequest();
};
}