ConnectionSetting Class Reference

This class defines options for connection settings transmitted between the DSI and ODBCFunctionality. More...

List of all members.

Public Member Functions

bool AllowsEmpty () const
 Indicates if this setting is allowed to be empty.
 ConnectionSetting (const ConnectionSetting &in_other)
 Copy Constructor.
 ConnectionSetting (ConnectionSettingStatus in_status)
 Constructor.
 ConnectionSetting ()
 Default Constructor.
void GetLabel (simba_wstring &out_label) const
 Returns the label.
ConnectionSettingStatus GetStatus () const
 Returns the status.
const std::vector< Variant > & GetValues () const
 Returns the list of values.
void InsertValue (const Variant &in_value)
 Inserts a connection value for the connection setting.
bool IsOptional () const
 Indicates if this is an optional setting.
bool IsProcessed () const
 Indicates if this is a processed setting which has been modified.
bool IsRequired () const
 Indicates if this is a required setting.
ConnectionSettingoperator= (const ConnectionSetting &in_setting)
 Override the = operator.
void SetAllowEmpty (bool in_allowsEmpty)
 Sets whether the setting is allowed to be empty.
void SetLabel (const simba_wstring &in_label)
 Sets the label of the connection setting.
void SetStatus (ConnectionSettingStatus in_label)
 Sets the label of the connection setting.
void SetValues (std::vector< Variant > &in_values)
 Sets the vector of values.
 ~ConnectionSetting ()
 Destructor.

Protected Attributes

bool m_allowsEmpty
 Whether the setting is allowed to be empty.
simba_wstring m_label
 Label on the connection setting, used in the case of requesting information from the application.
ConnectionSettingStatus m_status
 Type of connection setting, used by DSI layer to indicate to SimbaODBC what type of response DSI is responding with. The status of the connection setting can be PROCESSED, REQUIRED, or OPTIONAL.
std::vector< Variantm_values
 Values of the connection setting.

Detailed Description

This class defines options for connection settings transmitted between the DSI and ODBCFunctionality.

These connection settings options include a settings type, a label, and value(s) for the setting.


Constructor & Destructor Documentation

Default Constructor.

This constructor is mainly to make sure the class can work with STL containers. The status of the created object are set to SETTING_OPTIONAL.

Constructor.

Parameters:
in_status The status of the connection setting.
ConnectionSetting ( const ConnectionSetting in_other  ) 

Copy Constructor.

Parameters:
in_other the object to copy from

Destructor.


Member Function Documentation

bool AllowsEmpty (  )  const

Indicates if this setting is allowed to be empty.

Returns:
True if it's allowed to be empty; false otherwise.
void GetLabel ( simba_wstring out_label  )  const

Returns the label.

Parameters:
out_label On return, the label of the connection setting.
ConnectionSettingStatus GetStatus (  )  const

Returns the status.

Returns:
The status of the connection setting.
const std::vector<Variant>& GetValues (  )  const

Returns the list of values.

Returns:
The values for the connection setting.
void InsertValue ( const Variant in_value  ) 

Inserts a connection value for the connection setting.

Parameters:
in_value The value to add to the connection setting.
bool IsOptional (  )  const

Indicates if this is an optional setting.

Returns:
True if this is an optional setting; false otherwise.
bool IsProcessed (  )  const

Indicates if this is a processed setting which has been modified.

Returns:
True if this is a processed setting; false otherwise.
bool IsRequired (  )  const

Indicates if this is a required setting.

Returns:
True if this is a required setting; false otherwise.
ConnectionSetting& operator= ( const ConnectionSetting in_setting  ) 

Override the = operator.

Basically make this ConnectionSetting a clone of the one passed in.

Parameters:
in_setting The connection setting.
Returns:
The reference to this connection setting object.
void SetAllowEmpty ( bool  in_allowsEmpty  ) 

Sets whether the setting is allowed to be empty.

Parameters:
in_allowsEmpty Whether the setting is allowed to be empty.
void SetLabel ( const simba_wstring in_label  ) 

Sets the label of the connection setting.

Parameters:
in_label The label to use for the connection setting.
void SetStatus ( ConnectionSettingStatus  in_label  ) 

Sets the label of the connection setting.

Parameters:
in_label The label to use for the connection setting.
void SetValues ( std::vector< Variant > &  in_values  ) 

Sets the vector of values.

Parameters:
in_values The values to use for the connection setting.

Member Data Documentation

bool m_allowsEmpty [protected]

Whether the setting is allowed to be empty.

simba_wstring m_label [protected]

Label on the connection setting, used in the case of requesting information from the application.

Requested connection information is presented to the application in this format KEY:LABEL={VALUES}. The label is used by the application as the string to display in the GUI when prompting user for more information.

Type of connection setting, used by DSI layer to indicate to SimbaODBC what type of response DSI is responding with. The status of the connection setting can be PROCESSED, REQUIRED, or OPTIONAL.

std::vector<Variant> m_values [protected]

Values of the connection setting.

May be either the value of a processed setting, or either a single question mark "?" or a list of possible values in a request for information from the DSI layer to the application.


The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:18 2017 for SimbaEngine 10.1.3.1011 by simba