JDATABASE::JUPI_t Struct Reference

Universal product identifier (UPI). More...

#include <JUPI_t.hh>

Inheritance diagram for JDATABASE::JUPI_t:

Public Member Functions
	JUPI_t ()
	Default constructor. More...
	JUPI_t (const JPBS_t &pbs)
	Constructor. More...
	JUPI_t (const JPBS_t &pbs, const std::string &variant, const int version, const int number)
	Constructor. More...
	JUPI_t (const std::string &upi)
	Constructor. More...
const JUPI_t &	getUPI () const
	Get UPI. More...
const std::string &	getVariant () const
	Get variant. More...
int	getVersion () const
	Get version. More...
int	getNumber () const
	Get serial number. More...
std::string	toString () const
	Convert UPI. More...
	ClassDefNV (JUPI_t, 1)
const JPBS_t &	getPBS () const
	Get PBS. More...
bool	is_valid () const
	Check validity. More...
	ClassDefNV (JPBS_t, 1)

Static Public Attributes
static const char	SEPARATOR = '/'
	Separator between PBS, variant and version. More...
static const int	DEFAULT_VERSION = -1
	Default version. More...
static const int	DEFAULT_NUMBER = -1
	Default number. More...
static const char	DOT = '.'
	Separator between PBS values. More...

Protected Attributes
std::string	variant
int	version
int	number

Friends
bool	operator== (const JUPI_t &first, const JUPI_t &second)
	Equality. More...
bool	operator< (const JUPI_t &first, const JUPI_t &second)
	Less-than operator. More...
std::istream &	operator>> (std::istream &in, JUPI_t &object)
	Read UPI from input stream. More...
std::ostream &	operator<< (std::ostream &out, const JUPI_t &object)
	Write UPI to output stream. More...

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 30 of file JUPI_t.hh.

Constructor & Destructor Documentation

JDATABASE::JUPI_t::JUPI_t ( )

inline

Default constructor.

Definition at line 44 of file JUPI_t.hh.

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

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

inline

Constructor.

Parameters

pbs

PBS

Definition at line 57 of file JUPI_t.hh.

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

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 73 of file JUPI_t.hh.

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

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

inline

Constructor.

Parameters

upi

UPI

Definition at line 89 of file JUPI_t.hh.

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

Member Function Documentation

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

inline

Get UPI.

Returns

UPI

Definition at line 100 of file JUPI_t.hh.

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

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

inline

Get variant.

Returns

variant

Definition at line 111 of file JUPI_t.hh.

    {
      return variant;
    }

int JDATABASE::JUPI_t::getVersion ( ) const

inline

Get version.

Returns

version

Definition at line 122 of file JUPI_t.hh.

    {
      return version;
    }

int JDATABASE::JUPI_t::getNumber ( ) const

inline

Get serial number.

Returns

serial number

Definition at line 133 of file JUPI_t.hh.

    {
      return number;
    }

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

inline

Convert UPI.

Returns

UPI

Definition at line 144 of file JUPI_t.hh.

    {
      std::ostringstream os;

      os << *this;

      return os.str();
    }

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

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);
    }

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();
    }

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

inherited

Friends And Related Function Documentation

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 161 of file JUPI_t.hh.

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

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 then second UPI; else false

Definition at line 177 of file JUPI_t.hh.

    {
      if (first.getPBS() == second.getPBS()) {

        if (first.getVariant() == second.getVariant()) {
          
          if (first.getVersion() == second.getVersion())
            return first.getNumber()  < second.getNumber();
          else
            return first.getVersion() < second.getVersion();

        } else {

          return first.getVariant() < second.getVariant();
        }

      } else {
        
        return first.getPBS()     < second.getPBS();
      }
    }

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 207 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;
    }

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 254 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

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

static

Separator between PBS, variant and version.

Definition at line 36 of file JUPI_t.hh.

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

static

Default version.

Definition at line 38 of file JUPI_t.hh.

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

static

Default number.

Definition at line 39 of file JUPI_t.hh.

std::string JDATABASE::JUPI_t::variant

protected

Definition at line 279 of file JUPI_t.hh.

int JDATABASE::JUPI_t::version

protected

Definition at line 280 of file JUPI_t.hh.

int JDATABASE::JUPI_t::number

protected

Definition at line 281 of file JUPI_t.hh.

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