Show
Ignore:
Timestamp:
05/17/10 03:14:03 (14 years ago)
Author:
nikhil
Message:
 
Location:
vtcross/branches/nikhil/crossmodel1
Files:
1 modified
1 copied

Legend:

Unmodified
Added
Removed

  • vtcross/branches/nikhil/crossmodel1/src/include/vtcross/libvtcross.h

    r536 r554  
    3939 * communicating with. Note that this can be a local or remote destination. 
    4040 */ 
     41 
    4142void SetCrossShellLocation(std::string hostname, std::string port); 
    4243 
     44Parameter* GetOptimalParameters(Observable *radioObservables, uint32_t numObservables, Parameter *currentParameters, uint32_t numCurrentParameters, Utility *radioUtilities, uint32_t numUtilities); 
    4345 
    44 /*! \brief  Parses XML configuration file and uses it to configure the radio.  
    45  * 
    46  * This function *must* be called when the radio first starts up, and may be 
    47  * called at any point after that to reconfigure the radio. 
    48  */ 
    49 bool ParseRadioConfiguration(); 
     46bool UpdateParameterPerformance(Parameter *p, uint32_t numParameters, Observable *o, uint32_t numObservables, Utility *u, uint32_t numUtilities); 
    5047 
    51  
    52 /*! \brief Lists current radio configuration options loaded from the XML. 
    53  * 
    54  * TODO How are we listing these?  Are we simply returning them to stdout? 
    55  * Logging them? Returning strings?  Need to figure this out... 
    56  */ 
    57 void ListCurrentRadioConfiguration(); 
    58  
    59  
    60 /*! \brief View data from the current status of the radio.  
    61  * 
    62  * This function allows client code to capture radio properties at any certain 
    63  * instant.  Note, however, that these properties could be changing at very 
    64  * rapid rates. There is no guarantee that the return results from these 
    65  * functions will still be valid by the time the client code receives them. 
    66  */ 
    67 Observable* GetRadioObservables(); 
    68 Parameter* GetRadioParameters(); 
    69 Utility* GetRadioUtilities(); 
    70  
    71  
    72 /*! \brief View components currently connected to the radio by id.  
    73  * 
    74  * TODO Should there be another way to list components? If you have 10 cognitive 
    75  * engines, how are you going to know which is which just by id? 
    76  */ 
    77 uint32_t* GetConnectedCognitiveEngines(); 
    78 uint32_t* GetConnectedPolicyEngines(); 
    79 uint32_t* GetConnectedManagementServiceLayers(); 
    80 uint32_t* GetConnectedComponents(); 
    81  
    82  
    83 /*! \brief  Given a certain set of observables, ask the radio to find the  
    84  * optimum radio parameters and return them.  
    85  * 
    86  * TODO I'm a little confused about this function... why would anyone need to 
    87  * use this?  Shouldn't this be internal to the radio operation?  
    88  */ 
    89 Parameter* GetOptimalParameters(Observable *radioObservables, uint32_t numObservables,  
    90                 Parameter *currentParameters, uint32_t numCurrentParameters); 
    91  
    92  
    93 /*! \brief  Update the radio regarding its performance. 
    94  * 
    95  * TODO 
    96  */ 
    97 bool UpdateParameterPerformance(Parameter *p, uint32_t numParameters, Observable *o, \ 
    98         uint32_t numObservables); 
    99  
    100 /*! \brief Deactivate/Activate/Disconnect a component by id. 
    101  */ 
    102 bool ActivateComponent(uint32_t id); 
    103 bool DeactivateComponent(uint32_t id); 
    104 bool DisconnectComponent(uint32_t id); 
    105  
    106 /*! \brief Set the active mission of the CROSS radio. 
    107  */ 
    108 uint32_t SetActiveMission(char * activeMission); 
    109  
    110 /*! \brief Shut down the radio. 
    111  * 
    112  * This function will deactivate and disconnect all radio components before 
    113  * finally shutting down the shell and stopping radio operations. 
    114  */ 
    115 bool Shutdown(); 
    116  
    117 /*! \brief Return total number of currently recognized transmission parameters. 
    118  */ 
    119 uint32_t GetNumParameters(); 
    120 uint32_t GetNumObservables(); 
    121 uint32_t GetNumUtilities(); 
    122  
     48uint32_t GetNum(std::string); 
    12349 
    12450#endif