VieVS::VieVS_NamedObject Class Reference

VieVS base object with name. More...

#include <VieVS_NamedObject.h>

Inheritance diagram for VieVS::VieVS_NamedObject:

Collaboration diagram for VieVS::VieVS_NamedObject:

Public Member Functions
	VieVS_NamedObject (std::string name, unsigned long id)
	constructor More...
	VieVS_NamedObject (std::string name, std::string alternativeName, unsigned long id)
	constructor More...
const std::string &	getName () const
	get object name More...
const std::string &	getAlternativeName () const
	get object alternative name More...
bool	hasAlternativeName () const
	check if object has alternative name More...
bool	hasName (const std::string &name) const
	check if object has name More...
void	changeName (const std::string &newName)
	change name of object More...
Public Member Functions inherited from VieVS::VieVS_Object
	VieVS_Object (unsigned long id)
	constructor More...
const unsigned long	getId () const
	get object id More...
bool	hasValidId () const
	check if id is valid More...
bool	hasId (unsigned long id) const
	check if object has specific id More...
void	setId (unsigned long id)
	set object id More...
std::string	printId () const
	object id string More...

Private Attributes
std::string	name_ = ""
	object name More...
std::string	alternativeName_ = ""
	object alternative name More...

Detailed Description

VieVS base object with name.

Author

Matthias Schartner

Date

15.03.2018

Constructor & Destructor Documentation

VieVS::VieVS_NamedObject::VieVS_NamedObject ( std::string  name, unsigned long  id  )

inline

constructor

Author

Matthias Schartner

Parameters

name	object name
id	object id

VieVS::VieVS_NamedObject::VieVS_NamedObject ( std::string  name, std::string  alternativeName, unsigned long  id  )

inline

constructor

Author

Matthias Schartner

Parameters

name	object name
alternativeName	object alternative name
id	object id

Member Function Documentation

void VieVS::VieVS_NamedObject::changeName ( const std::string &  newName )

inline

change name of object

Author

Matthias Schartner

Typically Objects should have an distinct name which should not change. Try to avoid this function in the VieSchedpp Project! It is implemented mainly for GUI interactions through VieSchedppGUI.

Parameters

newName

new name

const std::string& VieVS::VieVS_NamedObject::getAlternativeName ( ) const

inline

get object alternative name

Author

Matthias Schartner

Returns

object alternative name

Here is the caller graph for this function:

const std::string& VieVS::VieVS_NamedObject::getName ( ) const

inline

get object name

Author

Matthias Schartner

Returns

object name

Here is the caller graph for this function:

bool VieVS::VieVS_NamedObject::hasAlternativeName ( ) const

inline

check if object has alternative name

Author

Matthias Schartner

Returns

flag if alternative name exists

Here is the caller graph for this function:

bool VieVS::VieVS_NamedObject::hasName ( const std::string &  name ) const

inline

check if object has name

Author

Matthias Schartner

checks object name and alternative object name

Parameters

name	target name

Returns

true if object has target name

Here is the caller graph for this function:

Member Data Documentation

std::string VieVS::VieVS_NamedObject::alternativeName_ = ""

private

object alternative name

std::string VieVS::VieVS_NamedObject::name_ = ""

private

object name

---

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

• /home/travis/build/TUW-VieVS/VieSchedpp/Misc/VieVS_NamedObject.h