Show
Ignore:
Timestamp:
11/13/09 15:37:02 (14 years ago)
Author:
bhilburn
Message:

Added Doxygen documentation to headers in the include/vtcross directory.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • vtcross/trunk/src/include/vtcross/cross_shell.h

    r465 r518  
    1515*/ 
    1616 
    17 /* This header exports the declaration for the VTCROSS Shell component, which is 
    18  * a critical part of every VTCROSS system.  
     17/*! This header exports the declaration for the CROSS Shell component, which is 
     18 * a critical part of every CROSS system.  
    1919 */ 
    2020 
    … …  
    2626 
    2727 
    28 /* Cognitive Radio Shell class declaration.  
     28/*! \brief Cognitive Radio Shell class declaration.  
     29 * 
     30 * The CROSS Cognitive Radio Shell (CRS) is the central control component of 
     31 * most CROSS radios.  It is a requirement for any CROSS radio, regardless of 
     32 * the presence or lack thereof of the SML. 
    2933 */ 
    3034class CognitiveRadioShell  
    3135{ 
    3236    public: 
     37        /*! \brief Default CRS costructor. */ 
    3338        CognitiveRadioShell(); 
     39 
     40        /*! \brief Default CRS destructor. */ 
    3441        ~CognitiveRadioShell(); 
    3542 
    36         /* Overloaded constructor that creates a CR Shell object and loads the 
     43        /*! \brief Preferred CRS constructor. 
     44         * 
     45         * Overloaded constructor that creates a CR Shell object and loads the 
    3746         * passed radio configuration XML file. 
    3847         */ 
    … …  
    4049            int16_t policyPort, int16_t commandPort); 
    4150 
    42         /* Ask for the component type of a remote component via sockets, or 
    43          * respond to such a query sent to the shell itself. 
    44          */ 
     51        /*! \brief Request the component type of a remote component. */ 
    4552        std::string GetRemoteComponentType(int32_t socketFD); 
     53 
     54        /*! \brief Respond to a request to identify component type. */ 
    4655        void SendComponentType(int32_t socketFD); 
    4756 
     57        /*! \brief Shutdown the CRS. 
     58         * 
     59         * Since the CRS is the central control component of the CROSS radio, 
     60         * shutting down the CRS will shutdown the entire radio. 
     61         */ 
    4862        void Shutdown(); 
     63 
     64        /*! \brief Restart the CRS. 
     65         * 
     66         * Restart the CRS component - reloads configuration files, and 
     67         * re-initializes the CRS component. 
     68         */ 
    4969        void Reset(); 
    5070         
    51         /* Start all the socket servers */ 
     71        /*! \brief Start the CRS's socket server.  
     72         * 
     73         * This function will make the CRS create a socket server and begin 
     74         * listening for incoming connections from other components. 
     75         */ 
    5276        void StartShellServer();  
    5377 
     78        /*! \brief Load the radio configuration. 
     79         * 
     80         * This function reads in the radio's XML configuration file, which is 
     81         * typically located on the same system as the CRS, although it can also 
     82         * be passed to the CRS from the radio host platform if necessary. 
     83         */ 
    5484        int32_t LoadRadioConfiguration(const char* radioConfig, Parameter* &pList, \ 
    5585            Utility* &uList, Observable* &oList, Radio_Info* radioInfo); 
    5686    private: 
    57         /* Parse and load/reload policies into the policy engine. 
    58          */ 
    59         void LoadPolicies(); 
    60         void ReloadPolicies(); 
    61  
    62         /* Register and Deregister the different components. 
     87        /*! \brief Handle component registration activities. 
     88         * 
     89         * Register and Deregister the different components. 
     90         * TODO Are multiple functions really necessary?  They are all basically 
     91         * doing the same thing... 
    6392         */ 
    6493        void RegisterCognitiveEngine(int32_t socketFD); 
    … …  
    6998        void DeregisterSML(int32_t socketFD); 
    7099         
     100        /*! \brief Set the active mission. 
     101         * 
     102         * This function handles a request by the radio host platform to set or 
     103         * change the current active mission in the service management layer. 
     104         * This command is basically passed through the CRS to the SML. 
     105         */ 
    71106        void SetActiveMission(int32_t socketFD); 
    72107 
    … …  
    75110        int32_t HandleMessage(int32_t socketFD); 
    76111        
    77         /* Send optimization request to primary port FD. 
     112        /*! \brief Send optimization request to CE. 
     113         * 
     114         * The host application requested that parameters be optimized - pass 
     115         * the parameters and command to the CE. 
     116         * 
     117         * TODO How is the CE being selected if multiple CEs are available? 
    78118         */ 
    79119        void GetOptimalParameters(int32_t socketFD); 
    80120 
    81         /* TODO 
     121        /*! TODO 
    82122         */ 
    83123        bool SendRadioConfiguration(int32_t socketFD); 
    84124        bool SendRadioExperience(int32_t socketFD); 
    85125 
    86         /* TODO 
     126        /*! TODO 
    87127         */ 
    88128        bool UpdateParameterPerformance(int32_t socketFD); 
    89129 
    90         /* TODO 
     130        /*! TODO 
    91131         */ 
    92132        bool SML_present; 
    … …  
    94134        bool CE_present; 
    95135        
    96         /* TODO 
     136        /*! TODO 
    97137         */ 
    98138        int32_t numberOfCognitiveEngines;  
    99139 
    100         /* TODO 
     140        /*! TODO 
    101141         */        
    102142        int16_t primaryPort; 
    … …  
    104144        int16_t commandPort; 
    105145 
    106         /* TODO 
     146        /*! TODO 
     147         * 
     148         * I'm confused as to what exactly these are for... there can be 
     149         * multiple CEs and PEs, and the CRS _IS_ the command component. 
     150         * --BCH 
    107151         */ 
    108152        int32_t ceSocketFD; 
    … …  
    110154        int32_t policySocketFD; 
    111155 
    112         /* TODO 
     156        /*! TODO 
    113157         */ 
    114158        Utility *utils; 
    … …  
    116160        Observable *observables; 
    117161 
    118         /* TODO 
     162        /*! TODO 
    119163         */ 
    120164        struct Radio_Info *radio_info;