casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CalSeeingRow.h
Go to the documentation of this file.
1 
2 /*
3  * ALMA - Atacama Large Millimeter Array
4  * (c) European Southern Observatory, 2002
5  * (c) Associated Universities Inc., 2002
6  * Copyright by ESO (in the framework of the ALMA collaboration),
7  * Copyright by AUI (in the framework of the ALMA collaboration),
8  * All rights reserved.
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY, without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with this library; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23  * MA 02111-1307 USA
24  *
25  * Warning!
26  * --------------------------------------------------------------------
27  * | This is generated code! Do not modify this file. |
28  * | If you do, all changes will be lost when the file is re-generated. |
29  * --------------------------------------------------------------------
30  *
31  * File CalSeeingRow.h
32  */
33 
34 #ifndef CalSeeingRow_CLASS
35 #define CalSeeingRow_CLASS
36 
37 #include <vector>
38 #include <string>
39 #include <set>
40 
41 #ifndef WITHOUT_ACS
42 #include <asdmIDLC.h>
43 #endif
44 
45 
46 
47 
48 
49 
50 
51 #include <alma/ASDM/Angle.h>
52 
53 
54 
55 #include <alma/ASDM/ArrayTime.h>
56 
57 
58 
59 #include <alma/ASDM/Length.h>
60 
61 
62 
63 #include <alma/ASDM/Frequency.h>
64 
65 
66 
67 #include <alma/ASDM/Tag.h>
68 
69 
70 
71 #include <alma/ASDM/Interval.h>
72 
73 
74 
75 
76 
77 
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 
108 #include <alma/ASDM/NoSuchRow.h>
110 
112 //#include <alma/ASDM/TableStreamReader.h>
113 
114 /*\file CalSeeing.h
115  \brief Generated from model's revision "-1", branch ""
116 */
117 
118 namespace asdm {
119 
120 //class asdm::CalSeeingTable;
121 
122 
123 // class asdm::CalDataRow;
124 class CalDataRow;
125 
126 // class asdm::CalReductionRow;
127 class CalReductionRow;
128 
129 
130 class CalSeeingRow;
132 typedef void (CalSeeingRow::*CalSeeingAttributeFromText) (const std::string& s);
133 
141 friend class asdm::CalSeeingTable;
143 //friend class asdm::TableStreamReader<CalSeeingTable, CalSeeingRow>;
144 
145 public:
146 
147  virtual ~CalSeeingRow();
148 
152  CalSeeingTable &getTable() const;
153 
158  bool isAdded() const;
159 
161  // Intrinsic Table Attributes //
163 
164 
165  // ===> Attribute atmPhaseCorrection
166 
167 
168 
169 
170 
175  AtmPhaseCorrectionMod::AtmPhaseCorrection getAtmPhaseCorrection() const;
176 
177 
178 
179 
189  void setAtmPhaseCorrection (AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection);
190 
191 
192 
193 
194 
195 
196 
197  // ===> Attribute startValidTime
198 
199 
200 
201 
202 
208 
209 
210 
211 
220 
221 
222 
223 
224 
225 
226 
227  // ===> Attribute endValidTime
228 
229 
230 
231 
232 
237  ArrayTime getEndValidTime() const;
238 
239 
240 
241 
250 
251 
252 
253 
254 
255 
256 
257  // ===> Attribute frequencyRange
258 
259 
260 
261 
262 
267  std::vector<Frequency > getFrequencyRange() const;
268 
269 
270 
271 
279  void setFrequencyRange (std::vector<Frequency > frequencyRange);
280 
281 
282 
283 
284 
285 
286 
287  // ===> Attribute integrationTime
288 
289 
290 
291 
292 
298 
299 
300 
301 
310 
311 
312 
313 
314 
315 
316 
317  // ===> Attribute numBaseLengths
318 
319 
320 
321 
322 
327  int getNumBaseLengths() const;
328 
329 
330 
331 
340 
341 
342 
343 
344 
345 
346 
347  // ===> Attribute baselineLengths
348 
349 
350 
351 
352 
357  std::vector<Length > getBaselineLengths() const;
358 
359 
360 
361 
369  void setBaselineLengths (std::vector<Length > baselineLengths);
370 
371 
372 
373 
374 
375 
376 
377  // ===> Attribute phaseRMS
378 
379 
380 
381 
382 
387  std::vector<Angle > getPhaseRMS() const;
388 
389 
390 
391 
399  void setPhaseRMS (std::vector<Angle > phaseRMS);
400 
401 
402 
403 
404 
405 
406 
407  // ===> Attribute seeing
408 
409 
410 
411 
412 
417  Angle getSeeing() const;
418 
419 
420 
421 
429  void setSeeing (Angle seeing);
430 
431 
432 
433 
434 
435 
436 
437  // ===> Attribute seeingError
438 
439 
440 
441 
442 
447  Angle getSeeingError() const;
448 
449 
450 
451 
460 
461 
462 
463 
464 
465 
466 
467  // ===> Attribute exponent, which is optional
468 
469 
470 
475  bool isExponentExists() const;
476 
477 
478 
484  float getExponent() const;
485 
486 
487 
488 
495  void setExponent (float exponent);
496 
497 
498 
499 
503  void clearExponent ();
504 
505 
506 
507 
508  // ===> Attribute outerScale, which is optional
509 
510 
511 
516  bool isOuterScaleExists() const;
517 
518 
519 
525  Length getOuterScale() const;
526 
527 
528 
529 
537 
538 
539 
540 
544  void clearOuterScale ();
545 
546 
547 
548 
549  // ===> Attribute outerScaleRMS, which is optional
550 
551 
552 
557  bool isOuterScaleRMSExists() const;
558 
559 
560 
566  Angle getOuterScaleRMS() const;
567 
568 
569 
570 
578 
579 
580 
581 
585  void clearOuterScaleRMS ();
586 
587 
588 
590  // Extrinsic Table Attributes //
592 
593 
594  // ===> Attribute calDataId
595 
596 
597 
598 
599 
604  Tag getCalDataId() const;
605 
606 
607 
608 
618  void setCalDataId (Tag calDataId);
619 
620 
621 
622 
623 
624 
625 
626  // ===> Attribute calReductionId
627 
628 
629 
630 
631 
636  Tag getCalReductionId() const;
637 
638 
639 
640 
651 
652 
653 
654 
655 
656 
658  // Links //
660 
661 
662 
663 
664 
672 
673 
674 
675 
676 
677 
678 
679 
687 
688 
689 
690 
691 
692 
693 
723  bool compareNoAutoInc(AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, std::vector<Frequency > frequencyRange, Interval integrationTime, int numBaseLengths, std::vector<Length > baselineLengths, std::vector<Angle > phaseRMS, Angle seeing, Angle seeingError);
724 
725 
726 
727 
752 
753 
763 
764 #ifndef WITHOUT_ACS
765 
769  asdmIDL::CalSeeingRowIDL *toIDL() const;
770 
778  void toIDL(asdmIDL::CalSeeingRowIDL& x) const;
779 #endif
780 
781 #ifndef WITHOUT_ACS
782 
787  void setFromIDL (asdmIDL::CalSeeingRowIDL x) ;
788 #endif
789 
794  std::string toXML() const;
795 
802  void setFromXML (std::string rowDoc) ;
803 
806  // binary-deserialization material from an EndianIStream //
808 
809  std::map<std::string, CalSeeingAttributeFromBin> fromBinMethods;
811 void calDataIdFromBin( EndianIStream& eis);
819 void phaseRMSFromBin( EndianIStream& eis);
820 void seeingFromBin( EndianIStream& eis);
822 
823 void exponentFromBin( EndianIStream& eis);
824 void outerScaleFromBin( EndianIStream& eis);
826 
827 
835  static CalSeeingRow* fromBin(EndianIStream& eis, CalSeeingTable& table, const std::vector<std::string>& attributesSeq);
836 
843  void fromText(const std::string& attributeName, const std::string& t);
845 
846 private:
855 
856  // This method is used by the Table class when this row is added to the table.
857  void isAdded(bool added);
858 
859 
869 
888 
890  // Intrinsic Table Attributes //
892 
893 
894  // ===> Attribute atmPhaseCorrection
895 
896 
897 
898  AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection;
899 
900 
901 
902 
903 
904 
905  // ===> Attribute startValidTime
906 
907 
908 
910 
911 
912 
913 
914 
915 
916  // ===> Attribute endValidTime
917 
918 
919 
921 
922 
923 
924 
925 
926 
927  // ===> Attribute frequencyRange
928 
929 
930 
931  std::vector<Frequency > frequencyRange;
932 
933 
934 
935 
936 
937 
938  // ===> Attribute integrationTime
939 
940 
941 
943 
944 
945 
946 
947 
948 
949  // ===> Attribute numBaseLengths
950 
951 
952 
954 
955 
956 
957 
958 
959 
960  // ===> Attribute baselineLengths
961 
962 
963 
964  std::vector<Length > baselineLengths;
965 
966 
967 
968 
969 
970 
971  // ===> Attribute phaseRMS
972 
973 
974 
975  std::vector<Angle > phaseRMS;
976 
977 
978 
979 
980 
981 
982  // ===> Attribute seeing
983 
984 
985 
987 
988 
989 
990 
991 
992 
993  // ===> Attribute seeingError
994 
995 
996 
998 
999 
1000 
1001 
1002 
1003 
1004  // ===> Attribute exponent, which is optional
1005 
1006 
1008 
1009 
1010  float exponent;
1011 
1012 
1013 
1014 
1015 
1016 
1017  // ===> Attribute outerScale, which is optional
1018 
1019 
1021 
1022 
1024 
1025 
1026 
1027 
1028 
1029 
1030  // ===> Attribute outerScaleRMS, which is optional
1031 
1032 
1034 
1035 
1037 
1038 
1039 
1040 
1041 
1043  // Extrinsic Table Attributes //
1045 
1046 
1047  // ===> Attribute calDataId
1048 
1049 
1050 
1051  Tag calDataId;
1052 
1053 
1054 
1055 
1056 
1057 
1058  // ===> Attribute calReductionId
1059 
1060 
1061 
1063 
1064 
1065 
1066 
1067 
1069  // Links //
1071 
1072 
1073 
1074 
1075 
1076 
1077 
1078 
1079 
1080 
1081 
1082 
1083 
1084 
1085 
1086 
1087 /*
1089  // binary-deserialization material from an EndianIStream //
1091  std::map<std::string, CalSeeingAttributeFromBin> fromBinMethods;
1092 void atmPhaseCorrectionFromBin( EndianIStream& eis);
1093 void calDataIdFromBin( EndianIStream& eis);
1094 void calReductionIdFromBin( EndianIStream& eis);
1095 void startValidTimeFromBin( EndianIStream& eis);
1096 void endValidTimeFromBin( EndianIStream& eis);
1097 void frequencyRangeFromBin( EndianIStream& eis);
1098 void integrationTimeFromBin( EndianIStream& eis);
1099 void numBaseLengthsFromBin( EndianIStream& eis);
1100 void baselineLengthsFromBin( EndianIStream& eis);
1101 void phaseRMSFromBin( EndianIStream& eis);
1102 void seeingFromBin( EndianIStream& eis);
1103 void seeingErrorFromBin( EndianIStream& eis);
1104 
1105 void exponentFromBin( EndianIStream& eis);
1106 void outerScaleFromBin( EndianIStream& eis);
1107 void outerScaleRMSFromBin( EndianIStream& eis);
1108 
1109 */
1110 
1112  // text-deserialization material //
1114  std::map<std::string, CalSeeingAttributeFromText> fromTextMethods;
1115 
1116 void atmPhaseCorrectionFromText (const std::string & s);
1117 
1118 
1119 void calDataIdFromText (const std::string & s);
1120 
1121 
1122 void calReductionIdFromText (const std::string & s);
1123 
1124 
1125 void startValidTimeFromText (const std::string & s);
1126 
1127 
1128 void endValidTimeFromText (const std::string & s);
1129 
1130 
1131 void frequencyRangeFromText (const std::string & s);
1132 
1133 
1134 void integrationTimeFromText (const std::string & s);
1135 
1136 
1137 void numBaseLengthsFromText (const std::string & s);
1138 
1139 
1140 void baselineLengthsFromText (const std::string & s);
1141 
1142 
1143 void phaseRMSFromText (const std::string & s);
1144 
1145 
1146 void seeingFromText (const std::string & s);
1147 
1148 
1149 void seeingErrorFromText (const std::string & s);
1150 
1151 
1152 
1153 void exponentFromText (const std::string & s);
1154 
1155 
1156 void outerScaleFromText (const std::string & s);
1157 
1158 
1159 void outerScaleRMSFromText (const std::string & s);
1160 
1161 
1162 
1167  void toBin(EndianOSStream& eoss);
1168 
1178 };
1179 
1180 } // End namespace asdm
1181 
1182 #endif /* CalSeeing_CLASS */
Links *binary deserialization material from an EndianIStream std::map< std::string, CalSeeingAttributeFromBin > fromBinMethods
void seeingErrorFromBin(EndianIStream &eis)
The Interval class implements an interval of time in units of nanoseconds.
Definition: Interval.h:58
bool isAdded() const
Has this row been added to its table ?
void integrationTimeFromText(const std::string &s)
void calDataIdFromBin(EndianIStream &eis)
Interval getIntegrationTime() const
===&gt; Attribute integrationTime
Angle seeingError
===&gt; Attribute seeingError
Definition: CalSeeingRow.h:997
void phaseRMSFromBin(EndianIStream &eis)
float getExponent() const
Get exponent, which is optional.
void setExponent(float exponent)
Set exponent with the specified float.
void atmPhaseCorrectionFromText(const std::string &s)
void integrationTimeFromBin(EndianIStream &eis)
void setSeeing(Angle seeing)
Set seeing with the specified Angle.
ArrayTime startValidTime
===&gt; Attribute startValidTime
Definition: CalSeeingRow.h:909
void clearOuterScaleRMS()
Mark outerScaleRMS, which is an optional field, as non-existent.
bool isExponentExists() const
===&gt; Attribute exponent, which is optional
bool hasBeenAdded
Whether this row has been added to the table or not.
Definition: CalSeeingRow.h:854
std::vector< Frequency > getFrequencyRange() const
===&gt; Attribute frequencyRange
std::string toXML() const
Return this row in the form of an XML string.
void setStartValidTime(ArrayTime startValidTime)
Set startValidTime with the specified ArrayTime.
void setNumBaseLengths(int numBaseLengths)
Set numBaseLengths with the specified int.
bool isOuterScaleRMSExists() const
===&gt; Attribute outerScaleRMS, which is optional
void exponentFromText(const std::string &s)
CalSeeingRow(CalSeeingTable &table)
Create a CalSeeingRow.
CalSeeingTable & getTable() const
Return the table to which this row belongs.
void baselineLengthsFromText(const std::string &s)
void calReductionIdFromBin(EndianIStream &eis)
Tag calReductionId
===&gt; Attribute calReductionId
std::vector< Frequency > frequencyRange
===&gt; Attribute frequencyRange
Definition: CalSeeingRow.h:931
void setAtmPhaseCorrection(AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection)
Set atmPhaseCorrection with the specified AtmPhaseCorrectionMod::AtmPhaseCorrection.
void frequencyRangeFromText(const std::string &s)
CalReductionRow * getCalReductionUsingCalReductionId()
calReductionId pointer to the row in the CalReduction table having CalReduction.calReductionId == cal...
Interval integrationTime
===&gt; Attribute integrationTime
Definition: CalSeeingRow.h:942
The Angle class implements a quantity of angle in radians.
Definition: Angle.h:53
bool compareRequiredValue(ArrayTime startValidTime, ArrayTime endValidTime, std::vector< Frequency > frequencyRange, Interval integrationTime, int numBaseLengths, std::vector< Length > baselineLengths, std::vector< Angle > phaseRMS, Angle seeing, Angle seeingError)
Compare each mandatory value (i.e.
asdmIDL::CalSeeingRowIDL * toIDL() const
Return this row in the form of an IDL struct.
std::vector< Length > baselineLengths
===&gt; Attribute baselineLengths
Definition: CalSeeingRow.h:964
void endValidTimeFromText(const std::string &s)
void setFromIDL(asdmIDL::CalSeeingRowIDL x)
Fill the values of this row from the IDL struct CalSeeingRowIDL.
void seeingFromText(const std::string &s)
CalSeeingTable & table
The table to which this row belongs.
Definition: CalSeeingRow.h:850
void setOuterScale(Length outerScale)
Set outerScale with the specified Length.
The CalSeeingRow class is a row of a CalSeeingTable.
Definition: CalSeeingRow.h:140
void outerScaleFromBin(EndianIStream &eis)
void exponentFromBin(EndianIStream &eis)
void phaseRMSFromText(const std::string &s)
void setFromXML(std::string rowDoc)
Fill the values of this row from an XML string that was produced by the toXML() method.
void(CalSeeingRow::* CalSeeingAttributeFromText)(const std::string &s)
Definition: CalSeeingRow.h:132
The CalReductionRow class is a row of a CalReductionTable.
std::vector< Angle > getPhaseRMS() const
===&gt; Attribute phaseRMS
void outerScaleRMSFromBin(EndianIStream &eis)
Angle getSeeing() const
===&gt; Attribute seeing
void clearOuterScale()
Mark outerScale, which is an optional field, as non-existent.
void setFrequencyRange(std::vector< Frequency > frequencyRange)
Set frequencyRange with the specified std::vector&lt;Frequency &gt;.
The Length class implements a quantity of length in meters.
Definition: Length.h:53
std::vector< Length > getBaselineLengths() const
===&gt; Attribute baselineLengths
void clearExponent()
Mark exponent, which is an optional field, as non-existent.
int getNumBaseLengths() const
===&gt; Attribute numBaseLengths
Links *CalDataRow * getCalDataUsingCalDataId()
calDataId pointer to the row in the CalData table having CalData.calDataId == calDataId ...
void setCalDataId(Tag calDataId)
Set calDataId with the specified Tag.
*text deserialization material std::map< std::string, CalSeeingAttributeFromText > fromTextMethods
void calReductionIdFromText(const std::string &s)
Angle getOuterScaleRMS() const
Get outerScaleRMS, which is optional.
The ArrayTime class implements the concept of a point in time, implemented as an Interval of time sin...
Definition: ArrayTime.h:89
void numBaseLengthsFromText(const std::string &s)
Angle getSeeingError() const
===&gt; Attribute seeingError
The Tag class is an implementation of a unique index identifying a row of an ASDM table...
Definition: Tag.h:73
void setEndValidTime(ArrayTime endValidTime)
Set endValidTime with the specified ArrayTime.
void frequencyRangeFromBin(EndianIStream &eis)
ArrayTime getEndValidTime() const
===&gt; Attribute endValidTime
void startValidTimeFromBin(EndianIStream &eis)
void endValidTimeFromBin(EndianIStream &eis)
std::vector< Angle > phaseRMS
===&gt; Attribute phaseRMS
Definition: CalSeeingRow.h:975
void calDataIdFromText(const std::string &s)
void setSeeingError(Angle seeingError)
Set seeingError with the specified Angle.
int numBaseLengths
===&gt; Attribute numBaseLengths
Definition: CalSeeingRow.h:953
ArrayTime endValidTime
===&gt; Attribute endValidTime
Definition: CalSeeingRow.h:920
bool equalByRequiredValue(CalSeeingRow *x)
Return true if all required attributes of the value part are equal to their homologues in x and false...
void setCalReductionId(Tag calReductionId)
Set calReductionId with the specified Tag.
void seeingErrorFromText(const std::string &s)
Angle seeing
===&gt; Attribute seeing
Definition: CalSeeingRow.h:986
bool isOuterScaleExists() const
===&gt; Attribute outerScale, which is optional
void outerScaleRMSFromText(const std::string &s)
bool compareNoAutoInc(AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, std::vector< Frequency > frequencyRange, Interval integrationTime, int numBaseLengths, std::vector< Length > baselineLengths, std::vector< Angle > phaseRMS, Angle seeing, Angle seeingError)
Compare each mandatory attribute except the autoincrementable one of this CalSeeingRow with the corre...
void baselineLengthsFromBin(EndianIStream &eis)
The CalDataRow class is a row of a CalDataTable.
Definition: CalDataRow.h:130
void startValidTimeFromText(const std::string &s)
bool outerScaleRMSExists
===&gt; Attribute outerScaleRMS, which is optional
Tag getCalReductionId() const
===&gt; Attribute calReductionId
ArrayTime getStartValidTime() const
===&gt; Attribute startValidTime
void numBaseLengthsFromBin(EndianIStream &eis)
void(CalSeeingRow::* CalSeeingAttributeFromBin)(EndianIStream &eis)
Definition: CalSeeingRow.h:131
void setPhaseRMS(std::vector< Angle > phaseRMS)
Set phaseRMS with the specified std::vector&lt;Angle &gt;.
Length getOuterScale() const
Get outerScale, which is optional.
void atmPhaseCorrectionFromBin(EndianIStream &eis)
void toBin(EndianOSStream &eoss)
Serialize this into a stream of bytes written to an EndianOSStream.
void setOuterScaleRMS(Angle outerScaleRMS)
Set outerScaleRMS with the specified Angle.
virtual ~CalSeeingRow()
friend class asdm::TableStreamReader&lt;CalSeeingTable, CalSeeingRow&gt;;
void setIntegrationTime(Interval integrationTime)
Set integrationTime with the specified Interval.
void setBaselineLengths(std::vector< Length > baselineLengths)
Set baselineLengths with the specified std::vector&lt;Length &gt;.
void outerScaleFromText(const std::string &s)
bool outerScaleExists
===&gt; Attribute outerScale, which is optional
The CalSeeingTable class is an Alma table.
void seeingFromBin(EndianIStream &eis)
bool exponentExists
===&gt; Attribute exponent, which is optional