Home Hierarchy Members Alphabetical Related Pages

geometadata.h

Go to the documentation of this file.
00001 #ifndef XDKWRL_GEOMETADATA_H
00002 #define XDKWRL_GEOMETADATA_H
00003 
00004 #include <xdkwrl/node.h>
00005 #include <xdkwrl/fieldtypes/mfnode.h>
00006 #include <xdkwrl/fieldtypes/mfstring.h>
00007 
00008 namespace wrl
00009 {
00010   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00011   // Interface of GeoMetadata
00012   //++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
00013   class GeoMetadata : public Node
00014   {
00015    public:
00016      GeoMetadata(const char* name="");
00017      virtual ~GeoMetadata();
00018      virtual inline unsigned int nbFields() const;
00019      virtual FieldHandle field(const std::string& n);
00020      virtual FieldHandle field(const unsigned int i);
00021      virtual bool isSetToDefaultValue(const unsigned int i) const;
00022      virtual inline unsigned int nbEventsIn() const;
00023      virtual EventInHandle eventIn(const std::string& n);
00024      virtual EventInHandle eventIn(const unsigned int i);
00025      virtual inline unsigned int nbEventsOut() const;
00026      virtual EventOutHandle eventOut(const std::string& n);
00027      virtual EventOutHandle eventOut(const unsigned int i);
00028      inline const char* typeName() const;
00029      virtual Node* duplicate() const;
00030      virtual Node* duplicate(std::map<const Node*,Node*>&) const;
00031      /*!@name Exposed Fields
00032       * A field that is capable of receiving events via an eventIn to 
00033       * change its value(s), and generating events via an eventOut 
00034       * when its value(s) change.
00035       */
00036       //!@{
00037       /*!
00038        * See <a href="#_details" class="md">Detailed Description</a>
00039        * for meaning of this field.
00040        * Default value is set to MFNode default value
00041        */
00042        MFNode     data;
00043       /*!
00044        * See <a href="#_details" class="md">Detailed Description</a>
00045        * for meaning of this field.
00046        * Default value is set to MFString default value
00047        */
00048        MFString   summary;
00049       /*!
00050        * See <a href="#_details" class="md">Detailed Description</a>
00051        * for meaning of this field.
00052        * Default value is set to MFString default value
00053        */
00054        MFString   url;
00055      //!@}
00056      /*!@name Fields
00057       * A property or attribute of a node. Each node type has a fixed set
00058       * of fields. Fields may contain various kinds of data and one or many
00059       * values. Each field has a default value.
00060       */
00061       //!@{
00062      //!@}
00063      /*!@name Events In
00064       * 
00065       */
00066       //!@{
00067       /*!
00068        * Set event associated to exposedField data
00069        */
00070        EventIn<MFNode>     set_data;
00071       /*!
00072        * Set event associated to exposedField summary
00073        */
00074        EventIn<MFString>   set_summary;
00075       /*!
00076        * Set event associated to exposedField url
00077        */
00078        EventIn<MFString>   set_url;
00079   //!@}
00080      /*!@name Events Out
00081       * 
00082       */
00083       //!@{
00084       /*!
00085        * Changed event associated to exposedField data
00086        */
00087        EventOut<MFNode>     data_changed;
00088       /*!
00089        * Changed event associated to exposedField summary
00090        */
00091        EventOut<MFString>   summary_changed;
00092       /*!
00093        * Changed event associated to exposedField url
00094        */
00095        EventOut<MFString>   url_changed;
00096   //!@}
00097   };
00098 };
00099 //************************************************************
00100 // Implementation of GeoMetadata
00101 //************************************************************
00102 /*!
00103  * Returns <code>"GeoMetadata"</code>. Useful for printing.
00104  */
00105 inline const char*
00106 wrl::GeoMetadata::typeName() const
00107 {
00108   return "GeoMetadata";
00109 }
00110 /*!
00111  * Returns the number of fields (exposed or not) for this node type.
00112  */
00113 inline unsigned int
00114 wrl::GeoMetadata::nbFields() const
00115 {
00116    return 3;
00117 }
00118 /*!
00119  * Returns the number of events in for this node type.
00120  */
00121 inline unsigned int
00122 wrl::GeoMetadata::nbEventsIn() const
00123 {
00124    return 0;
00125 }
00126 /*!
00127  * Returns the number of events out for this node type.
00128  */
00129 inline unsigned int
00130 wrl::GeoMetadata::nbEventsOut() const
00131 {
00132    return 0;
00133 }
00134 #endif // XDKWRL_GEOMETADATA_H
00135 
00136 // Local variables section.
00137 // This is only used by emacs!
00138 // Local Variables:
00139 // ff-search-directories: ("../../" "../../../src/xdkwrl/nodes")
00140 // End:

Generated on 24 Feb 2005 with doxygen version 1.3.9.1. Valid HTML 4.0! Valid CSS!