Sequence diagram participant representing a class. More...

Detailed Description

Sequence diagram participant representing a class.

Definition at line 81 of file participant.h.

#include <participant.h>

Public Member Functions
	class_ (const common::model::namespace_ &using_namespace)

	class_ (const class_ &)=delete

	class_ (class_ &&) noexcept=delete

class_ &	operator= (const class_ &)=delete

class_ &	operator= (class_ &&)=delete

	~class_ () override=default

std::string	type_name () const override

bool	is_struct () const
	Check if class is a struct.

void	is_struct (bool is_struct)
	Set whether the class is a struct.

bool	is_template () const
	Check if class is a template.

void	is_template (bool is_template)
	Set whether the class is a template instantiation.

bool	is_template_instantiation () const
	Check if class is a template instantiation.

void	is_template_instantiation (bool is_template_instantiation)
	Set whether the class is a template instantiation.

std::string	full_name_no_ns () const override

bool	is_abstract () const
	Check if class is a abstract.

bool	is_alias () const
	Check if class is a typedef/using alias.

void	is_alias (bool alias)
	Set whether the class is an alias.

bool	is_lambda () const
	Check if the class is lambda.

void	is_lambda (bool is_lambda)
	Set whether the class is a lambda.

bool	is_objc_interface () const

void	is_objc_interface (bool is_objc_interface)

bool	is_objc_protocol () const

void	is_objc_protocol (bool is_objc_protocol)

void	set_lambda_operator_id (eid_t id)

eid_t	lambda_operator_id () const

Public Member Functions inherited from clanguml::sequence_diagram::model::participant
	participant (const participant &)=delete

	participant (participant &&) noexcept=delete

participant &	operator= (const participant &)=delete

participant &	operator= (participant &&)=delete

	~participant () override=default

std::string	type_name () const override

virtual std::string	to_string () const
	Create a string representation of the participant.

Public Member Functions inherited from clanguml::common::model::template_element
	~template_element () override=default

bool	is_template () const

void	is_template (bool is_template)

int	calculate_template_specialization_match (const template_element &other) const
	Calculate template specialization match with other class.

bool	template_specialization_found () const

void	template_specialization_found (bool found)

	element (namespace_ using_namespace, path_type pt=path_type::kNamespace)

Public Member Functions inherited from clanguml::common::model::element
	element (namespace_ using_namespace, path_type pt=path_type::kNamespace)

	~element () override=default

std::string	name_and_ns () const

void	set_namespace (const namespace_ &ns)

namespace_	get_namespace () const

namespace_	get_relative_namespace () const

const namespace_ &	path () const

void	set_module (const std::string &module)

std::optional< std::string >	module () const

void	set_module_private (const bool module_private)

bool	module_private () const

virtual std::string	full_name_no_ns () const

const namespace_ &	using_namespace () const

Public Member Functions inherited from clanguml::common::model::diagram_element
	diagram_element ()

	~diagram_element () override=default

const eid_t &	id () const
	Returns diagram element id.

void	set_id (eid_t id)

std::optional< eid_t >	parent_element_id () const

void	set_parent_element_id (eid_t id)

virtual std::string	alias () const
	Return elements' diagram alias.

void	set_name (const std::string &name)

void	set_name (const std::string &parent, const std::string &name)

std::string	name () const

virtual std::string	type_name () const

std::string	full_name (bool relative) const
	Return the elements fully qualified name.

std::vector< relationship > &	relationships ()

const std::vector< relationship > &	relationships () const

void	add_relationship (relationship &&cr)

void	append (const decorated_element &e)

bool	is_nested () const

void	nested (bool nested)

bool	complete () const

void	complete (bool completed)

void	remove_duplicate_relationships ()

virtual void	apply_filter (const diagram_filter &filter, const std::set< eid_t > &removed)

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)

Public Member Functions inherited from clanguml::util::memoized< full_name_tag_t, std::string, bool >
auto	memoize (bool is_complete, F &&f, Args... args) const

