refs #198, renaming of method (for consistency) and Doxygen/formatting only

This commit is contained in:
Klaus Basan
2014-03-27 21:05:39 +01:00
parent 54fe898ff8
commit cf009d7b17
7 changed files with 36 additions and 110 deletions

View File

@@ -127,7 +127,7 @@ namespace BlackMisc
// TODO: This needs to be refactored to a smarter way to delegate commands
changedFlag = false;
CStatusMessageList msgs;
if (path == CSettingsNetwork::ValueTrafficServer())
if (path == CSettingsNetwork::ValueTrafficServers())
{
const CServer server = value.value<CServer>();
if (command == CSettingsNetwork::CmdSetCurrentServer())

View File

@@ -20,100 +20,62 @@ namespace BlackMisc
{
namespace Settings
{
/*!
* Value object encapsulating information of a server
*/
//! Value object encapsulating information of a server
class CSettingsNetwork : public BlackMisc::CValueObject
{
public:
/*!
* Default constructor.
*/
//! \brief Default constructor.
CSettingsNetwork();
/*!
* Destructor.
*/
//! \brief Destructor.
virtual ~CSettingsNetwork() {}
/*!
* \brief Update
* \return
*/
//! \brief Update
static const QString &CmdSetCurrentServer()
{
static const QString cmd("currenttrafficserver");
return cmd;
}
/*!
* \brief Path
* \return
*/
static const QString &ValueTrafficServer()
//! \brief Path
static const QString &ValueTrafficServers()
{
static const QString cmd("trafficserver");
return cmd;
static const QString value("trafficservers");
return value;
}
/*!
* \copydoc CValueObject::toQVariant()
*/
//! \copydoc CValueObject::toQVariant()
virtual QVariant toQVariant() const override
{
return QVariant::fromValue(*this);
}
/*!
* Traffic network server objects
*/
//! \brief Value object, traffic network server objects
BlackMisc::Network::CServerList getTrafficNetworkServers() const { return m_trafficNetworkServers; }
/*!
* Selected traffic network server
*/
BlackMisc::Network::CServer getCurrentNetworkServer() const { return m_trafficNetworkServerCurrent; }
//! \brief Selected traffic network server
BlackMisc::Network::CServer getCurrentTrafficNetworkServer() const { return m_trafficNetworkServerCurrent; }
/*!
* \brief URL of booking service
*/
QString getBookingServiceUrl() const { return "http://vatbook.euroutepro.com/xml2.php"; }
//! \brief URL of booking service
/*!
* Selected traffic network server
* \param currentServer
* \return
*/
//! \brief Selected traffic network server
bool setCurrentNetworkServer(const BlackMisc::Network::CServer &currentServer);
/*!
* Traffic network server objects
*/
//! \brief Traffic network server objects
void addTrafficNetworkServer(const BlackMisc::Network::CServer &server) { m_trafficNetworkServers.push_back(server); }
/*!
* \brief Equal operator ==
*/
//! \brief Equal operator ==
bool operator ==(const CSettingsNetwork &other) const;
/*!
* \brief Unequal operator !=
*/
//! \brief Unequal operator !=
bool operator !=(const CSettingsNetwork &other) const;
/*!
* \copydoc BlackCore::IContextSettings
*/
//! \copydoc BlackCore::IContextSettings
virtual BlackMisc::CStatusMessageList value(const QString &path, const QString &command, const QVariant &value, bool &changedFlag);
/*!
* \copydoc CValueObject::getValueHash
*/
//! \copydoc CValueObject::getValueHash
virtual uint getValueHash() const override;
/*!
* \brief Register metadata
*/
static void registerMetadata();
protected:

View File

@@ -40,12 +40,8 @@ namespace BlackMisc
return path.mid(sl + 1);
}
/*!
* \brief Append paths
* \param part1
* \param part2
* \param part3
* \return
/*
* Append paths
*/
QString CSettingUtilities::appendPaths(const QString &part1, const QString &part2, const QString &part3)
{

View File

@@ -7,9 +7,7 @@ namespace BlackMisc
{
namespace Settings
{
/*!
* \brief Helper / utility methods for settings
*/
//! \brief Helper / utility methods for settings
class CSettingUtilities
{
private:
@@ -17,74 +15,44 @@ namespace BlackMisc
public:
/*!
* \brief Validate
* \return
*/
//! \brief Command validate
static const QString &CmdValidate()
{
static const QString cmd("validate");
return cmd;
}
/*!
* \brief Update
* \return
*/
//! Command Update
static const QString &CmdUpdate()
{
static const QString cmd("update");
return cmd;
}
/*!
* \brief Remove
* \return
*/
//! Command Remove
static const QString &CmdRemove()
{
static const QString cmd("remove");
return cmd;
}
/*!
* \brief Add
* \return
*/
//! Command Add
static const QString &CmdAdd()
{
static const QString cmd("add");
return cmd;
}
/*!
* \brief Wrong path message
* \param path
* \return
*/
//! \brief Wrong path message
static BlackMisc::CStatusMessage wrongPathMessage(const QString &path = "");
/*!
* \brief Wrong path messages
* \param path
* \return
*/
//! \brief Wrong path messages
static BlackMisc::CStatusMessageList wrongPathMessages(const QString &path = "");
/*!
* \brief Remove leading path
* \param path
* \return
*/
//! \brief Remove leading path
static QString removeLeadingPath(const QString &path);
/*!
* \brief Append paths
* \param part1
* \param part2
* \param part3
* \return
*/
//! \brief Append setting paths
static QString appendPaths(const QString &part1, const QString &part2, const QString &part3 = "");
};