JDATABASE::JUPI Struct Reference

Universal product identifier (UPI). More...

#include <JUPI.hh>

Inheritance diagram for JDATABASE::JUPI:

Public Member Functions
	JUPI ()
	Default constructor. More...
	JUPI (const JPBS &pbs, const std::string &variant="")
	Constructor. More...
	JUPI (const std::string &upi)
	Constructor. More...
const JUPI &	getUPI () const
	Get UPI. More...
const std::string &	getVariant () const
	Get variant. More...
bool	equals (const JUPI &upi) const
	Equality. More...
const JPBS &	getPBS () const
	Get PBS. More...
bool	is_valid () const
	Check validity. More...
bool	equals (const JPBS &pbs) const
	Equality. More...

Static Public Attributes
static const char	DOT = '.'
	Separator between PBS values. More...
static const char	SEPARATOR = '/'
	Separator between PBS and variant. More...

Protected Attributes
std::string	variant

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

Detailed Description

Universal product identifier (UPI).

The UPI consists of a PBS and a variant, seperated by JPBS::SEPARATOR.
The ASCII format should therefore read "<int>[.<int>]+/<variant>".
The variant cannot start with any kind of white space.

Definition at line 29 of file JUPI.hh.

Constructor & Destructor Documentation

JUPI() [1/3]

JDATABASE::JUPI::JUPI ( )

inline

Default constructor.

Definition at line 36 of file JUPI.hh.

    {}

JUPI() [2/3]

JDATABASE::JUPI::JUPI ( const JPBS &  pbs, const std::string &  variant = ""  )

inline

Constructor.

Parameters

pbs	PBS
variant	variant

Definition at line 46 of file JUPI.hh.

                                                         :
      JPBS   (pbs),
      variant(variant)
    {}

JUPI() [3/3]

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

inline

Constructor.

Parameters

upi

UPI

Definition at line 57 of file JUPI.hh.

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

Member Function Documentation

getUPI()

const JUPI& JDATABASE::JUPI::getUPI ( ) const

inline

Get UPI.

Returns

UPI

Definition at line 68 of file JUPI.hh.

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

getVariant()

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

inline

Get variant.

Returns

variant

Definition at line 79 of file JUPI.hh.

    {
      return variant;
    }

equals() [1/2]

bool JDATABASE::JUPI::equals ( const JUPI &  upi ) const

inline

Equality.

Parameters

upi

UPI

Returns

true if UPIs are equals; else false

Definition at line 91 of file JUPI.hh.

    {
      return (this->getPBS()     == upi.getPBS()    &&
              this->getVariant() == upi.getVariant()); 
    }

getPBS()

const JPBS& JDATABASE::JPBS::getPBS ( ) const

inlineinherited

Get PBS.

Returns

PBS

Definition at line 106 of file JPBS.hh.

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

is_valid()

bool JDATABASE::JPBS::is_valid ( ) const

inlineinherited

Check validity.

Returns

true if valid; else false

Definition at line 117 of file JPBS.hh.

    {
      return !this->empty();
    }

equals() [2/2]

bool JDATABASE::JPBS::equals ( const JPBS &  pbs ) const

inlineinherited

Equality.

Parameters

pbs

PBS

Returns

true if PBS is equal; else false

Definition at line 129 of file JPBS.hh.

    {
      if (this->size() == pbs.size()) {
 
        for (const_iterator p = this->begin(), q = pbs.begin(); p != this->end(); ++p, ++q) {
          if (*p != *q) {
            return false;
          }
        }
 
        return true;
      }
 
      return false;
    }

Friends And Related Function Documentation

operator<

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

friend

Less-than operator.

Parameters

first	first UPI
second	second UPI

Returns

true if first UPI higher in hierarchy or lesser variant; else false

Definition at line 105 of file JUPI.hh.

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

operator>>

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

friend

Read UPI from input stream.

Parameters

in	input stream
object	UPI

Returns

input stream

Definition at line 121 of file JUPI.hh.

    {
      using namespace std;
 
      object.variant.clear();
 
      if (in >> static_cast<JPBS&>(object)) {
 
        if (in.get() == (int) JPBS::SEPARATOR) {
 
          const int c = in.peek();
 
          if (c != EOF && !isspace(c)) 
            in >> object.variant;
          else
            in.setstate(ios::failbit);
 
        } else {
 
          in.setstate(ios::failbit);
        }
      }
 
      return in;
    }

operator<<

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

friend

Write UPI to output stream.

Parameters

out	output stream
object	UPI

Returns

output stream

Definition at line 155 of file JUPI.hh.

    {
      return out << object.getPBS() << JPBS::SEPARATOR << object.getVariant();
    }

Member Data Documentation

variant

std::string JDATABASE::JUPI::variant

protected

Definition at line 161 of file JUPI.hh.

DOT

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

staticinherited

Separator between PBS values.

Definition at line 34 of file JPBS.hh.

SEPARATOR

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

staticinherited

Separator between PBS and variant.

Definition at line 40 of file JPBS.hh.

---

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

• JUPI.hh