void	invalidate (Args... args) const

Public Member Functions inherited from clanguml::util::memoized< name_and_ns_tag, std::string >
auto	memoize (bool is_complete, F &&f, Args... args) const

void	invalidate (Args... args) const

Public Member Functions inherited from clanguml::common::model::template_trait
std::ostream &	render_template_params (std::ostream &ostr, const common::model::namespace_ &using_namespace, bool relative) const

void	add_template (template_parameter &&tmplt)

const std::vector< template_parameter > &	template_params () const

int	calculate_template_specialization_match (const template_trait &other) const
	Wrapper around calculate_template_params_specialization_match()

Public Member Functions inherited from clanguml::common::model::stylable_element
void	set_style (const std::string &style)

std::optional< std::string >	style () const

Protected Member Functions
std::string	full_name_impl (bool relative=true) const override

Protected Member Functions inherited from clanguml::common::model::element
std::string	full_name_impl (bool relative) const override

virtual std::string	name_and_ns_impl () const

virtual std::string	full_name_impl (bool) const

Private Attributes
bool	is_struct_ {false}

bool	is_template_ {false}

bool	is_template_instantiation_ {false}

bool	is_alias_ {false}

bool	is_lambda_ {false}

bool	is_objc_interface_ {false}

bool	is_objc_protocol_ {false}

eid_t	lambda_operator_id_ {}

std::string	full_name_

Friends
bool	operator== (const class_ &l, const class_ &r)

Additional Inherited Members
Public Types inherited from clanguml::sequence_diagram::model::participant
enum class	stereotype_t { participant = 0 , actor , boundary , control , entity , database , collections , queue }
	Enum representing stereotype of a participant. More...

Public Types inherited from clanguml::util::memoized< full_name_tag_t, std::string, bool >
using	key_t = std::tuple< Args... >

using	value_t = std::string

Public Types inherited from clanguml::util::memoized< name_and_ns_tag, std::string >
using	key_t = std::tuple< Args... >

using	value_t = std::string

Public Attributes inherited from clanguml::sequence_diagram::model::participant
stereotype_t	stereotype_ {stereotype_t::participant}

Constructor & Destructor Documentation

◆ class_() [1/3]

clanguml::sequence_diagram::model::class_::class_ ( const common::model::namespace_ & using_namespace )

Definition at line 29 of file participant.cc.

    : participant{using_namespace}
{
}

◆ class_() [2/3]

clanguml::sequence_diagram::model::class_::class_ ( const class_ & )

delete

◆ class_() [3/3]

clanguml::sequence_diagram::model::class_::class_ ( class_ && )

deletenoexcept

◆ ~class_()

clanguml::sequence_diagram::model::class_::~class_ ( )

overridedefault

Member Function Documentation

◆ full_name_impl()

std::string clanguml::sequence_diagram::model::class_::full_name_impl ( bool relative = true ) const

overrideprotectedvirtual

Return elements full name.

Returns: Fully qualified elements name.

Reimplemented from clanguml::common::model::diagram_element.

Definition at line 65 of file participant.cc.

{
    using namespace clanguml::util;
    using clanguml::common::model::namespace_;
 
    std::ostringstream ostr;
 
    if (relative)
        ostr << name();
    else
        ostr << name_and_ns();
    render_template_params(ostr, using_namespace(), relative);
 
    std::string res;
 
    if (relative)
        res = using_namespace().relative(ostr.str());
    else
        res = ostr.str();
 
    if (res.empty())
        return "<<anonymous>>";
 
    return res;
}

◆ full_name_no_ns()

std::string clanguml::sequence_diagram::model::class_::full_name_no_ns ( ) const

overridevirtual

Return elements full name but without namespace.

Returns: Elements full name without namespace.

Reimplemented from clanguml::common::model::element.

Definition at line 52 of file participant.cc.

{
    using namespace clanguml::util;
 
    std::ostringstream ostr;
 
    ostr << name();
 
    render_template_params(ostr, using_namespace(), false);
 
    return ostr.str();
}

