jaula API Reference version 1.4.0
JAULA::Name_Duplicated Class Reference

Class for bad object property name exceptions. More...

#include <jaula_name_duplicated.h>

Inheritance diagram for JAULA::Name_Duplicated:
JAULA::Exception

Public Member Functions

virtual std::string const & getDetail (void) const
 Retrieves the detailed description for the exception.
std::string const & getName (void) const
 Retrieves the name of the duplicated property.
 Name_Duplicated (std::string const &name="", std::string const &action="", std::string const &origin="")
 Constructor.
Name_Duplicatedoperator= (Name_Duplicated const &orig)
 Assignment operator.
void setName (std::string const &name)
 Establishes the name for the duplicated property.
virtual ~Name_Duplicated ()
 Destructor.

Private Attributes

std::string detail_
std::string name_

Detailed Description

Class for bad object property name exceptions.

This class defines the exceptions to be thrown in case a property name has been used more than once in the same object.
Author:
Kombo Morongo <morongo666@gmail.com>

Constructor & Destructor Documentation

JAULA::Name_Duplicated::Name_Duplicated ( std::string const &  name = "",
std::string const &  action = "",
std::string const &  origin = "" 
)

Constructor.

Parameters:
nameInvalid object property name (duplicated).
actionaction being performed when the exception arose.
originName of the method (and others methods that have called this) by the time the exception arose.
Description
This method construct a new exception instance with JAULA::Name_DUPLICATED code.

References setName().

JAULA::Name_Duplicated::~Name_Duplicated ( ) [virtual]

Destructor.


Member Function Documentation

std::string const & JAULA::Name_Duplicated::getDetail ( void  ) const [virtual]

Retrieves the detailed description for the exception.

Description
This method creates a standard detailed description for the exception based on the duplicated object property name.

Reimplemented from JAULA::Exception.

References detail_.

std::string const & JAULA::Name_Duplicated::getName ( void  ) const

Retrieves the name of the duplicated property.

References name_.

Name_Duplicated & JAULA::Name_Duplicated::operator= ( Name_Duplicated const &  orig)

Assignment operator.

Parameters:
origOriginal instance to copy
Returns:
a reference to the destination instance
Description
Copies the contents of the original instance to destination.
Note:
This method has been redefined from the base class preventing instance type modification.
void JAULA::Name_Duplicated::setName ( std::string const &  name)

Establishes the name for the duplicated property.

Parameters:
nameName of the object property that launched the exception.

References detail_, and name_.

Referenced by Name_Duplicated().


Field Documentation

std::string JAULA::Name_Duplicated::detail_ [private]

workspace where to generate class specific detail

Reimplemented from JAULA::Exception.

Referenced by getDetail(), and setName().

std::string JAULA::Name_Duplicated::name_ [private]

Container for the repeated name

Referenced by getName(), and setName().


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