Universal product identifier (UPI). More...

#include <JUPI_t.hh>

Inheritance diagram for JDATABASE::JUPI_t:

Public Member Functions
	JUPI_t ()
	Default constructor.

	JUPI_t (const JPBS_t &pbs)
	Constructor.

	JUPI_t (const JPBS_t &pbs, const std::string &variant, const int version, const int number)
	Constructor.

	JUPI_t (const std::string &upi)
	Constructor.

const JUPI_t &	getUPI () const
	Get UPI.

const std::string &	getVariant () const
	Get variant.

int	getVersion () const
	Get version.

int	getNumber () const
	Get serial number.

std::string	toString () const
	Convert UPI.

	ClassDefNV (JUPI_t, 1)

const JPBS_t &	getPBS () const
	Get PBS.

bool	is_valid () const
	Check validity.

	ClassDefNV (JPBS_t, 1)

Static Public Member Functions
static int	compare (const std::string &first, const std::string &second)
	Compare sub-strings.

Static Public Attributes
static const char	SEPARATOR = '/'
	Separator between PBS, variant and version.

static const int	DEFAULT_VERSION = -1
	Default version.

static const int	DEFAULT_NUMBER = -1
	Default number.

static const char	DOT = '.'
	Separator between PBS values.

Protected Attributes
std::string	variant

int	version

int	number

Friends
bool	operator== (const JUPI_t &first, const JUPI_t &second)
	Equality.

bool	operator< (const JUPI_t &first, const JUPI_t &second)
	Less-than operator.

std::istream &	operator>> (std::istream &in, JUPI_t &object)
	Read UPI from input stream.

std::ostream &	operator<< (std::ostream &out, const JUPI_t &object)
	Write UPI to output stream.

Detailed Description

Universal product identifier (UPI).

The UPI consists of a PBS, variant, version and serial number.
The corresponding ASCII format reads "<int>[.<int>]*/<variant>/<int>.<int>".
The version and serial number are not subject to I/O in case their value is default.

Definition at line 31 of file JUPI_t.hh.

Constructor & Destructor Documentation

◆ JUPI_t() [1/4]

JDATABASE::JUPI_t::JUPI_t ( )

inline

Default constructor.

Definition at line 45 of file JUPI_t.hh.

             :
      JPBS_t (),
      variant(),
      version(DEFAULT_VERSION),
      number (DEFAULT_NUMBER)
    {}

◆ JUPI_t() [2/4]

JDATABASE::JUPI_t::JUPI_t ( const JPBS_t & pbs )

inline

Constructor.

Parameters

pbs PBS

Definition at line 58 of file JUPI_t.hh.

                              :
      JPBS_t (pbs),
      variant(),
      version(DEFAULT_VERSION),
      number (DEFAULT_NUMBER)
    {}

◆ JUPI_t() [3/4]

JDATABASE::JUPI_t::JUPI_t	(	const JPBS_t &	pbs,
		const std::string &	variant,
		const int	version,
		const int	number )

inline

Constructor.

Parameters

pbs	PBS
variant	variant
version	version
number	serial number

Definition at line 74 of file JUPI_t.hh.

                                      :
      JPBS_t (pbs),
      variant(variant),
      version(version),
      number (number)
    {}

◆ JUPI_t() [4/4]

JDATABASE::JUPI_t::JUPI_t ( const std::string & upi )

inline

Constructor.

Parameters

upi UPI

Definition at line 90 of file JUPI_t.hh.

    {
      std::istringstream(upi) >> *this;
    }

Member Function Documentation

◆ getUPI()

const JUPI_t & JDATABASE::JUPI_t::getUPI ( ) const

inline

Get UPI.

Returns: UPI

Definition at line 101 of file JUPI_t.hh.

    {
      return static_cast<const JUPI_t&>(*this);
    }

◆ getVariant()

const std::string & JDATABASE::JUPI_t::getVariant ( ) const

inline

Get variant.

Returns: variant

Definition at line 112 of file JUPI_t.hh.

    {
      return variant;
    }

◆ getVersion()

int JDATABASE::JUPI_t::getVersion ( ) const

inline

Get version.

Returns: version

Definition at line 123 of file JUPI_t.hh.

    {
      return version;
    }

◆ getNumber()

int JDATABASE::JUPI_t::getNumber ( ) const

inline

Get serial number.

Returns: serial number

Definition at line 134 of file JUPI_t.hh.

    {
      return number;
    }

◆ toString()

std::string JDATABASE::JUPI_t::toString ( ) const

inline

Convert UPI.

Returns: UPI

Definition at line 145 of file JUPI_t.hh.

    {
      std::ostringstream os;
 
      os << *this;
 
      return os.str();
    }

◆ ClassDefNV() [1/2]

JDATABASE::JUPI_t::ClassDefNV	(	JUPI_t	,
		1	)

◆ compare()

static int JDATABASE::JUPI_t::compare	(	const std::string &	first,
		const std::string &	second )

inlinestatic

Compare sub-strings.

Parameters

first	first string
second	second string

Returns: -1, 0, +1 if first sub-string is less, equal, greater than second sub-string

Definition at line 290 of file JUPI_t.hh.

    {
      using namespace std;
 
      const size_t pos = min(first.size(), second.size());
 
      if      (first.substr(0,pos) < second.substr(0,pos))
        return -1;
      else if (first.substr(0,pos) > second.substr(0,pos))
        return +1;
      else
        return 0;
    }

◆ getPBS()

const JPBS_t & JDATABASE::JPBS_t::getPBS ( ) const

