/[escript]/trunk/escript/src/DataTagged.h
ViewVC logotype

Diff of /trunk/escript/src/DataTagged.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 499 by jgs, Tue Feb 7 01:27:14 2006 UTC revision 500 by jgs, Tue Feb 7 05:19:07 2006 UTC
# Line 60  class DataTagged : public DataAbstract { Line 60  class DataTagged : public DataAbstract {
60       Default constructor for DataTagged. Creates a DataTagged object for which       Default constructor for DataTagged. Creates a DataTagged object for which
61       the only data-point is a scalar data-point with value 0.0. All tags       the only data-point is a scalar data-point with value 0.0. All tags
62       will map to this single data-point.       will map to this single data-point.
63         T
64    */    */
65    DataTagged();    DataTagged();
66    
# Line 78  class DataTagged : public DataAbstract { Line 79  class DataTagged : public DataAbstract {
79               will be generated.               will be generated.
80       \param defaultValue - Input - Value returned if a requested tag doesn't exist.       \param defaultValue - Input - Value returned if a requested tag doesn't exist.
81       \param what - Input - A description of what this data represents.       \param what - Input - A description of what this data represents.
82         T
83    */    */
84    DataTagged(const TagListType& tagKeys,    DataTagged(const TagListType& tagKeys,
85               const ValueListType& values,               const ValueListType& values,
# Line 98  class DataTagged : public DataAbstract { Line 100  class DataTagged : public DataAbstract {
100    DataTagged(const FunctionSpace& what,    DataTagged(const FunctionSpace& what,
101               const DataArrayView::ShapeType &shape,               const DataArrayView::ShapeType &shape,
102               const int tags[],               const int tags[],
103               const ValueType &data);               const ValueType& data);
104    
105    /**    /**
106       \brief       \brief
# Line 147  class DataTagged : public DataAbstract { Line 149  class DataTagged : public DataAbstract {
149       Write the data as a string.       Write the data as a string.
150       Writes out each tag, including the default, and the data-point which is       Writes out each tag, including the default, and the data-point which is
151       associated with each tag.       associated with each tag.
152         T
153    */    */
154    virtual    virtual
155    std::string    std::string
# Line 156  class DataTagged : public DataAbstract { Line 159  class DataTagged : public DataAbstract {
159       \brief       \brief
160       Return the tag number associated with the given data-point number       Return the tag number associated with the given data-point number
161       according to the associated function space.       according to the associated function space.
162         T
163    */    */
164    virtual    virtual
165    int    int
# Line 171  class DataTagged : public DataAbstract { Line 175  class DataTagged : public DataAbstract {
175    
176       \param sampleNo - Input - sample number.       \param sampleNo - Input - sample number.
177       \param dataPointNo - Input - data-point number.       \param dataPointNo - Input - data-point number.
178         T
179     */     */
180    virtual    virtual
181    ValueType::size_type    ValueType::size_type
# Line 249  class DataTagged : public DataAbstract { Line 254  class DataTagged : public DataAbstract {
254       Description:       Description:
255       Return a view into the data-point associated with the given tag.       Return a view into the data-point associated with the given tag.
256       \param tag - Input - Integer key.       \param tag - Input - Integer key.
257         T
258    */    */
259    DataArrayView    DataArrayView
260    getDataPointByTag(int tag) const;    getDataPointByTag(int tag) const;
# Line 262  class DataTagged : public DataAbstract { Line 268  class DataTagged : public DataAbstract {
268       and data-point numbers.       and data-point numbers.
269       \param sampleNo - Input.       \param sampleNo - Input.
270       \param dataPointNo - Input.       \param dataPointNo - Input.
271         T
272    */    */
273    virtual    virtual
274    DataArrayView    DataArrayView
# Line 274  class DataTagged : public DataAbstract { Line 281  class DataTagged : public DataAbstract {
281    
282       Description:       Description:
283       Return a reference to the tag offset lookup table.       Return a reference to the tag offset lookup table.
284         T
285    */    */
286    const DataMapType&    const DataMapType&
287    getTagLookup() const;    getTagLookup() const;
# Line 287  class DataTagged : public DataAbstract { Line 295  class DataTagged : public DataAbstract {
295    
296       NOTE: The DataTagged tag map does not necessarily coincide with the tag       NOTE: The DataTagged tag map does not necessarily coincide with the tag
297       keys in the associated function space.       keys in the associated function space.
298         T
299     */     */
300    bool    bool
301    isCurrentTag(int tag) const;    isCurrentTag(int tag) const;
# Line 298  class DataTagged : public DataAbstract { Line 307  class DataTagged : public DataAbstract {
307       Description:       Description:
308       Return the default value. This value is associated with any tag which       Return the default value. This value is associated with any tag which
309       is not explicitly recorded in this DataTagged object's tag map.       is not explicitly recorded in this DataTagged object's tag map.
310         T
311    */    */
312    DataArrayView&    DataArrayView&
313    getDefaultValue();    getDefaultValue();
# Line 311  class DataTagged : public DataAbstract { Line 321  class DataTagged : public DataAbstract {
321    
322       Description:       Description:
323       Return the number of doubles stored for the Data.       Return the number of doubles stored for the Data.
324         T
325    */    */
326    virtual    virtual
327    ValueType::size_type    ValueType::size_type
Legend:
Removed from v.499  
changed lines
  Added in v.500
  ViewVC Help
Powered by ViewVC 1.1.26