cisst-saw
Loading...
Searching...
No Matches
prmInputData.h
Go to the documentation of this file.
1// file automatically generated, do not modify
2// cisst version: 1.5.0
3// source file: /Users/anton/devel/cisst-saw-doxygen/tmp/cisst-saw/cisst/cisstParameterTypes/code/../prmInputData.cdg
4
5#pragma once
6#ifndef _cisstParameterTypes_prmInputData_h
7#define _cisstParameterTypes_prmInputData_h
8
11#if CISST_HAS_JSON
13#endif // CISST_HAS_JSON
14
15/* source line: 1 */
16
17
18
19
20// for mts-proxy
24
25/* source line: 1 */
26/* source line: 4 */
27
28
30
31// Always include last
33
34/* source line: 13 */
36{
37 /* default constructors and destructors. */
38 public:
40 prmInputData(const prmInputData & other);
43
44/* source line: 22 */
45 protected:
46 vctDoubleVec mAnalogInputs; // Analog inputs
47 public:
48 /* accessors is set to: all */
49#ifndef SWIG
50 void GetAnalogInputs(vctDoubleVec & placeHolder) const;
51#endif
52 inline vctDoubleVec GetAnalogInputs(void) const {
53 return mAnalogInputs;
54 }
55 void SetAnalogInputs(const vctDoubleVec & newValue);
56 /* accessors is set to: all */
57 const vctDoubleVec & AnalogInputs(void) const;
59/* source line: 28 */
60 protected:
61 vctBoolVec mDigitalInputs; // Digital inputs
62 public:
63 /* accessors is set to: all */
64#ifndef SWIG
65 void GetDigitalInputs(vctBoolVec & placeHolder) const;
66#endif
67 inline vctBoolVec GetDigitalInputs(void) const {
68 return mDigitalInputs;
69 }
70 void SetDigitalInputs(const vctBoolVec & newValue);
71 /* accessors is set to: all */
72 const vctBoolVec & DigitalInputs(void) const;
74/* source line: 34 */
75
76 private:
77 CMN_DECLARE_SERVICES(CMN_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);
78 /* default methods */
79 public:
80 void SerializeRaw(std::ostream & outputStream) const override;
81 void DeSerializeRaw(std::istream & inputStream) override;
82 void ToStream(std::ostream & outputStream) const override;
83 void ToStreamRaw(std::ostream & outputStream, const char delimiter = ' ',
84 bool headerOnly = false, const std::string & headerPrefix = "") const override;
85 /* default data methods */
86 public:
87 void Copy(const prmInputData & source);
88 void SerializeBinary(std::ostream & outputStream) const CISST_THROW(std::runtime_error);
89 void DeSerializeBinary(std::istream & inputStream, const cmnDataFormat & localFormat, const cmnDataFormat & remoteFormat) CISST_THROW(std::runtime_error);
90 void SerializeText(std::ostream & outputStream, const char delimiter = ',') const CISST_THROW(std::runtime_error);
91 std::string SerializeDescription(const char delimiter = ',', const std::string & userDescription = "") const;
92 void DeSerializeText(std::istream & inputStream, const char delimiter = ',') CISST_THROW(std::runtime_error);
93 std::string HumanReadable(void) const;
94 bool ScalarNumberIsFixed(void) const override;
95 size_t ScalarNumber(void) const override;
96 double Scalar(const size_t index) const CISST_THROW(std::out_of_range) override;
97 std::string ScalarDescription(const size_t index, const std::string & userDescription = "") const CISST_THROW(std::out_of_range) override;
98#if CISST_HAS_JSON
99 void SerializeTextJSON(Json::Value & jsonValue) const override;
100 void DeSerializeTextJSON(const Json::Value & jsonValue) CISST_THROW(std::runtime_error) override;
101#endif // CISST_HAS_JSON
102
103}; // prmInputData
104
105// mts-proxy set to true
108
109/* default functions */
110void CISST_EXPORT cmnSerializeRaw(std::ostream & outputStream, const prmInputData & object);
111void CISST_EXPORT cmnDeSerializeRaw(std::istream & inputStream, prmInputData & placeHolder);
112/* data functions */
113template <> class cmnData<prmInputData > {
114public:
115 enum {IS_SPECIALIZED = 1};
117 static void Copy(DataType & data, const DataType & source) {
118 data.Copy(source);
119 }
120 static std::string SerializeDescription(const DataType & data, const char delimiter, const std::string & userDescription) {
121 return data.SerializeDescription(delimiter, userDescription);
122 }
123 static void SerializeBinary(const DataType & data, std::ostream & outputStream) CISST_THROW(std::runtime_error) {
124 data.SerializeBinary(outputStream);
125 }
126 static void DeSerializeBinary(DataType & data, std::istream & inputStream, const cmnDataFormat & localFormat, const cmnDataFormat & remoteFormat) CISST_THROW(std::runtime_error) {
127 data.DeSerializeBinary(inputStream, localFormat, remoteFormat);
128 }
129 static void SerializeText(const DataType & data, std::ostream & outputStream, const char delimiter = ',') CISST_THROW(std::runtime_error) {
130 data.SerializeText(outputStream, delimiter);
131 }
132 static void DeSerializeText(DataType & data, std::istream & inputStream, const char delimiter = ',') CISST_THROW(std::runtime_error) {
133 data.DeSerializeText(inputStream, delimiter);
134 }
135 static std::string HumanReadable(const DataType & data) {
136 return data.HumanReadable();
137 }
138 static bool ScalarNumberIsFixed(const DataType & data) {
139 return data.ScalarNumberIsFixed();
140 }
141 static size_t ScalarNumber(const DataType & data) {
142 return data.ScalarNumber();
143 }
144 static std::string ScalarDescription(const DataType & data, const size_t index, const std::string & userDescription = "") CISST_THROW(std::out_of_range) {
145 return data.ScalarDescription(index, userDescription);
146 }
147 static double Scalar(const DataType & data, const size_t index) CISST_THROW(std::out_of_range) {
148 return data.Scalar(index);
149 }
150};
151inline std::ostream & operator << (std::ostream & outputStream, const prmInputData & data) {
152 outputStream << cmnData<prmInputData >::HumanReadable(data);
153 return outputStream;
154}
155#if CISST_HAS_JSON
156template <> void CISST_EXPORT cmnDataJSON<prmInputData >::SerializeText(const prmInputData & data, Json::Value & jsonValue);
157template <> void CISST_EXPORT cmnDataJSON<prmInputData >::DeSerializeText(prmInputData & data, const Json::Value & jsonValue) CISST_THROW(std::runtime_error);
158#endif // CISST_HAS_JSON
159
160/* source line: 41 */
161
163
164
165#endif // _cisstParameterTypes_prmInputData_h
static void DeSerializeText(DataType &data, std::istream &inputStream, const char delimiter=',') CISST_THROW(std
Definition prmInputData.h:132
static void SerializeBinary(const DataType &data, std::ostream &outputStream) CISST_THROW(std
Definition prmInputData.h:123
static void Copy(DataType &data, const DataType &source)
Definition prmInputData.h:117
static std::string ScalarDescription(const DataType &data, const size_t index, const std::string &userDescription="") CISST_THROW(std
Definition prmInputData.h:144
prmInputData DataType
Definition prmInputData.h:116
static std::string HumanReadable(const DataType &data)
Definition prmInputData.h:135
static std::string SerializeDescription(const DataType &data, const char delimiter, const std::string &userDescription)
Definition prmInputData.h:120
static void DeSerializeBinary(DataType &data, std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std
Definition prmInputData.h:126
static size_t ScalarNumber(const DataType &data)
Definition prmInputData.h:141
static void SerializeText(const DataType &data, std::ostream &outputStream, const char delimiter=',') CISST_THROW(std
Definition prmInputData.h:129
@ IS_SPECIALIZED
Definition prmInputData.h:115
static double Scalar(const DataType &data, const size_t index) CISST_THROW(std
Definition prmInputData.h:147
static bool ScalarNumberIsFixed(const DataType &data)
Definition prmInputData.h:138
Definition cmnDataFormat.h:30
Definition cmnDataFunctions.h:51
virtual std::string ScalarDescription(const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const
Definition cmnGenericObject.h:154
virtual double Scalar(const size_t CMN_UNUSED(index)) const CISST_THROW(std
Definition cmnGenericObject.h:145
mtsGenericObject(void)
Definition mtsGenericObject.h:77
Definition mtsGenericObjectProxy.h:376
Definition prmInputData.h:36
void ToStreamRaw(std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const override
void ToStream(std::ostream &outputStream) const override
void SetAnalogInputs(const vctDoubleVec &newValue)
vctDoubleVec GetAnalogInputs(void) const
Definition prmInputData.h:52
void GetDigitalInputs(vctBoolVec &placeHolder) const
bool ScalarNumberIsFixed(void) const override
void DeSerializeRaw(std::istream &inputStream) override
const vctDoubleVec & AnalogInputs(void) const
void SetDigitalInputs(const vctBoolVec &newValue)
prmInputData(void)
prmInputData(const prmInputData &other)
vctBoolVec GetDigitalInputs(void) const
Definition prmInputData.h:67
vctDoubleVec & AnalogInputs(void)
vctBoolVec mDigitalInputs
Definition prmInputData.h:61
vctBoolVec & DigitalInputs(void)
vctDoubleVec mAnalogInputs
Definition prmInputData.h:46
void SerializeRaw(std::ostream &outputStream) const override
void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string SerializeDescription(const char delimiter=',', const std::string &userDescription="") const
Definition prmInputData.h:91
void GetAnalogInputs(vctDoubleVec &placeHolder) const
size_t ScalarNumber(void) const override
void Copy(const prmInputData &source)
const vctBoolVec & DigitalInputs(void) const
void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string HumanReadable(void) const
Definition prmInputData.h:93
Class registration macros.
#define CMN_DECLARE_SERVICES_INSTANTIATION(className)
Definition cmnClassRegisterMacros.h:199
const int CMN_DYNAMIC_CREATION
Definition cmnClassRegisterMacros.h:328
Defines cmnClassServices.
void cmnDeSerializeRaw(std::istream &inputStream, _elementType &data) CISST_THROW(std
Definition cmnDeSerializer.h:82
#define CISST_EXPORT
Definition cmnExportMacros.h:50
#define CMN_LOG_ALLOW_DEFAULT
Definition cmnLogLoD.h:76
#define CISST_THROW(exceptionParameter)
Somewhat portable compilation warning message. This works with very recent versions of gcc (4....
Definition cmnPortability.h:559
void cmnSerializeRaw(std::ostream &outputStream, const _elementType &data) CISST_THROW(std
Definition cmnSerializer.h:76
STL namespace.
mtsGenericObjectProxy< prmInputData > prmInputDataProxy
Definition prmInputData.h:106
std::ostream & operator<<(std::ostream &outputStream, const prmInputData &data)
Definition prmInputData.h:151
ThisType & operator=(const vctDynamicConstMatrixBase< __matrixOwnerType, __elementType > &otherMatrix)
Definition vctDynamicMatrix.h:255
Typedef for dynamic vectors.
vctDynamicVector< double > vctDoubleVec
Definition vctDynamicVectorTypes.h:37
vctDynamicVector< bool > vctBoolVec
Definition vctDynamicVectorTypes.h:44