prmConfigurationJoint.h

Go to the documentation of this file.

// file automatically generated, do not modify
// cisst version: 1.5.0
// source file: /Users/anton/devel/cisst-saw-doxygen/tmp/cisst-saw/cisst/cisstParameterTypes/code/../prmConfigurationJoint.cdg
 
#pragma once
#ifndef _cisstParameterTypes_prmConfigurationJoint_h
#define _cisstParameterTypes_prmConfigurationJoint_h
 
#include <cisstCommon/cmnDataFunctions.h>
#include <cisstCommon/cmnDataFunctionsEnumMacros.h>
#if CISST_HAS_JSON
#include <cisstCommon/cmnDataFunctionsJSON.h>
#endif // CISST_HAS_JSON
 
/* source line: 1 */
 
 
 
 
// for mts-proxy 
#include <cisstCommon/cmnClassServices.h>
#include <cisstCommon/cmnClassRegisterMacros.h>
#include <cisstMultiTask/mtsGenericObjectProxy.h>
 
/* source line: 1 */
/* source line: 4 */
 
#include <cisstCommon/cmnJointType.h>
#include <cisstVector/vctDynamicVectorTypes.h>
#include <cisstMultiTask/mtsGenericObject.h>
#include <cisstParameterTypes/prmJointType.h>
// Always include last
#include <cisstParameterTypes/prmExport.h>
 
