Public Member Functions | Private Member Functions | Private Attributes | Friends
karto::Name Class Reference

#include <Karto.h>

List of all members.

Public Member Functions

const std::string & GetName () const
const std::string & GetScope () const
 Name ()
 Name (const std::string &rName)
 Name (const Name &rOther)
kt_bool operator!= (const Name &rOther) const
kt_bool operator< (const Name &rOther) const
Nameoperator= (const Name &rOther)
kt_bool operator== (const Name &rOther) const
void SetName (const std::string &rName)
void SetScope (const std::string &rScope)
std::string ToString () const
virtual ~Name ()

Private Member Functions

kt_bool IsValid (char c)
kt_bool IsValidFirst (char c)
void Parse (const std::string &rName)
void Validate (const std::string &rName)

Private Attributes

std::string m_Name
std::string m_Scope

Friends

std::ostream & operator<< (std::ostream &rStream, const Name &rName)

Detailed Description

Definition at line 354 of file Karto.h.


Constructor & Destructor Documentation

karto::Name::Name ( ) [inline]

Constructor

Definition at line 360 of file Karto.h.

karto::Name::Name ( const std::string &  rName) [inline]

Constructor

Definition at line 367 of file Karto.h.

karto::Name::Name ( const Name rOther) [inline]

Constructor

Definition at line 375 of file Karto.h.

virtual karto::Name::~Name ( ) [inline, virtual]

Destructor

Definition at line 384 of file Karto.h.


Member Function Documentation

const std::string& karto::Name::GetName ( ) const [inline]

Gets the name of this name

Returns:
name

Definition at line 393 of file Karto.h.

const std::string& karto::Name::GetScope ( ) const [inline]

Gets the scope of this name

Returns:
scope

Definition at line 417 of file Karto.h.

kt_bool karto::Name::IsValid ( char  c) [inline, private]

Whether the character is a valid character (alphanumeric, /, _, or -)

Parameters:
ccharacter
Returns:
true if the character is valid

Definition at line 573 of file Karto.h.

kt_bool karto::Name::IsValidFirst ( char  c) [inline, private]

Whether the character is valid as a first character (alphanumeric or /)

Parameters:
ccharacter
Returns:
true if the character is a valid first character

Definition at line 563 of file Karto.h.

kt_bool karto::Name::operator!= ( const Name rOther) const [inline]

Inequality operator.

Definition at line 479 of file Karto.h.

kt_bool karto::Name::operator< ( const Name rOther) const [inline]

Less than operator.

Definition at line 487 of file Karto.h.

Name& karto::Name::operator= ( const Name rOther) [inline]

Assignment operator.

Definition at line 457 of file Karto.h.

kt_bool karto::Name::operator== ( const Name rOther) const [inline]

Equality operator.

Definition at line 471 of file Karto.h.

void karto::Name::Parse ( const std::string &  rName) [inline, private]

Parse the given string into a Name object

Parameters:
rNamename

Definition at line 508 of file Karto.h.

void karto::Name::SetName ( const std::string &  rName) [inline]

Sets the name

Parameters:
rNamename

Definition at line 402 of file Karto.h.

void karto::Name::SetScope ( const std::string &  rScope) [inline]

Sets the scope of this name

Parameters:
rScopescope

Definition at line 426 of file Karto.h.

std::string karto::Name::ToString ( ) const [inline]

Returns a string representation of this name

Returns:
string representation of this name

Definition at line 435 of file Karto.h.

void karto::Name::Validate ( const std::string &  rName) [inline, private]

Validates the given string as a Name

Parameters:
rNamename

Definition at line 533 of file Karto.h.


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  rStream,
const Name rName 
) [friend]

Write Name onto output stream

Parameters:
rStreamoutput stream
rNameto write

Definition at line 497 of file Karto.h.


Member Data Documentation

std::string karto::Name::m_Name [private]

Definition at line 579 of file Karto.h.

std::string karto::Name::m_Scope [private]

Definition at line 580 of file Karto.h.


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


open_karto
Author(s):
autogenerated on Tue May 2 2017 02:41:15