File size: 7,408 Bytes
68ce2fc | 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 145 146 147 148 149 150 151 152 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 203 204 205 206 207 208 209 210 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */
/*
Author(s): Anton Deguet
Created on: 2010-09-16
(C) Copyright 2010-2013 Johns Hopkins University (JHU), All Rights Reserved.
--- begin cisst license - do not edit ---
This software is provided "as is" under an open source license, with
no warranty. The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.
--- end cisst license ---
*/
/*!
\file
\brief Defines a command with no argument
*/
#ifndef _mtsCallableVoidReturnMethod_h
#define _mtsCallableVoidReturnMethod_h
#include <cisstMultiTask/mtsCallableVoidReturnBase.h>
#include <cisstMultiTask/mtsGenericObjectProxy.h>
#include <string>
/*!
\ingroup cisstMultiTask
*/
template <class _classType, class _resultType>
class mtsCallableVoidReturnMethod: public mtsCallableVoidReturnBase {
public:
typedef mtsCallableVoidReturnBase BaseType;
typedef _resultType ResultType;
/*! Typedef for the specific interface. */
typedef _classType ClassType;
/*! This type. */
typedef mtsCallableVoidReturnMethod<ClassType, ResultType> ThisType;
/*! Typedef for pointer to member function (method) of a specific
class (_classType). */
typedef void(_classType::*ActionType)(ResultType & result);
private:
/*! Private copy constructor to prevent copies */
inline mtsCallableVoidReturnMethod(const ThisType & CMN_UNUSED(other)) {}
protected:
/*! The pointer to member function of the receiver class that
is to be invoked for a particular instance of the command. */
ActionType Action;
/*! Stores the receiver object of the command. */
ClassType * ClassInstantiation;
template <bool, typename _dummy = void>
class ConditionalCast {
// Default case: ResultType not derived from mtsGenericObjectProxy
public:
static mtsExecutionResult CallMethod(ClassType * classInstantiation, ActionType action, mtsGenericObject & result) {
ResultType * resultCasted = mtsGenericTypes<ResultType>::CastArg(result);
if (resultCasted == 0) {
return mtsExecutionResult::INVALID_INPUT_TYPE;
}
(classInstantiation->*action)(*resultCasted);
return mtsExecutionResult::COMMAND_SUCCEEDED;
}
};
template <typename _dummy>
class ConditionalCast<true, _dummy> {
// Specialization: ReturnType is derived from mtsGenericObjectProxy (and thus also from mtsGenericObject)
// In this case, we may need to create a temporary Proxy object.
public:
static mtsExecutionResult CallMethod(ClassType * classInstantiation, ActionType action, mtsGenericObject & result) {
// First, check if a Proxy object was passed.
ResultType * resultCasted = dynamic_cast<ResultType *>(&result);
if (resultCasted) {
(classInstantiation->*action)(*resultCasted);
return mtsExecutionResult::COMMAND_SUCCEEDED;
}
// If it isn't a Proxy, maybe it is a ProxyRef
typedef typename ResultType::RefType ResultRefType;
ResultRefType * dataRef = dynamic_cast<ResultRefType *>(&result);
if (!dataRef) {
CMN_LOG_INIT_ERROR << "mtsCallableVoidReturn: CallMethod could not cast from " << typeid(result).name()
<< " to " << typeid(ResultRefType).name() << std::endl;
return mtsExecutionResult::INVALID_INPUT_TYPE;
}
// Now, make the call using the temporary
ResultType temp;
(classInstantiation->*action)(temp);
// Finally, copy the data to the return
*dataRef = temp;
return mtsExecutionResult::COMMAND_SUCCEEDED;
}
};
public:
/*! The constructor. Does nothing. */
mtsCallableVoidReturnMethod(void): BaseType(), ClassInstantiation(0) {}
/*! The constructor.
\param action Pointer to the member function that is to be called
by the invoker of the command
\param classInstantiation Pointer to the receiver of the command
*/
mtsCallableVoidReturnMethod(ActionType action, ClassType * classInstantiation):
BaseType(),
Action(action),
ClassInstantiation(classInstantiation)
{}
/*! The destructor. Does nothing */
virtual ~mtsCallableVoidReturnMethod() {}
/* documented in base class */
mtsExecutionResult Execute(mtsGenericObject & result) {
return ConditionalCast<cmnIsDerivedFromTemplated<ResultType, mtsGenericObjectProxy>::IS_DERIVED>
::CallMethod(ClassInstantiation, Action, result);
}
/* documented in base class */
void ToStream(std::ostream & outputStream) const {
if (this->ClassInstantiation) {
outputStream << "method based callable void return object using class/object \""
<< mtsObjectName(this->ClassInstantiation) << "\"";
} else {
outputStream << "invalid method based callable object";
}
}
};
template <class _classType>
class mtsCallableVoidReturnMethodGeneric: public mtsCallableVoidReturnBase {
public:
typedef mtsCallableVoidReturnBase BaseType;
/*! Typedef for the specific interface. */
typedef _classType ClassType;
/*! This type. */
typedef mtsCallableVoidReturnMethodGeneric<ClassType> ThisType;
/*! Typedef for pointer to member function (method) of a specific
class (_classType). */
typedef void(_classType::*ActionType)(mtsGenericObject & result);
private:
/*! Private copy constructor to prevent copies */
inline mtsCallableVoidReturnMethodGeneric(const ThisType & CMN_UNUSED(other)) {}
protected:
/*! The pointer to member function of the receiver class that
is to be invoked for a particular instance of the command. */
ActionType Action;
/*! Stores the receiver object of the command. */
ClassType * ClassInstantiation;
public:
/*! The constructor. Does nothing. */
mtsCallableVoidReturnMethodGeneric(void): BaseType(), ClassInstantiation(0) {}
/*! The constructor.
\param action Pointer to the member function that is to be called
by the invoker of the command
\param classInstantiation Pointer to the receiver of the command
*/
mtsCallableVoidReturnMethodGeneric(ActionType action, ClassType * classInstantiation):
BaseType(),
Action(action),
ClassInstantiation(classInstantiation)
{}
/*! The destructor. Does nothing */
virtual ~mtsCallableVoidReturnMethodGeneric() {}
/* documented in base class */
mtsExecutionResult Execute(mtsGenericObject & result) {
(ClassInstantiation->*Action)(result);
return mtsExecutionResult::COMMAND_SUCCEEDED;
}
/* documented in base class */
void ToStream(std::ostream & outputStream) const {
if (this->ClassInstantiation) {
outputStream << "method based callable void return object using class/object \""
<< mtsObjectName(this->ClassInstantiation) << "\"";
} else {
outputStream << "invalid method based callable object";
}
}
};
#endif // _mtsCallableVoidReturnMethod_h
|