◆ is_abstract()

bool clanguml::sequence_diagram::model::class_::is_abstract ( ) const

Check if class is a abstract.

Returns: True, if the class is abstract.

◆ is_alias() [1/2]

bool clanguml::sequence_diagram::model::class_::is_alias ( ) const

Check if class is a typedef/using alias.

Returns: True, if the class is a typedef/using alias.

Definition at line 91 of file participant.cc.

91{ return is_alias_; }

◆ is_alias() [2/2]

void clanguml::sequence_diagram::model::class_::is_alias ( bool alias )

Set whether the class is an alias.

Parameters

alias True if the class is a typedef/using alias.

Definition at line 93 of file participant.cc.

93{ is_alias_ = alias; }

◆ is_lambda() [1/2]

bool clanguml::sequence_diagram::model::class_::is_lambda ( ) const

Check if the class is lambda.

Returns

Definition at line 95 of file participant.cc.

95{ return is_lambda_; }

◆ is_lambda() [2/2]

void clanguml::sequence_diagram::model::class_::is_lambda ( bool is_lambda )

Set whether the class is a lambda.

Parameters

is_lambda True, if the class is a lambda

Definition at line 97 of file participant.cc.

97{ is_lambda_ = is_lambda; }

◆ is_objc_interface() [1/2]

bool clanguml::sequence_diagram::model::class_::is_objc_interface ( ) const

Definition at line 99 of file participant.cc.

99{ return is_objc_interface_; }

◆ is_objc_interface() [2/2]

void clanguml::sequence_diagram::model::class_::is_objc_interface ( bool is_objc_interface )

Definition at line 101 of file participant.cc.

{
    is_objc_interface_ = is_objc_interface;
}

◆ is_objc_protocol() [1/2]

bool clanguml::sequence_diagram::model::class_::is_objc_protocol ( ) const

Definition at line 106 of file participant.cc.

106{ return is_objc_protocol_; }

◆ is_objc_protocol() [2/2]

void clanguml::sequence_diagram::model::class_::is_objc_protocol ( bool is_objc_protocol )

Definition at line 108 of file participant.cc.

{
    is_objc_protocol_ = is_objc_protocol;
}

◆ is_struct() [1/2]

bool clanguml::sequence_diagram::model::class_::is_struct ( ) const

Check if class is a struct.

Returns: True, if the class is declared as struct.

Definition at line 34 of file participant.cc.

34{ return is_struct_; }

◆ is_struct() [2/2]

void clanguml::sequence_diagram::model::class_::is_struct ( bool is_struct )

Set whether the class is a struct.

Parameters

is_struct True, if the class is declared as struct

Definition at line 36 of file participant.cc.

36{ is_struct_ = is_struct; }

◆ is_template() [1/2]

bool clanguml::sequence_diagram::model::class_::is_template ( ) const

Check if class is a template.

Returns: True, if the class is a template.

Definition at line 38 of file participant.cc.

38{ return is_template_; }

◆ is_template() [2/2]

void clanguml::sequence_diagram::model::class_::is_template ( bool is_template )

Set whether the class is a template instantiation.

Parameters

is_template True, if the class is a template

Definition at line 40 of file participant.cc.

40{ is_template_ = is_template; }

◆ is_template_instantiation() [1/2]

bool clanguml::sequence_diagram::model::class_::is_template_instantiation ( ) const

Check if class is a template instantiation.

Returns: True, if the class is a template instantiation.

Definition at line 42 of file participant.cc.

{
    return is_template_instantiation_;
}

◆ is_template_instantiation() [2/2]

void clanguml::sequence_diagram::model::class_::is_template_instantiation ( bool is_template_instantiation )

Set whether the class is a template instantiation.

Parameters

is_template_instantiation True, if the class is a template instantiation.

Definition at line 47 of file participant.cc.

{
    is_template_instantiation_ = is_template_instantiation;
}

◆ lambda_operator_id()

