73 void ConfigureFile (const std::string &outputFileNameWithoutExtension, |
73 void ConfigureFile (const std::string &outputFileNameWithoutExtension, |
74 enum FileAggregator::FileType fileType = FileAggregator::SPACE_SEPARATED); |
74 enum FileAggregator::FileType fileType = FileAggregator::SPACE_SEPARATED); |
75 |
75 |
76 /** |
76 /** |
77 * \param typeId the type ID for the probe used when it is created. |
77 * \param typeId the type ID for the probe used when it is created. |
78 * \param path Config path to access the probe. |
78 * \param path Config path for underlying trace source to be probed |
79 * \param probeTraceSource the probe trace source to access. |
79 * \param probeTraceSource the probe trace source to access. |
80 * |
80 * |
81 * Creates output files generated by hooking the ns-3 trace source |
81 * Creates output files generated by hooking the ns-3 trace source |
82 * with a probe, and then writing the values from the |
82 * with a probe, and then writing the values from the |
83 * probeTraceSource. The output file names will have the text stored |
83 * probeTraceSource. The output file names will have the text stored |
84 * in m_outputFileNameWithoutExtension plus ".txt", and will consist |
84 * in m_outputFileNameWithoutExtension plus ".txt", and will consist |
85 * of the 'newValue' at each timestamp. |
85 * of the 'newValue' at each timestamp. |
|
86 * |
|
87 * This method will create one or more probes according to the TypeId |
|
88 * provided, connect the probe(s) to the trace source specified by |
|
89 * the config path, and hook the probeTraceSource(s) to the downstream |
|
90 * aggregator. |
86 * |
91 * |
87 * If the config path has more than one match in the system |
92 * If the config path has more than one match in the system |
88 * (e.g. there is a wildcard), then one output file for each match |
93 * (e.g. there is a wildcard), then one output file for each match |
89 * will be created. The output file names will contain the text in |
94 * will be created. The output file names will contain the text in |
90 * m_outputFileNameWithoutExtension plus the matched characters for |
95 * m_outputFileNameWithoutExtension plus the matched characters for |
101 void WriteProbe (const std::string &typeId, |
106 void WriteProbe (const std::string &typeId, |
102 const std::string &path, |
107 const std::string &path, |
103 const std::string &probeTraceSource); |
108 const std::string &probeTraceSource); |
104 |
109 |
105 /** |
110 /** |
106 * \param typeId the type ID for the probe used when it is created. |
|
107 * \param probeName the probe's name. |
|
108 * \param path Config path to access the probe |
|
109 * |
|
110 * \brief Adds a probe to be used to write values to files. |
|
111 */ |
|
112 void AddProbe (const std::string &typeId, |
|
113 const std::string &probeName, |
|
114 const std::string &path); |
|
115 |
|
116 /** |
|
117 * \param adaptorName the timeSeriesAdaptor's name. |
111 * \param adaptorName the timeSeriesAdaptor's name. |
118 * |
112 * |
119 * \brief Adds a time series adaptor to be used to write the file. |
113 * \brief Adds a time series adaptor to be used to write the file. |
120 */ |
114 */ |
121 void AddTimeSeriesAdaptor (const std::string &adaptorName); |
115 void AddTimeSeriesAdaptor (const std::string &adaptorName); |
250 * function. |
244 * function. |
251 */ |
245 */ |
252 void Set10dFormat (const std::string &format); |
246 void Set10dFormat (const std::string &format); |
253 |
247 |
254 private: |
248 private: |
|
249 /** |
|
250 * \param typeId the type ID for the probe used when it is created. |
|
251 * \param probeName the probe's name. |
|
252 * \param path Config path to access the probe |
|
253 * |
|
254 * \brief Adds a probe to be used to write values to files. |
|
255 */ |
|
256 void AddProbe (const std::string &typeId, |
|
257 const std::string &probeName, |
|
258 const std::string &path); |
|
259 |
255 /** |
260 /** |
256 * \param typeId the type ID for the probe used when it is created. |
261 * \param typeId the type ID for the probe used when it is created. |
257 * \param matchIdentifier this string is used to make the probe's |
262 * \param matchIdentifier this string is used to make the probe's |
258 * context be unique. |
263 * context be unique. |
259 * \param path Config path to access the probe. |
264 * \param path Config path to access the probe. |