Changeset 518 for vtcross/trunk/src/include/vtcross/libvtcross.h
- Timestamp:
- 11/13/09 15:37:02 (14 years ago)
- Files:
-
- 1 modified
-
vtcross/trunk/src/include/vtcross/libvtcross.h (modified) (11 diffs)
Legend:
- Unmodified
- Added
- Removed
-
vtcross/trunk/src/include/vtcross/libvtcross.h
r498 r518 15 15 */ 16 16 17 /* VTCROSS Cognitive Radio API17 /*! CROSS Cognitive Radio API 18 18 * 19 * This header exports all public functions that comprise the VTCROSS function 20 * library. 19 * This header exports all public functions that comprise the CROSS function 20 * library. These are the functions that are used by the host application to 21 * control the CROSS radio. 21 22 * 22 23 * PUT MORE STUFF HERE 23 24 */ 24 25 25 #ifndef LIB VTCROSS_H26 #define LIB VTCROSS_H26 #ifndef LIBCROSS_H 27 #define LIBCROSS_H 27 28 28 29 #include <stdint.h> … … 33 34 34 35 35 /* Sets the location of the shell component that the client code will be 36 /*! \brief Tell the system where the Shell component is located. 37 * 38 * Sets the location of the shell component that the client code will be 36 39 * communicating with. Note that this can be a local or remote destination. 37 40 */ … … 39 42 40 43 41 /* Parses VTCROSSXML configuration file and uses it to configure the radio.44 /*! \brief Parses XML configuration file and uses it to configure the radio. 42 45 * 43 46 * This function *must* be called when the radio first starts up, and may be … … 47 50 48 51 49 /* Lists current radio configuration options loaded from the configuration XML 50 * file. 52 /*! \brief Lists current radio configuration options loaded from the XML. 51 53 * 52 54 * TODO How are we listing these? Are we simply returning them to stdout? … … 56 58 57 59 58 /* View data from the current status of the radio.60 /*! \brief View data from the current status of the radio. 59 61 * 60 62 * This function allows client code to capture radio properties at any certain … … 68 70 69 71 70 /* View components currently connected to the radio by id.72 /*! \brief View components currently connected to the radio by id. 71 73 * 72 74 * TODO Should there be another way to list components? If you have 10 cognitive … … 79 81 80 82 81 /* Look up component information by id.83 /*! \brief Look up component information by id. 82 84 * 83 85 * Note that the return type is of abstract base class component, which can then … … 87 89 88 90 89 /* Given a certain set of observables, ask the radio to find the optimum radio90 * parameters and return them.91 /*! \brief Given a certain set of observables, ask the radio to find the 92 * optimum radio parameters and return them. 91 93 * 92 94 * TODO I'm a little confused about this function... why would anyone need to … … 97 99 98 100 99 /* Update the radio regarding its performance for a certain set of transmission 100 * parameters, observables, and utilities. 101 /*! \brief Update the radio regarding its performance. 101 102 * 102 * TODO Where in the function parameters are we accurately representing the 103 * radio's performance? 103 * TODO 104 104 */ 105 105 bool UpdateParameterPerformance(Parameter *p, uint32_t numParameters, Observable *o, \ 106 106 uint32_t numObservables); 107 107 108 /* Deactivate/Activate/Disconnect a component by id.108 /*! \brief Deactivate/Activate/Disconnect a component by id. 109 109 */ 110 110 bool ActivateComponent(uint32_t id); … … 112 112 bool DisconnectComponent(uint32_t id); 113 113 114 /*! \brief Set the active mission of the CROSS radio. 115 */ 114 116 uint32_t SetActiveMission(char * activeMission); 115 117 116 /* Shut down the radio.118 /*! \brief Shut down the radio. 117 119 * 118 120 * This function will deactivate and disconnect all radio components before … … 121 123 bool Shutdown(); 122 124 123 /* Return total number of currently recognized transmission parameters.125 /*! \brief Return total number of currently recognized transmission parameters. 124 126 */ 125 127 uint32_t GetNumParameters();
