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 (const Name &rOther)
	Name (const std::string &rName)
	Name ()
kt_bool	operator!= (const Name &rOther) const
kt_bool	operator< (const Name &rOther) const
Name &	operator= (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 318 of file Karto.h.

---

Constructor & Destructor Documentation

karto::Name::Name

(

)

[inline]

Constructor

Definition at line 324 of file Karto.h.

karto::Name::Name

(

const std::string &

rName

)

[inline]

Constructor

Definition at line 331 of file Karto.h.

karto::Name::Name

(

const Name &

rOther

)

[inline]

Constructor

Definition at line 339 of file Karto.h.

virtual karto::Name::~Name

(

)

[inline, virtual]

Destructor

Definition at line 348 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 357 of file Karto.h.

const std::string& karto::Name::GetScope

(

)

const [inline]

Gets the scope of this name

Returns:

scope

Definition at line 381 of file Karto.h.

kt_bool karto::Name::IsValid

(

char

c

)

[inline, private]

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

Parameters:

c

character

Returns:

true if the character is valid

Definition at line 537 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:

c

character

Returns:

true if the character is a valid first character

Definition at line 527 of file Karto.h.

kt_bool karto::Name::operator!=

(

const Name &

rOther

)

const [inline]

Inequality operator.

Definition at line 443 of file Karto.h.

kt_bool karto::Name::operator<

(

const Name &

rOther

)

const [inline]

Less than operator.

Definition at line 451 of file Karto.h.

Name& karto::Name::operator=

(

const Name &

rOther

)

[inline]

Assignment operator.

Definition at line 421 of file Karto.h.

kt_bool karto::Name::operator==

(

const Name &

rOther

)

const [inline]

Equality operator.

Definition at line 435 of file Karto.h.

void karto::Name::Parse

(

const std::string &

rName

)

[inline, private]

Parse the given string into a Name object

Parameters:

rName

name

Definition at line 472 of file Karto.h.

void karto::Name::SetName

(

const std::string &

rName

)

[inline]

Sets the name

Parameters:

rName

name

Definition at line 366 of file Karto.h.

void karto::Name::SetScope

(

const std::string &

rScope

)

[inline]

Sets the scope of this name

Parameters:

rScope

scope

Definition at line 390 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 399 of file Karto.h.

void karto::Name::Validate

(

const std::string &

rName

)

[inline, private]

Validates the given string as a Name

Parameters:

rName

name

Definition at line 497 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:

	rStream	output stream
	rName	to write

Definition at line 461 of file Karto.h.

---

Member Data Documentation

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

Definition at line 543 of file Karto.h.

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

Definition at line 544 of file Karto.h.

---

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

• Karto.h