usModuleVersion.h

Go to the documentation of this file.

/*============================================================================

  Library: CppMicroServices

  Copyright (c) German Cancer Research Center (DKFZ)
  All rights reserved.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

============================================================================*/

#ifndef USMODULEVERSION_H
#define USMODULEVERSION_H

#include <usCoreExport.h>

#include <string>

US_BEGIN_NAMESPACE

class US_Core_EXPORT ModuleVersion {

private:

  friend class ModulePrivate;

  unsigned int majorVersion;
  unsigned int minorVersion;
  unsigned int microVersion;
  std::string      qualifier;

  static const char SEPARATOR; //  = "."

  bool undefined;


  void Validate();

  ModuleVersion& operator=(const ModuleVersion& v);

  explicit ModuleVersion(bool undefined = false);

public:

  static ModuleVersion EmptyVersion();

  static ModuleVersion UndefinedVersion();

  ModuleVersion(unsigned int majorVersion, unsigned int minorVersion, unsigned int microVersion);

  ModuleVersion(unsigned int majorVersion, unsigned int minorVersion, unsigned int microVersion, const std::string& qualifier);

  ModuleVersion(const std::string& version);

  ModuleVersion(const ModuleVersion& version);


  static ModuleVersion ParseVersion(const std::string& version);

  bool IsUndefined() const;

  unsigned int GetMajor() const;

  unsigned int GetMinor() const;

  unsigned int GetMicro() const;

  std::string GetQualifier() const;

  std::string ToString() const;

  bool operator==(const ModuleVersion& object) const;

  int Compare(const ModuleVersion& object) const;

};

US_END_NAMESPACE

US_Core_EXPORT std::ostream& operator<<(std::ostream& os, const US_PREPEND_NAMESPACE(ModuleVersion)& v);

#endif // USMODULEVERSION_H