Base class for various types of sequence diagram participants. More...

Detailed Description

Base class for various types of sequence diagram participants.

Definition at line 36 of file participant.h.

#include <participant.h>

Public Types
enum class	stereotype_t { participant = 0 , actor , boundary , control , entity , database , collections , queue }
	Enum representing stereotype of a participant. More...

Public Member Functions
	participant (const participant &)=delete

	participant (participant &&) noexcept=delete

participant &	operator= (const participant &)=delete

participant &	operator= (participant &&)=delete

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

std::string	full_name (bool relative) const override

virtual std::string	full_name_no_ns () const

const namespace_ &	using_namespace () const

inja::json	context () const override

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)

std::string	name () const

virtual std::string	type_name () const

virtual std::string	full_name (bool) 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)

virtual inja::json	context () const

bool	is_nested () const

void	nested (bool nested)

bool	complete () const

void	complete (bool completed)

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::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

Public Attributes
stereotype_t	stereotype_ {stereotype_t::participant}

Member Enumeration Documentation

◆ stereotype_t

enum class clanguml::sequence_diagram::model::participant::stereotype_t

strong

Enum representing stereotype of a participant.

Enumerator
participant
actor
boundary
control
entity
database
collections
queue

Definition at line 43 of file participant.h.

                            {
        participant = 0,
        actor,
        boundary,
        control,
        entity,
        database,
        collections,
        queue
    };

Constructor & Destructor Documentation

◆ participant() [1/2]

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

delete

◆ participant() [2/2]

clanguml::sequence_diagram::model::participant::participant ( participant && )

deletenoexcept

Member Function Documentation

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

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

delete

◆ to_string()

std::string clanguml::sequence_diagram::model::participant::to_string ( ) const

virtual

Create a string representation of the participant.

Returns: Participant representation as string

Reimplemented in clanguml::sequence_diagram::model::method.

Definition at line 23 of file participant.cc.

{
    return fmt::format(
        "Participant '{}': id={} name={}", type_name(), id(), full_name(false));
}

◆ type_name()

std::string clanguml::sequence_diagram::model::participant::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 64 of file participant.h.

64{ return "participant"; }

Member Data Documentation

◆ stereotype_

stereotype_t clanguml::sequence_diagram::model::participant::stereotype_ {stereotype_t::participant}

Definition at line 73 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 Types

Public Member Functions

Public Attributes

Member Enumeration Documentation

◆ stereotype_t

Constructor & Destructor Documentation

◆ participant() [1/2]

◆ participant() [2/2]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ to_string()

◆ type_name()

Member Data Documentation

◆ stereotype_