karto::Name Class Reference

#include <Karto.h>

Public Member Functions
const std::string &	GetName () const
const std::string &	GetScope () const
	Name ()
	Name (const Name &rOther)
	Name (const std::string &rName)
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)
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
void	Validate (const std::string &rName)

Private Attributes
std::string	m_Name
std::string	m_Scope

Friends
class	boost::serialization::access
std::ostream &	operator<< (std::ostream &rStream, const Name &rName)

Detailed Description

Definition at line 389 of file Karto.h.

Constructor & Destructor Documentation

Name() [1/3]

karto::Name::Name ( )

inline

Constructor

Definition at line 395 of file Karto.h.

Name() [2/3]

karto::Name::Name ( const std::string &  rName )

inline

Constructor

Definition at line 402 of file Karto.h.

Name() [3/3]

karto::Name::Name ( const Name &  rOther )

inline

Constructor

Definition at line 410 of file Karto.h.

~Name()

virtual karto::Name::~Name ( )

inlinevirtual

Destructor

Definition at line 418 of file Karto.h.

Member Function Documentation

GetName()

const std::string& karto::Name::GetName ( ) const

inline

Gets the name of this name

Returns

name

Definition at line 427 of file Karto.h.

GetScope()

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

inline

Gets the scope of this name

Returns

scope

Definition at line 451 of file Karto.h.

IsValid()

kt_bool karto::Name::IsValid ( char  c )

inlineprivate

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

Parameters

c

character

Returns

true if the character is valid

Definition at line 607 of file Karto.h.

IsValidFirst()

kt_bool karto::Name::IsValidFirst ( char  c )

inlineprivate

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 597 of file Karto.h.

operator!=()

kt_bool karto::Name::operator!= ( const Name &  rOther ) const

inline

Inequality operator.

Definition at line 513 of file Karto.h.

operator<()

kt_bool karto::Name::operator< ( const Name &  rOther ) const

inline

Less than operator.

Definition at line 521 of file Karto.h.

operator=()

Name& karto::Name::operator= ( const Name &  rOther )

inline

Assignment operator.

Definition at line 491 of file Karto.h.

operator==()

kt_bool karto::Name::operator== ( const Name &  rOther ) const

inline

Equality operator.

Definition at line 505 of file Karto.h.

Parse()

void karto::Name::Parse ( const std::string &  rName )

inlineprivate

Parse the given string into a Name object

Parameters

rName

name

Definition at line 542 of file Karto.h.

serialize()

template<class Archive >

void karto::Name::serialize ( Archive &  ar, const unsigned int  version  )

inlineprivate

Definition at line 620 of file Karto.h.

SetName()

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

inline

Sets the name

Parameters

rName

name

Definition at line 436 of file Karto.h.

SetScope()

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

inline

Sets the scope of this name

Parameters

rScope

scope

Definition at line 460 of file Karto.h.

ToString()

std::string karto::Name::ToString ( ) const

inline

Returns a string representation of this name

Returns

string representation of this name

Definition at line 469 of file Karto.h.

Validate()

void karto::Name::Validate ( const std::string &  rName )

inlineprivate

Validates the given string as a Name

Parameters

rName

name

Definition at line 567 of file Karto.h.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Serialization: class Name

Definition at line 618 of file Karto.h.

operator<<

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 531 of file Karto.h.

Member Data Documentation

m_Name

std::string karto::Name::m_Name

private

Definition at line 613 of file Karto.h.

m_Scope

std::string karto::Name::m_Scope

private

Definition at line 614 of file Karto.h.

---

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

• Karto.h