omni::Id Struct Reference

Id type for classes An Id must only contain alpha numerical characters and must begin with a letter. More...

#include <Id.h>

Public Member Functions
	Id ()
	Default constructor. More...
	Id (QString const &)
	Constructor from string. More...
	Id (const char *)
	Constructor from const char*. More...
QString const &	str () const
	Returns string representation (const) More...
	operator QString () const
	Cast operator returns copy of string representation. More...
bool	valid () const
	Returns true if string is valid. More...
bool	operator< (const Id &) const
	Comparison operator. More...
bool	operator!= (const Id &) const
	Returns true if two ids do not match. More...
bool	operator== (const Id &) const
	Returns true if two ids match. More...

Private Member Functions
void	make (QString const &)
	Make Id from string. More...

Private Attributes
QString	str_
	Internal string buffer. More...

Detailed Description

Id type for classes An Id must only contain alpha numerical characters and must begin with a letter.

Constructor & Destructor Documentation

omni::Id::Id

(

)

Default constructor.

  {
  }

omni::Id::Id

(

QString const &

_str

)

Constructor from string.

  {
    make(_str);
  }

omni::Id::Id

(

const char *

_c

)

Constructor from const char*.

  {
    make(QString(_c));
  }

Member Function Documentation

void omni::Id::make ( QString const &  _str )

private

Make Id from string.

  {
    str_ = "";
    // An id must not be empty
    if (_str.isEmpty()) return;

    // An Id must begin with a letter
    if (!_str[0].isLetter()) return;

    // An id must only contain alpha numerical characters
    // and underscores
    for (auto& c : _str)
    {
      if (!c.isLetterOrNumber() && (!c.isPunct())) return;
    }
    str_=_str;
  }

omni::Id::operator QString

(

)

const

Cast operator returns copy of string representation.

  {
    return str_;
  }

bool omni::Id::operator!=

(

const Id &

_rhs

)

const

Returns true if two ids do not match.

  {
    return !(*this == _rhs);
  }

bool omni::Id::operator<

(

const Id &

_rhs

)

const

Comparison operator.

  {
    return this->str_ < _rhs.str_;
  }

bool omni::Id::operator==

(

const Id &

_rhs

)

const

Returns true if two ids match.

  {
    return this->str_ == _rhs.str_;
  }

QString const & omni::Id::str

(

)

const

Returns string representation (const)

  {
    return str_;
  }

bool omni::Id::valid

(

)

const

Returns true if string is valid.

  {
    return !str_.isEmpty();
  }

Field Documentation

QString omni::Id::str_

private

Internal string buffer.

---

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

• include/omni/Id.h
• src/lib/Id.cpp