inlineinherited

Get PBS.

Returns: PBS

Definition at line 101 of file JPBS_t.hh.

    {
      return static_cast<const JPBS_t&>(*this);
    }

◆ is_valid()

bool JDATABASE::JPBS_t::is_valid ( ) const

inlineinherited

Check validity.

Returns: true if valid; else false

Definition at line 112 of file JPBS_t.hh.

    {
      return !this->empty();
    }

◆ ClassDefNV() [2/2]

JDATABASE::JPBS_t::ClassDefNV	(	JPBS_t	,
		1	)

inherited

Friends And Related Symbol Documentation

◆ operator==

bool operator==	(	const JUPI_t &	first,
		const JUPI_t &	second )

friend

Equality.

Parameters

first	first UPI
second	second UPI

Returns: true if UPIs are equals; else false

Definition at line 162 of file JUPI_t.hh.

    {
      return (first.getPBS()     == second.getPBS()      &&
              compare(first .getVariant(),
                      second.getVariant()) == 0          &&
              first.getVersion() == second.getVersion()  &&
              first.getNumber()  == second.getNumber());
    }

◆ operator<

bool operator<	(	const JUPI_t &	first,
		const JUPI_t &	second )

friend

Less-than operator.

Parameters

first	first UPI
second	second UPI

Returns: true if first UPI less than second UPI; else false

Definition at line 179 of file JUPI_t.hh.

    {
      if (first.getPBS() == second.getPBS()) {
 
        if (compare(first .getVariant(),
                    second.getVariant()) == 0) {
          
          if (first.getVersion() == second.getVersion())
            return first.getNumber()  < second.getNumber();
          else
            return first.getVersion() < second.getVersion();
 
        } else {
 
          return (compare(first .getVariant(),
                          second.getVariant()) < 0);
        }
 
      } else {
        
        return first.getPBS()     < second.getPBS();
      }
    }

◆ operator>>

std::istream & operator>>	(	std::istream &	in,
		JUPI_t &	object )

friend

Read UPI from input stream.

Parameters

in	input stream
object	UPI

Returns: input stream

Definition at line 211 of file JUPI_t.hh.

    {
      using namespace std;
 
      object = JUPI_t();
 
      if (in.peek() != (int) SEPARATOR) {
        in >> static_cast<JPBS_t&>(object);
      }
 
      if (in.get() == (int) SEPARATOR) {
          
        if (in.peek() == (int) SEPARATOR)
          in.ignore();
        else
          getline(in, object.variant, SEPARATOR);
 
        if (in.peek() == (int) DOT) {
 
          in.ignore();
 
          object.version = DEFAULT_VERSION;
          object.number  = DEFAULT_NUMBER;
        
          return in;
 
        } else if (in >> object.version   &&
                   in.get() == (int) DOT  &&
                   in >> object.number) {
 
          return in;
        }
      }
 
      in.setstate(ios::failbit);
 
      return in;
    }

◆ operator<<

std::ostream & operator<<	(	std::ostream &	out,
		const JUPI_t &	object )

friend

Write UPI to output stream.

Parameters

out	output stream
object	UPI

Returns: output stream

Definition at line 258 of file JUPI_t.hh.

    {
      using namespace std;
 
      ostringstream os;          // allow for width formatting
 
      os << object.getPBS()      << JUPI_t::SEPARATOR
         << object.getVariant()  << JUPI_t::SEPARATOR;
 
      if (object.getVersion() != DEFAULT_VERSION) {
        os << object.getVersion();
      }
 
      os << JUPI_t::DOT;
 
      if (object.getNumber()  != DEFAULT_NUMBER) {
        os << object.getNumber();
      }
 
      return out << os.str();
    }

Member Data Documentation

◆ SEPARATOR

const char JDATABASE::JUPI_t::SEPARATOR = '/'

static

Separator between PBS, variant and version.

Definition at line 37 of file JUPI_t.hh.

◆ DEFAULT_VERSION

const int JDATABASE::JUPI_t::DEFAULT_VERSION = -1

static

Default version.

Definition at line 39 of file JUPI_t.hh.

◆ DEFAULT_NUMBER

const int JDATABASE::JUPI_t::DEFAULT_NUMBER = -1

static

Default number.

Definition at line 40 of file JUPI_t.hh.

◆ variant

std::string JDATABASE::JUPI_t::variant

protected

Definition at line 305 of file JUPI_t.hh.

◆ version

int JDATABASE::JUPI_t::version

protected

Definition at line 306 of file JUPI_t.hh.

◆ number

int JDATABASE::JUPI_t::number

protected

Definition at line 307 of file JUPI_t.hh.

◆ DOT

const char JDATABASE::JPBS_t::DOT = '.'

staticinherited

Separator between PBS values.

Definition at line 33 of file JPBS_t.hh.

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

JUPI_t.hh

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JUPI_t() [1/4]

◆ JUPI_t() [2/4]

◆ JUPI_t() [3/4]

◆ JUPI_t() [4/4]

Member Function Documentation

◆ getUPI()

◆ getVariant()

◆ getVersion()

◆ getNumber()

◆ toString()

◆ ClassDefNV() [1/2]

◆ compare()

◆ getPBS()

◆ is_valid()

◆ ClassDefNV() [2/2]

Friends And Related Symbol Documentation

◆ operator==

◆ operator<

◆ operator>>

◆ operator<<

Member Data Documentation

◆ SEPARATOR

◆ DEFAULT_VERSION

◆ DEFAULT_NUMBER

◆ variant

◆ version

◆ number

◆ DOT