/* source line: 13 */
class CISST_EXPORT prmConfigurationJoint: public mtsGenericObject
{
 /* default constructors and destructors. */
 public:
    prmConfigurationJoint(void);
    prmConfigurationJoint(const prmConfigurationJoint & other);
    prmConfigurationJoint & operator = (const prmConfigurationJoint & other);
    ~prmConfigurationJoint();
 
/* source line: 23 */
 protected:
    std::vector<std::string> mName; // Name
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetName(std::vector<std::string> & placeHolder) const;
#endif
    inline  std::vector<std::string> GetName(void) const {
        return mName;
    }
     void SetName(const std::vector<std::string> & newValue);
    /* accessors is set to: all */
     const std::vector<std::string> & Name(void) const;
     std::vector<std::string> & Name(void);
/* source line: 28 */
 protected:
    vctDynamicVector<cmnJointType> mType; // Type
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetType(vctDynamicVector<cmnJointType> & placeHolder) const;
#endif
    inline  vctDynamicVector<cmnJointType> GetType(void) const {
        return mType;
    }
     void SetType(const vctDynamicVector<cmnJointType> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<cmnJointType> & Type(void) const;
     vctDynamicVector<cmnJointType> & Type(void);
/* source line: 33 */
 protected:
    vctDynamicVector<double> mPositionMin; // PositionMin
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetPositionMin(vctDynamicVector<double> & placeHolder) const;
#endif
    inline  vctDynamicVector<double> GetPositionMin(void) const {
        return mPositionMin;
    }
     void SetPositionMin(const vctDynamicVector<double> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<double> & PositionMin(void) const;
     vctDynamicVector<double> & PositionMin(void);
/* source line: 37 */
 protected:
    vctDynamicVector<double> mPositionMax; // PositionMax
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetPositionMax(vctDynamicVector<double> & placeHolder) const;
#endif
    inline  vctDynamicVector<double> GetPositionMax(void) const {
        return mPositionMax;
    }
     void SetPositionMax(const vctDynamicVector<double> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<double> & PositionMax(void) const;
     vctDynamicVector<double> & PositionMax(void);
/* source line: 42 */
 protected:
    vctDynamicVector<double> mVelocityMin; // VelocityMin
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetVelocityMin(vctDynamicVector<double> & placeHolder) const;
#endif
    inline  vctDynamicVector<double> GetVelocityMin(void) const {
        return mVelocityMin;
    }
     void SetVelocityMin(const vctDynamicVector<double> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<double> & VelocityMin(void) const;
     vctDynamicVector<double> & VelocityMin(void);
/* source line: 46 */
 protected:
    vctDynamicVector<double> mVelocityMax; // VelocityMax
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetVelocityMax(vctDynamicVector<double> & placeHolder) const;
#endif
    inline  vctDynamicVector<double> GetVelocityMax(void) const {
        return mVelocityMax;
    }
     void SetVelocityMax(const vctDynamicVector<double> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<double> & VelocityMax(void) const;
     vctDynamicVector<double> & VelocityMax(void);
/* source line: 51 */
 protected:
    vctDynamicVector<double> mAccelerationMin; // AccelerationMin
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetAccelerationMin(vctDynamicVector<double> & placeHolder) const;
#endif
    inline  vctDynamicVector<double> GetAccelerationMin(void) const {
        return mAccelerationMin;
    }
     void SetAccelerationMin(const vctDynamicVector<double> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<double> & AccelerationMin(void) const;
     vctDynamicVector<double> & AccelerationMin(void);
/* source line: 55 */
 protected:
    vctDynamicVector<double> mAccelerationMax; // AccelerationMax
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetAccelerationMax(vctDynamicVector<double> & placeHolder) const;
#endif
    inline  vctDynamicVector<double> GetAccelerationMax(void) const {
        return mAccelerationMax;
    }
     void SetAccelerationMax(const vctDynamicVector<double> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<double> & AccelerationMax(void) const;
     vctDynamicVector<double> & AccelerationMax(void);
/* source line: 60 */
 protected:
    vctDynamicVector<double> mEffortMin; // EffortMin
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetEffortMin(vctDynamicVector<double> & placeHolder) const;
#endif
    inline  vctDynamicVector<double> GetEffortMin(void) const {
        return mEffortMin;
    }
     void SetEffortMin(const vctDynamicVector<double> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<double> & EffortMin(void) const;
     vctDynamicVector<double> & EffortMin(void);
/* source line: 64 */
 protected:
    vctDynamicVector<double> mEffortMax; // EffortMax
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetEffortMax(vctDynamicVector<double> & placeHolder) const;
#endif
    inline  vctDynamicVector<double> GetEffortMax(void) const {
        return mEffortMax;
    }
     void SetEffortMax(const vctDynamicVector<double> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<double> & EffortMax(void) const;
     vctDynamicVector<double> & EffortMax(void);
/* source line: 69 */
 
    private:
        CMN_DECLARE_SERVICES(CMN_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);
        /* default methods */
 public:
    void SerializeRaw(std::ostream & outputStream) const override;
    void DeSerializeRaw(std::istream & inputStream) override;
    void ToStream(std::ostream & outputStream) const override;
    void ToStreamRaw(std::ostream & outputStream, const char delimiter = ' ',
                     bool headerOnly = false, const std::string & headerPrefix = "") const override;
    /* default data methods */
 public:
    void Copy(const prmConfigurationJoint & source);
    void SerializeBinary(std::ostream & outputStream) const CISST_THROW(std::runtime_error);
    void DeSerializeBinary(std::istream & inputStream, const cmnDataFormat & localFormat, const cmnDataFormat & remoteFormat) CISST_THROW(std::runtime_error);
    void SerializeText(std::ostream & outputStream, const char delimiter = ',') const CISST_THROW(std::runtime_error);
    std::string SerializeDescription(const char delimiter = ',', const std::string & userDescription = "") const;
    void DeSerializeText(std::istream & inputStream, const char delimiter = ',') CISST_THROW(std::runtime_error);
    std::string HumanReadable(void) const;
    bool ScalarNumberIsFixed(void) const override;
    size_t ScalarNumber(void) const override;
    double Scalar(const size_t index) const CISST_THROW(std::out_of_range) override;
    std::string ScalarDescription(const size_t index, const std::string & userDescription = "") const CISST_THROW(std::out_of_range) override;
#if CISST_HAS_JSON
    void SerializeTextJSON(Json::Value & jsonValue) const override;
    void DeSerializeTextJSON(const Json::Value & jsonValue) CISST_THROW(std::runtime_error) override;
#endif // CISST_HAS_JSON
 
}; // prmConfigurationJoint
 
// mts-proxy set to true
typedef mtsGenericObjectProxy<prmConfigurationJoint> prmConfigurationJointProxy;
CMN_DECLARE_SERVICES_INSTANTIATION(prmConfigurationJointProxy);
 
/* default functions */
void CISST_EXPORT cmnSerializeRaw(std::ostream & outputStream, const prmConfigurationJoint & object);
void CISST_EXPORT cmnDeSerializeRaw(std::istream & inputStream, prmConfigurationJoint & placeHolder);
/* data functions */
template <> class cmnData<prmConfigurationJoint > {
public: 
    enum {IS_SPECIALIZED = 1};
    typedef prmConfigurationJoint DataType;
    static void Copy(DataType & data, const DataType & source) {
        data.Copy(source);
    }
    static std::string SerializeDescription(const DataType & data, const char delimiter, const std::string & userDescription) {
        return data.SerializeDescription(delimiter, userDescription);
    }
    static void SerializeBinary(const DataType & data, std::ostream & outputStream) CISST_THROW(std::runtime_error) {
        data.SerializeBinary(outputStream);
    }
    static void DeSerializeBinary(DataType & data, std::istream & inputStream, const cmnDataFormat & localFormat, const cmnDataFormat & remoteFormat) CISST_THROW(std::runtime_error) {
        data.DeSerializeBinary(inputStream, localFormat, remoteFormat);
    }
    static void SerializeText(const DataType & data, std::ostream & outputStream, const char delimiter = ',') CISST_THROW(std::runtime_error) {
        data.SerializeText(outputStream, delimiter);
    }
    static void DeSerializeText(DataType & data, std::istream & inputStream, const char delimiter = ',') CISST_THROW(std::runtime_error) {
        data.DeSerializeText(inputStream, delimiter);
    }
    static std::string HumanReadable(const DataType & data) {
        return data.HumanReadable();
    }
    static bool ScalarNumberIsFixed(const DataType & data) {
        return data.ScalarNumberIsFixed();
    }
    static size_t ScalarNumber(const DataType & data) {
        return data.ScalarNumber();
    }
    static std::string ScalarDescription(const DataType & data, const size_t index, const std::string & userDescription = "") CISST_THROW(std::out_of_range) {
        return data.ScalarDescription(index, userDescription);
    }
    static double Scalar(const DataType & data, const size_t index) CISST_THROW(std::out_of_range) {
        return data.Scalar(index);
    }
};
inline std::ostream & operator << (std::ostream & outputStream, const prmConfigurationJoint & data) {
    outputStream << cmnData<prmConfigurationJoint >::HumanReadable(data);
    return outputStream;
}
#if CISST_HAS_JSON
template <> void CISST_EXPORT cmnDataJSON<prmConfigurationJoint >::SerializeText(const prmConfigurationJoint & data, Json::Value & jsonValue);
template <> void CISST_EXPORT cmnDataJSON<prmConfigurationJoint >::DeSerializeText(prmConfigurationJoint & data, const Json::Value & jsonValue) CISST_THROW(std::runtime_error);
#endif // CISST_HAS_JSON
 
/* source line: 76 */
 
CMN_DECLARE_SERVICES_INSTANTIATION(prmConfigurationJoint);
 
 
#endif // _cisstParameterTypes_prmConfigurationJoint_h