BasicVersion.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/BasicString.hxx"
 
#ifndef ARP_INSIDE_ARP_H
    #error Never include 'BasicVersion.hxx' directly, just include 'Arp.h'
#endif
 
namespace Arp
{
 
class BasicVersion
{
public: // typedefs
    typedef BasicString<char> String;
 
public: // construction/destruction
    BasicVersion(void) = default;
 
    BasicVersion(uint8 majorVersion, const String& state = String(), const String& name = String());
 
    BasicVersion(uint8 majorVersion, uint8 minorVersion, const String& state = String(), const String& name = String());
 
    BasicVersion(uint8 majorVersion, uint8 minorVersion, uint8 patchVersion, const String& state = String(), const String& name = String());
 
    BasicVersion(uint8 majorVersion, uint8 minorVersion, uint8 patchVersion, uint32 buildVersion, const String& state = String(), const String& name = String());
 
    BasicVersion(const BasicVersion& arg) = default;
 
    BasicVersion(BasicVersion&& arg) = default;
 
    BasicVersion& operator=(const BasicVersion& arg) = default;
 
    virtual ~BasicVersion(void) = default; // TODO(OR): remove virtual here
 
public: // static factory operations
    static BasicVersion Parse(const String& input);
 
    static bool TryParse(const String& input, BasicVersion& result);
 
public: // compare operators
    bool operator==(const BasicVersion& arg)const;
 
    bool operator>(const BasicVersion& arg)const;
 
    bool operator<(const BasicVersion& arg)const;
 
    bool operator>=(const BasicVersion& arg)const;
 
    bool operator<=(const BasicVersion& arg)const;
 
public: // setter/getter operations
    String  GetName(void)const;
 
    uint8   GetMajor(void)const;
 
    uint8   GetMinor(void)const;
 
    uint8   GetPatch(void)const;
 
    uint32  GetBuild(void)const;
 
    String  GetState(void)const;
 
public: // operations
    String ToString(void) const;
 
private: // static methods
    static bool TryParseFullVersion(const String& input, BasicVersion& result);
    static bool TryParseInternalVersion(const String& input, BasicVersion& result);
 
private: // fields
    String  name;
    uint8   majorVersion = 0;
    uint8   minorVersion = 0;
    uint8   patchVersion = 0;
    uint32  buildVersion = 0;
    String  state;
};
 
// inline methods of class BasicVersion
 
inline BasicVersion::BasicVersion(uint8 majorVersionArg, const String& stateArg, const String& nameArg)
    : name(nameArg), majorVersion(majorVersionArg), minorVersion(0), patchVersion(0), buildVersion(0), state(stateArg)
{
}
 
inline BasicVersion::BasicVersion(uint8 majorVersionArg, uint8 minorVersionArg, const String& stateArg, const String& nameArg)
    : name(nameArg), majorVersion(majorVersionArg), minorVersion(minorVersionArg), patchVersion(0), buildVersion(0), state(stateArg)
{
}
 
inline BasicVersion::BasicVersion(uint8 majorVersionArg, uint8 minorVersionArg, uint8 patchVersionArg, const String& stateArg, const String& nameArg)
    : name(nameArg), majorVersion(majorVersionArg), minorVersion(minorVersionArg), patchVersion(patchVersionArg), buildVersion(0), state(stateArg)
{
}
 
inline BasicVersion::BasicVersion(uint8 majorVersionArg, uint8 minorVersionArg, uint8 patchVersionArg, uint32 buildVersionArg, const String& stateArg, const String& nameArg)
    : name(nameArg), majorVersion(majorVersionArg), minorVersion(minorVersionArg), patchVersion(patchVersionArg), buildVersion(buildVersionArg), state(stateArg)
{
}
 
inline bool BasicVersion::operator==(const BasicVersion& arg)const
{
    return (this->name == arg.name)
           && (this->majorVersion == arg.majorVersion)
           && (this->minorVersion == arg.minorVersion)
           && (this->patchVersion == arg.patchVersion)
           && (this->buildVersion == arg.buildVersion);
}
 
inline bool BasicVersion::operator>(const BasicVersion& arg)const
{
    bool result = false;
 
    if (this->majorVersion > arg.majorVersion)
    {
        result = true;
    }
    else if ((this->majorVersion == arg.majorVersion) && (this->minorVersion > arg.minorVersion))
    {
        result = true;
    }
    else if ((this->majorVersion == arg.majorVersion) && (this->minorVersion == arg.minorVersion) && (this->patchVersion > arg.patchVersion))
    {
        result = true;
    }
    else if ((this->majorVersion == arg.majorVersion) && (this->minorVersion == arg.minorVersion) && (this->patchVersion == arg.patchVersion) && (this->buildVersion > arg.buildVersion))
    {
        result = true;
    }
 
    return result;
}
 
inline bool BasicVersion::operator<(const BasicVersion& arg)const
{
    bool result = false;
 
    if (this->majorVersion < arg.majorVersion)
    {
        result = true;
    }
    else if ((this->majorVersion == arg.majorVersion) && (this->minorVersion < arg.minorVersion))
    {
        result = true;
    }
    else if ((this->majorVersion == arg.majorVersion) && (this->minorVersion == arg.minorVersion) && (this->patchVersion < arg.patchVersion))
    {
        result = true;
    }
    else if ((this->majorVersion == arg.majorVersion) && (this->minorVersion == arg.minorVersion) && (this->patchVersion == arg.patchVersion) && (this->buildVersion < arg.buildVersion))
    {
        result = true;
    }
 
    return result;
}
 
inline bool BasicVersion::operator>=(const BasicVersion& arg)const
{
    bool result = false;
 
    if ((*this > arg) || (*this == arg))
    {
        result = true;
    }
 
    return result;
}
 
inline bool BasicVersion::operator<=(const BasicVersion& arg)const
{
    bool result = false;
 
    if ((*this < arg) || (*this == arg))
    {
        result = true;
    }
 
    return result;
}
 
inline BasicVersion::String BasicVersion::GetName()const
{
    return this->name;
}
 
inline uint8 BasicVersion::GetMajor()const
{
    return this->majorVersion;
}
 
inline uint8 BasicVersion::GetMinor()const
{
    return this->minorVersion;
}
 
inline uint8 BasicVersion::GetPatch()const
{
    return this->patchVersion;
}
 
inline uint32 BasicVersion::GetBuild()const
{
    return this->buildVersion;
}
 
inline BasicVersion::String BasicVersion::GetState()const
{
    return this->state;
}
 
} // end of namespace Arp