/[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 1811 by ksteube, Thu Sep 25 23:11:13 2008 UTC revision 1946 by jfenwick, Wed Oct 29 05:48:53 2008 UTC
# Line 65  class DataTagged : public DataAbstract { Line 65  class DataTagged : public DataAbstract {
65    ESCRIPT_DLL_API    ESCRIPT_DLL_API
66    DataTagged();    DataTagged();
67    
 //  /**  
 //      \brief  
 //      Constructor for DataTagged.  
 //  
 //      Description:  
 //      Constructor for DataTagged.  
 //      \param tagKeys - Input - A vector of integer tags.  
 //      \param values - Input - A vector of DataArrayViews. If this is empty  
 //                      all tag values will be assigned a scalar data-point of value  
 //                      0. If it contains one value all tag values will be assigned  
 //           this value. Otherwise consecutive tags will be assigned  
 //                      consecutive values.  If there is a mismatch between  the  
 //           number of keys and the number of values an exception  
 //           will be generated.  
 //      \param defaultValue - Input - Value returned if a requested tag doesn't exist.  
 //      \param what - Input - A description of what this data represents.  
 //     T  
 //  */  
 //   ESCRIPT_DLL_API  
 //   DataTagged(const TagListType& tagKeys,  
 //              const ValueListType& values,  
 //       const DataArrayView& defaultValue,  
 //       const FunctionSpace& what);  
   
68    /**    /**
69       \brief       \brief
70       Alternative Constructor for DataTagged.       Alternative Constructor for DataTagged.
# Line 254  TODO Make sure to document the relations Line 230  TODO Make sure to document the relations
230    
231    
232    
 //  /**  
 //      \brief  
 //      addTaggedValues  
 //  
 //      Description:  
 //      Add the given tags and values to this DataTagged object.  
 //      \param tagKeys - Input - A vector of integer tags.  
 //      \param values - Input - A vector of DataArrayViews. If this is empty  
 //                      all tag values will be assigned a scalar data-point of value  
 //                      0. If it contains one value all tag values will be assigned  
 //           this value. Otherwise consecutive tags will be assigned  
 //                      consecutive values.  If there is a mismatch between  the  
 //           number of keys and the number of values an exception  
 //           will be generated.  
 //     T  
 //  */  
 //   ESCRIPT_DLL_API  
 //   void  
 //   addTaggedValues(const TagListType& tagKeys,  
 //                   const ValueListType& values);    
   
 //  /**  
 //      \brief  
 //      addTaggedValue  
 //  
 //      Description:  
 //      Add a single tag and value to this DataTagged object. If this tag already has  
 //      a value associated with it, setTaggedValue will be used to update this value.  
 //      \param tagKey - Input - Integer tag.  
 //      \param value - Input - Single DataArrayView value to be assigned to the tag.  
 //     T  
  // */  
 //   ESCRIPT_DLL_API  
 //   void  
 //   addTaggedValue(int tagKey,  
 //                  const DataArrayView& value);  
   
   
   
233   /**   /**
234       \brief       \brief
235       addTaggedValues       addTaggedValues
# Line 375  TODO Make sure to document the relations Line 312  TODO Make sure to document the relations
312    void    void
313    addTag(int tagKey);    addTag(int tagKey);
314    
   
 //  /**  
 //      \brief  
 //      setTaggedValues  
 //  
 //      Description:  
 //      Set the given tags to the given values in this DataTagged object.  
 //      \param tagKeys - Input - A vector of integer tag.  
 //      \param values - Input - A vector of DataArrayViews. If this is empty  
 //                      all tag values will be assigned a scalar data-point of value  
 //                      0. If it contains one value all tag values will be assigned  
 //           this value. Otherwise consecutive tags will be assigned  
 //                      consecutive values.  If there is a mismatch between  the  
 //           number of keys and the number of values an exception  
 //           will be generated.  
 //     T  
 //  */  
 //   ESCRIPT_DLL_API  
 //   void  
 //   setTaggedValues(const TagListType& tagKeys,  
 //                   const ValueListType& values);  
   
 //  /**  
 //      \brief  
 //      setTaggedValue  
 //  
 //      Description:  
 //      Assign the given value to the given tag.  
 //      \param tagKey - Input - Integer tag.  
 //      \param value - Input - Single DataArrayView value to be assigned to the tag.  
 //     T  
 //  */  
 //   ESCRIPT_DLL_API  
 //   virtual  
 //   void  
 //   setTaggedValue(int tagKey,  
 //                  const DataArrayView& value);  
   
315    /**    /**
316       \brief       \brief
317       setTaggedValue       setTaggedValue
# Line 432  TODO Make sure to document the relations Line 331  TODO Make sure to document the relations
331                   const ValueType& value,                   const ValueType& value,
332           int dataOffset=0);           int dataOffset=0);
333    
   
 //  /**  
 //      \brief  
 //      getDataPointByTag  
 //  
 //      Description:  
 //      Return data-point associated with the given tag as a DataArrayView.  
 //      \param tag - Input - Integer key.  
 //     T  
 //  */  
 //   ESCRIPT_DLL_API  
 //   DataArrayView  
 //   getDataPointByTag(int tag) const;  
   
334    /**    /**
335       \brief       \brief
336       getDataByTag       getDataByTag
# Line 478  TODO Make sure to document the relations Line 363  TODO Make sure to document the relations
363    DataTypes::ValueType::size_type    DataTypes::ValueType::size_type
364    getOffsetForTag(int tag) const;    getOffsetForTag(int tag) const;
365    
 //  /**  
 //      \brief  
 //      getDataPoint  
 //  
 //      Description:  
 //      Return the data-point specified by the given sample and data-point  
 //      numbers as a DataArrayView.  
 //      \param sampleNo - Input.  
 //      \param dataPointNo - Input.  
 //     T  
 //  */  
 //   ESCRIPT_DLL_API  
 //   virtual  
 //   DataArrayView  
 //   getDataPoint(int sampleNo,  
 //                int dataPointNo);  
   
366    
367    /**    /**
368       \brief       \brief
# Line 550  TODO Make sure to document the relations Line 418  TODO Make sure to document the relations
418    bool    bool
419    isCurrentTag(int tag) const;    isCurrentTag(int tag) const;
420    
 // /**  
 //      \brief  
 //      getDefaultValue  
 //  
 //      Description:  
 //      Return the default value. This value is associated with any tag which  
 //      is not explicitly recorded in this DataTagged object's tag map.  
 //     T  
 //  */  
 //   ESCRIPT_DLL_API  
 //   DataArrayView&  
 //   getDefaultValue();  
 //  
 //   ESCRIPT_DLL_API  
 //   const DataArrayView&  
 //   getDefaultValue() const;  
   
421    /**    /**
422       \brief       \brief
423       getDefaultValue       getDefaultValue

Legend:
Removed from v.1811  
changed lines
  Added in v.1946

  ViewVC Help
Powered by ViewVC 1.1.26