io.joynr.generator.cpp.proxy.InterfaceProxyBaseHTemplate.xtend Maven / Gradle / Ivy
package io.joynr.generator.cpp.proxy
/*
* !!!
*
* Copyright (C) 2011 - 2015 BMW Car IT GmbH
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import com.google.inject.Inject
import io.joynr.generator.cpp.util.CppStdTypeUtil
import io.joynr.generator.cpp.util.JoynrCppGeneratorExtensions
import io.joynr.generator.cpp.util.TemplateBase
import io.joynr.generator.util.InterfaceTemplate
import org.franca.core.franca.FInterface
class InterfaceProxyBaseHTemplate implements InterfaceTemplate{
@Inject extension JoynrCppGeneratorExtensions
@Inject extension TemplateBase
@Inject extension CppStdTypeUtil
override generate(FInterface serviceInterface)
'''
«val interfaceName = serviceInterface.joynrName»
«val className = interfaceName + "ProxyBase"»
«val headerGuard = ("GENERATED_INTERFACE_"+getPackagePathWithJoynrPrefix(serviceInterface, "_")+
"_"+interfaceName+"ProxyBase_h").toUpperCase»
«warning()»
#ifndef «headerGuard»
#define «headerGuard»
#include "joynr/PrivateCopyAssign.h"
«FOR parameterType: getRequiredIncludesFor(serviceInterface).addElements(includeForString)»
#include «parameterType»
«ENDFOR»
#include
#include
«getDllExportIncludeStatement()»
#include "joynr/ProxyBase.h"
#include "«getPackagePathWithJoynrPrefix(serviceInterface, "/")»/I«interfaceName»Connector.h"
«getNamespaceStarter(serviceInterface)»
/** @brief Proxy base class for interface «interfaceName» */
class «getDllExportMacro()» «className»: virtual public joynr::ProxyBase, virtual public «getPackagePathWithJoynrPrefix(serviceInterface, "::")»::I«interfaceName»Subscription {
public:
/**
* @brief Parameterized constructor
* @param messagingAddress The address
* @param connectorFactory The connector factory
* @param cache The client cache
* @param domain The provider domain
* @param qosSettings The quality of service settings
* @param cached True, if cached, false otherwise
*/
«className»(
QSharedPointer messagingAddress,
joynr::ConnectorFactory* connectorFactory,
joynr::IClientCache* cache,
const std::string& domain,
const joynr::MessagingQos& qosSettings,
bool cached
);
/** @brief Destructor */
~«className»();
/**
* @brief Called when arbitration is finished
* @param participantId The id of the participant
* @param connection The kind of connection
*/
void handleArbitrationFinished(
const std::string &participantId,
const joynr::types::CommunicationMiddleware::Enum& connection
);
«FOR attribute: getAttributes(serviceInterface).filter[attribute | attribute.notifiable]»
«val returnType = attribute.typeName»
«var attributeName = attribute.joynrName»
/**
* @brief creates a new subscription to attribute «attributeName.toFirstUpper»
* @param subscriptionListener The listener callback providing methods to call on publication and failure
* @param subscriptionQos The subscription quality of service settings
* @return the subscription id as string
*/
std::string subscribeTo«attributeName.toFirstUpper»(
std::shared_ptr > subscriptionListener,
const joynr::SubscriptionQos& subscriptionQos);
/**
* @brief updates an existing subscription to attribute «attributeName.toFirstUpper»
* @param subscriptionListener The listener callback providing methods to call on publication and failure
* @param subscriptionQos The subscription quality of service settings
* @param subscriptionId The subscription id returned earlier on creation of the subscription
* @return the subscription id as string
*/
std::string subscribeTo«attributeName.toFirstUpper»(
std::shared_ptr > subscriptionListener,
const joynr::SubscriptionQos& subscriptionQos,
std::string& subcriptionId);
/**
* @brief unsubscribes from attribute «attributeName.toFirstUpper»
* @param subscriptionId The subscription id returned earlier on creation of the subscription
*/
void unsubscribeFrom«attributeName.toFirstUpper»(std::string& subscriptionId);
«ENDFOR»
«FOR broadcast: serviceInterface.broadcasts»
«val returnTypes = broadcast.commaSeparatedOutputParameterTypes»
«var broadcastName = broadcast.joynrName»
«IF isSelective(broadcast)»
/**
* @brief subscribes to selective broadcast «broadcastName.toFirstUpper» with filter parameters
* @param filterParameters The filter parameters for selection of suitable broadcasts
* @param subscriptionListener The listener callback providing methods to call on publication and failure
* @param subscriptionQos The subscription quality of service settings
* @return the subscription id as string
*/
std::string subscribeTo«broadcastName.toFirstUpper»Broadcast(
const «interfaceName.toFirstUpper»«broadcastName.toFirstUpper»BroadcastFilterParameters& filterParameters,
std::shared_ptr > subscriptionListener,
const joynr::OnChangeSubscriptionQos& subscriptionQos);
/**
* @brief updates an existing subscription to selective broadcast «broadcastName.toFirstUpper» with filter parameters
* @param filterParameters The filter parameters for selection of suitable broadcasts
* @param subscriptionListener The listener callback providing methods to call on publication and failure
* @param subscriptionQos The subscription quality of service settings
* @param subscriptionId The subscription id returned earlier on creation of the subscription
* @return the subscription id as string
*/
std::string subscribeTo«broadcastName.toFirstUpper»Broadcast(
const «interfaceName.toFirstUpper»«broadcastName.toFirstUpper»BroadcastFilterParameters& filterParameters,
std::shared_ptr > subscriptionListener,
const joynr::OnChangeSubscriptionQos& subscriptionQos,
std::string& subscriptionId);
«ELSE»
/**
* @brief subscribes to broadcast «broadcastName.toFirstUpper»
* @param subscriptionListener The listener callback providing methods to call on publication and failure
* @param subscriptionQos The subscription quality of service settings
* @return the subscription id as string
*/
std::string subscribeTo«broadcastName.toFirstUpper»Broadcast(
std::shared_ptr > subscriptionListener,
const joynr::OnChangeSubscriptionQos& subscriptionQos);
/**
* @brief updates an existing subscription to broadcast «broadcastName.toFirstUpper»
* @param filterParameters The filter parameters for selection of suitable broadcasts
* @param subscriptionListener The listener callback providing methods to call on publication and failure
* @param subscriptionQos The subscription quality of service settings
* @param subscriptionId The subscription id returned earlier on creation of the subscription
* @return the subscription id as string
*/
std::string subscribeTo«broadcastName.toFirstUpper»Broadcast(
std::shared_ptr > subscriptionListener,
const joynr::OnChangeSubscriptionQos& subscriptionQos,
std::string& subscriptionId);
«ENDIF»
/**
* @brief unsubscribes from broadcast «broadcastName.toFirstUpper»
* @param subscriptionId The subscription id returned earlier on creation of the subscription
*/
void unsubscribeFrom«broadcastName.toFirstUpper»Broadcast(std::string& subscriptionId);
«ENDFOR»
protected:
/** @brief The joynr messaging address */
QSharedPointer messagingAddress;
/** @brief The kind of connector */
I«interfaceName»Connector* connector;
private:
DISALLOW_COPY_AND_ASSIGN(«className»);
};
«getNamespaceEnder(serviceInterface)»
#endif // «headerGuard»
'''
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy