clanguml::class_diagram::model::class_element Class Reference

Base class for class elements (e.g. member or method). More...

Detailed Description

Base class for class elements (e.g. member or method).

Definition at line 32 of file class_element.h.

#include <class_element.h>

Public Member Functions
	class_element (common::model::access_t scope, std::string name, std::string type)
	~class_element () override=default
common::model::access_t	access () const
	Get elements access scope.
std::string	name () const
	Get elements name.
void	set_name (const std::string &name)
	Set elements name.
std::string	type () const
	Get elements type as string.
void	set_type (const std::string &type)
	Set elements type as string.
virtual inja::json	context () const
	Get elements inja context in JSON.
Public Member Functions inherited from clanguml::common::model::decorated_element
virtual	~decorated_element ()=default
bool	skip () const
bool	skip_relationship () const
std::pair< relationship_t, std::string >	get_relationship () const
std::string	style_spec () const
const std::vector< std::shared_ptr< decorators::decorator > > &	decorators () const
void	add_decorators (const std::vector< std::shared_ptr< decorators::decorator > > &decorators)
void	append (const decorated_element &de)
std::optional< comment_t >	comment () const
void	set_comment (const comment_t &c)
virtual std::optional< std::string >	doxygen_link () const
Public Member Functions inherited from clanguml::common::model::source_location
	source_location ()=default
	source_location (std::string f, unsigned int l)
const std::string &	file () const
void	set_file (const std::string &file)
const std::string &	file_relative () const
void	set_file_relative (const std::string &file)
const std::string &	translation_unit () const
void	set_translation_unit (const std::string &translation_unit)
unsigned int	line () const
void	set_line (const unsigned line)
unsigned int	column () const
void	set_column (const unsigned column)
unsigned int	location_id () const
void	set_location_id (unsigned int h)

Private Attributes
common::model::access_t	access_
std::string	name_
std::string	type_

Constructor & Destructor Documentation

class_element()

clanguml::class_diagram::model::class_element::class_element	(	common::model::access_t	scope,
		std::string	name,
		std::string	type
	)

Definition at line 25 of file class_element.cc.

    : access_{access}
    , name_{std::move(name)}
    , type_{std::move(type)}
{
}

~class_element()

clanguml::class_diagram::model::class_element::~class_element ( )

overridedefault

Member Function Documentation

access()

common::model::access_t clanguml::class_diagram::model::class_element::access

(

)

const

Get elements access scope.

Returns

Elements access scope.

Definition at line 33 of file class_element.cc.

{ return access_; }

context()

inja::json clanguml::class_diagram::model::class_element::context ( ) const

virtual

Get elements inja context in JSON.

Returns

Context in JSON

Definition at line 43 of file class_element.cc.

{
    inja::json ctx;
    ctx["name"] = name();
    ctx["type"] = type();
    ctx["access"] = to_string(access());
    return ctx;
}

name()

std::string clanguml::class_diagram::model::class_element::name

(

)

const

Get elements name.

Returns

Elements name.

Definition at line 35 of file class_element.cc.

{ return name_; }

set_name()

void clanguml::class_diagram::model::class_element::set_name

(

const std::string &

name

)

Set elements name.

Parameters

name	Elements name.

Definition at line 37 of file class_element.cc.

{ name_ = name; }

set_type()

void clanguml::class_diagram::model::class_element::set_type

(

const std::string &

type

)

Set elements type as string.

Parameters

type	Elements type as string.

Definition at line 41 of file class_element.cc.

{ type_ = type; }

type()

std::string clanguml::class_diagram::model::class_element::type

(

)

const

Get elements type as string.

Returns

Elements type as string.

Definition at line 39 of file class_element.cc.

{ return type_; }

Member Data Documentation

access_

common::model::access_t clanguml::class_diagram::model::class_element::access_

private

Definition at line 83 of file class_element.h.

name_

std::string clanguml::class_diagram::model::class_element::name_

private

Definition at line 84 of file class_element.h.

type_

std::string clanguml::class_diagram::model::class_element::type_

private

Definition at line 85 of file class_element.h.

---

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

• src/class_diagram/model/class_element.h
• src/class_diagram/model/class_element.cc