eapol/eapol_framework/eapol_common/type/simple_config/simple_config/include/simple_config_completion.h
changeset 49 43351a4f2da3
parent 26 9abfd4f00d37
equal deleted inserted replaced
47:712b4ffd76bb 49:43351a4f2da3
    24 
    24 
    25 #include "eap_tools.h"
    25 #include "eap_tools.h"
    26 #include "eap_array.h"
    26 #include "eap_array.h"
    27 //#include "simple_config_record_message.h"
    27 //#include "simple_config_record_message.h"
    28 #include "abs_simple_config_message_hash.h"
    28 #include "abs_simple_config_message_hash.h"
       
    29 #include "eap_am_export.h"
       
    30 // Start: added by script change_export_macros.sh.
       
    31 #if defined(EAP_NO_EXPORT_SIMPLE_CONFIG_COMPLETION_H)
       
    32 	#define EAP_CLASS_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H EAP_NONSHARABLE 
       
    33 	#define EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H 
       
    34 	#define EAP_C_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H 
       
    35 	#define EAP_FUNC_EXPORT_SIMPLE_CONFIG_COMPLETION_H 
       
    36 	#define EAP_C_FUNC_EXPORT_SIMPLE_CONFIG_COMPLETION_H 
       
    37 #elif defined(EAP_EXPORT_SIMPLE_CONFIG_COMPLETION_H)
       
    38 	#define EAP_CLASS_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H EAP_EXPORT 
       
    39 	#define EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H EAP_FUNC_EXPORT 
       
    40 	#define EAP_C_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H EAP_C_FUNC_EXPORT 
       
    41 	#define EAP_FUNC_EXPORT_SIMPLE_CONFIG_COMPLETION_H EAP_FUNC_EXPORT 
       
    42 	#define EAP_C_FUNC_EXPORT_SIMPLE_CONFIG_COMPLETION_H EAP_C_FUNC_EXPORT 
       
    43 #else
       
    44 	#define EAP_CLASS_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H EAP_IMPORT 
       
    45 	#define EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H EAP_FUNC_IMPORT 
       
    46 	#define EAP_C_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H EAP_C_FUNC_IMPORT 
       
    47 	#define EAP_FUNC_EXPORT_SIMPLE_CONFIG_COMPLETION_H 
       
    48 	#define EAP_C_FUNC_EXPORT_SIMPLE_CONFIG_COMPLETION_H 
       
    49 #endif
       
    50 // End: added by script change_export_macros.sh.
       
    51 
    29 
    52 
    30 /** @file */
    53 /** @file */
    31 
    54 
    32 /**
    55 /**
    33  * This is enumeration of SIMPLE_CONFIG competion actions.
    56  * This is enumeration of SIMPLE_CONFIG competion actions.
    40 
    63 
    41 //----------------------------------------------------------------------------
    64 //----------------------------------------------------------------------------
    42 
    65 
    43 
    66 
    44 /// This class defines one SIMPLE_CONFIG completion action.
    67 /// This class defines one SIMPLE_CONFIG completion action.
    45 class EAP_EXPORT simple_config_completion_c
    68 class EAP_CLASS_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H simple_config_completion_c
    46 {
    69 {
    47 private:
    70 private:
    48 	//--------------------------------------------------
    71 	//--------------------------------------------------
    49 
    72 
    50 	/// This is pointer to the tools class. @see abs_eap_am_tools_c.
    73 	/// This is pointer to the tools class. @see abs_eap_am_tools_c.
    58 
    81 
    59 	/**
    82 	/**
    60 	 * The set_is_valid() function sets the state of the object valid.
    83 	 * The set_is_valid() function sets the state of the object valid.
    61 	 * The creator of this object calls this function after it is initialized. 
    84 	 * The creator of this object calls this function after it is initialized. 
    62 	 */
    85 	 */
    63 	EAP_FUNC_IMPORT void set_is_valid();
    86 	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H void set_is_valid();
    64 
    87 
    65 	//--------------------------------------------------
    88 	//--------------------------------------------------
    66 protected:
    89 protected:
    67 	//--------------------------------------------------
    90 	//--------------------------------------------------
    68 
    91 
    71 	//--------------------------------------------------
    94 	//--------------------------------------------------
    72 
    95 
    73 	/**
    96 	/**
    74 	 * Destructor does nothing special.
    97 	 * Destructor does nothing special.
    75 	 */
    98 	 */
    76 	EAP_FUNC_IMPORT virtual ~simple_config_completion_c();
    99 	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H virtual ~simple_config_completion_c();
    77 
   100 
    78 	/**
   101 	/**
    79 	 * Constructor initializes object.
   102 	 * Constructor initializes object.
    80 	 */
   103 	 */
    81 	EAP_FUNC_IMPORT simple_config_completion_c(
   104 	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H simple_config_completion_c(
    82 		abs_eap_am_tools_c * const tools,
   105 		abs_eap_am_tools_c * const tools,
    83 		simple_config_completion_action_e completion_action);
   106 		simple_config_completion_action_e completion_action);
    84 
   107 
    85 	/**
   108 	/**
    86 	 * Object must indicate it's validity.
   109 	 * Object must indicate it's validity.
    87 	 * If object initialization fails this function must return false.
   110 	 * If object initialization fails this function must return false.
    88 	 * @return This function returns the validity of this object.
   111 	 * @return This function returns the validity of this object.
    89 	 */
   112 	 */
    90 	EAP_FUNC_IMPORT bool get_is_valid();
   113 	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H bool get_is_valid();
    91 
   114 
    92 	/**
   115 	/**
    93 	 * This function sets the completion action type.
   116 	 * This function sets the completion action type.
    94 	 */
   117 	 */
    95 	EAP_FUNC_IMPORT void set_completion_action(simple_config_completion_action_e completion_action);
   118 	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H void set_completion_action(simple_config_completion_action_e completion_action);
    96 
   119 
    97 	/**
   120 	/**
    98 	 * This function gets the completion action type.
   121 	 * This function gets the completion action type.
    99 	 */
   122 	 */
   100 	EAP_FUNC_IMPORT simple_config_completion_action_e get_completion_action() const;
   123 	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H simple_config_completion_action_e get_completion_action() const;
   101 
   124 
   102 	/**
   125 	/**
   103 	 * This function gets the debug string of the completion action type.
   126 	 * This function gets the debug string of the completion action type.
   104 	 */
   127 	 */
   105 	EAP_FUNC_IMPORT eap_const_string  get_completion_action_string() const;
   128 	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_COMPLETION_H eap_const_string  get_completion_action_string() const;
   106 
   129 
   107 	// 
   130 	// 
   108 	//--------------------------------------------------
   131 	//--------------------------------------------------
   109 }; // class simple_config_completion_c
   132 }; // class simple_config_completion_c
   110 
   133