Home Hierarchy Members Alphabetical Related Pages

geolocation.h

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

Generated on 5 Jan 2007 with doxygen version 1.5.1. Valid HTML 4.0! Valid CSS!