XdkWrl: geometadata.h Source File

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

Generated on 5 Jan 2007 with version 1.5.1. |