eid_t clanguml::sequence_diagram::model::class_::lambda_operator_id ( ) const

inline

Definition at line 204 of file participant.h.

204{ return lambda_operator_id_; }

◆ operator=() [1/2]

class_ & clanguml::sequence_diagram::model::class_::operator= ( class_ && )

delete

◆ operator=() [2/2]

class_ & clanguml::sequence_diagram::model::class_::operator= ( const class_ & )

delete

◆ set_lambda_operator_id()

void clanguml::sequence_diagram::model::class_::set_lambda_operator_id ( eid_t id )

inline

Definition at line 202 of file participant.h.

202{ lambda_operator_id_ = id; }

◆ type_name()

std::string clanguml::sequence_diagram::model::class_::type_name ( ) const

inlineoverridevirtual

Get the type name of the diagram element.

Returns: Type name of the diagram element.

Reimplemented from clanguml::common::model::diagram_element.

Definition at line 97 of file participant.h.

    {
        if (is_lambda())
            return "lambda";
 
        if (is_objc_interface())
            return "objc_interface";
 
        return "class";
    }

Friends And Related Symbol Documentation

◆ operator==

bool operator==	(	const class_ &	l,
		const class_ &	r
	)

friend

Definition at line 113 of file participant.cc.

113{ return l.id() == r.id(); }

Member Data Documentation

◆ full_name_

std::string clanguml::sequence_diagram::model::class_::full_name_

private

Definition at line 224 of file participant.h.

◆ is_alias_

bool clanguml::sequence_diagram::model::class_::is_alias_ {false}

private

Definition at line 218 of file participant.h.

◆ is_lambda_

bool clanguml::sequence_diagram::model::class_::is_lambda_ {false}

private

Definition at line 219 of file participant.h.

◆ is_objc_interface_

bool clanguml::sequence_diagram::model::class_::is_objc_interface_ {false}

private

Definition at line 220 of file participant.h.

◆ is_objc_protocol_

bool clanguml::sequence_diagram::model::class_::is_objc_protocol_ {false}

private

Definition at line 221 of file participant.h.

◆ is_struct_

bool clanguml::sequence_diagram::model::class_::is_struct_ {false}

private

Definition at line 215 of file participant.h.

◆ is_template_

bool clanguml::sequence_diagram::model::class_::is_template_ {false}

private

Definition at line 216 of file participant.h.

◆ is_template_instantiation_

bool clanguml::sequence_diagram::model::class_::is_template_instantiation_ {false}

private

Definition at line 217 of file participant.h.

◆ lambda_operator_id_

eid_t clanguml::sequence_diagram::model::class_::lambda_operator_id_ {}

private

Definition at line 222 of file participant.h.

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

src/sequence_diagram/model/participant.h
src/sequence_diagram/model/participant.cc

Detailed Description

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ class_() [1/3]

◆ class_() [2/3]

◆ class_() [3/3]

◆ ~class_()

Member Function Documentation

◆ full_name_impl()

◆ full_name_no_ns()

◆ is_abstract()

◆ is_alias() [1/2]

◆ is_alias() [2/2]

◆ is_lambda() [1/2]

◆ is_lambda() [2/2]

◆ is_objc_interface() [1/2]

◆ is_objc_interface() [2/2]

◆ is_objc_protocol() [1/2]

◆ is_objc_protocol() [2/2]

◆ is_struct() [1/2]

◆ is_struct() [2/2]

◆ is_template() [1/2]

◆ is_template() [2/2]

◆ is_template_instantiation() [1/2]

◆ is_template_instantiation() [2/2]

◆ lambda_operator_id()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_lambda_operator_id()

◆ type_name()

Friends And Related Symbol Documentation

◆ operator==

Member Data Documentation

◆ full_name_

◆ is_alias_

◆ is_lambda_

◆ is_objc_interface_

◆ is_objc_protocol_

◆ is_struct_

◆ is_template_

◆ is_template_instantiation_

◆ lambda_operator_id_