Class representing any relationship other than inheritance. More...

Detailed Description

Class representing any relationship other than inheritance.

This class represents all kinds of relationships between diagram elements, except for inheritance which are handled in a special way (See clanguml::class_diagram::model::class_parent).

Definition at line 40 of file relationship.h.

#include <relationship.h>

Public Member Functions
	relationship (relationship_t type, eid_t destination, access_t access=access_t::kPublic, std::string label="", std::string multiplicity_source="", std::string multiplicity_destination="")

	relationship (eid_t destination, access_t access=access_t::kPublic, bool is_virtual=false)

	~relationship () override=default

void	set_type (relationship_t type) noexcept

relationship_t	type () const noexcept

void	set_destination (eid_t destination)

eid_t	destination () const

void	set_multiplicity_source (const std::string &multiplicity_source)

std::string	multiplicity_source () const

void	set_multiplicity_destination (const std::string &multiplicity_destination)

std::string	multiplicity_destination () const

void	set_label (const std::string &label)

std::string	label () const

void	set_access (access_t scope) noexcept

access_t	access () const noexcept

bool	is_virtual () const

void	set_virtual (bool iv)

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::stylable_element
void	set_style (const std::string &style)

std::optional< std::string >	style () 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
relationship_t	type_

eid_t	destination_

std::string	multiplicity_source_

std::string	multiplicity_destination_

std::string	label_

access_t	access_

bool	is_virtual_

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

Constructor & Destructor Documentation

◆ relationship() [1/2]

clanguml::common::model::relationship::relationship	(	relationship_t	type,
		eid_t	destination,
		access_t	access = `access_t::kPublic`,
		std::string	label = `""`,
		std::string	multiplicity_source = `""`,
		std::string	multiplicity_destination = `""`
	)

Constructor.

Parameters

type	Type of relationship
destination	Id of the relationship target
access	Access scope of the relationship
label	Relationship label
multiplicity_source	Multiplicity at the source
multiplicity_destination	Multiplicity at the destination

Definition at line 25 of file relationship.cc.

    : type_{type}
    , destination_{destination}
    , multiplicity_source_{std::move(multiplicity_source)}
    , multiplicity_destination_{std::move(multiplicity_destination)}
    , label_{std::move(label)}
    , access_{access}
    , is_virtual_{false}
{
}

◆ relationship() [2/2]

clanguml::common::model::relationship::relationship	(	eid_t	destination,
		access_t	access = `access_t::kPublic`,
		bool	is_virtual = `false`
	)

Convenience constructor for extension relationships.

Parameters

destination	Id of relationship target.
access	Inheritance access (public, protected, private).
is_virtual	Whether the inheritance is virtual.

Definition at line 38 of file relationship.cc.

    : relationship{relationship_t::kExtension, destination, access}
{
    set_virtual(is_virtual);
}

◆ ~relationship()

clanguml::common::model::relationship::~relationship ( )

overridedefault

Member Function Documentation

◆ access()

access_t clanguml::common::model::relationship::access ( ) const

noexcept

Get the relationship access scope (e.g. public).

Returns: Access scope

Definition at line 83 of file relationship.cc.

83{ return access_; }

◆ destination()

eid_t clanguml::common::model::relationship::destination ( ) const

Get the id of the target element of this relationship.

Returns: Target element id.

Definition at line 53 of file relationship.cc.

53{ return destination_; }

◆ is_virtual()

bool clanguml::common::model::relationship::is_virtual ( ) const

Return true if an extension relationship is virtual.

Returns: True if an extension relationship is virtual.

Definition at line 85 of file relationship.cc.

85{ return is_virtual_; }

◆ label()

std::string clanguml::common::model::relationship::label ( ) const

Get the relationship label.

Returns: Relationoship label.

Definition at line 79 of file relationship.cc.

79{ return label_; }

◆ multiplicity_destination()

std::string clanguml::common::model::relationship::multiplicity_destination ( ) const

Set the relationship multiplicity at the destination.

Returns: Destination multiplicity.

Definition at line 72 of file relationship.cc.

{
    return multiplicity_destination_;
}

◆ multiplicity_source()

std::string clanguml::common::model::relationship::multiplicity_source ( ) const

Set the relationship multiplicity at the source.

Returns: Source multiplicity.

Definition at line 61 of file relationship.cc.

{
    return multiplicity_source_;
}

◆ set_access()

void clanguml::common::model::relationship::set_access ( access_t scope )

noexcept

Set the access scope for this relationship (e.g public)

Parameters

scope Access scope

Definition at line 81 of file relationship.cc.

81{ access_ = access; }

◆ set_destination()

void clanguml::common::model::relationship::set_destination ( eid_t destination )

Set id of the diagram element which is the target of this relationship.

Parameters

destination Target element id.

Definition at line 48 of file relationship.cc.

{
    destination_ = destination;
}

◆ set_label()

void clanguml::common::model::relationship::set_label ( const std::string & label )

Set relationship label.

Parameters

label Relationship label.

Definition at line 77 of file relationship.cc.

77{ label_ = label; }

◆ set_multiplicity_destination()

void clanguml::common::model::relationship::set_multiplicity_destination ( const std::string & multiplicity_destination )

Set the relationship multiplicity at the destination.

Parameters

multiplicity_destination Destination multiplicity.

Definition at line 66 of file relationship.cc.

{
    multiplicity_destination_ = multiplicity_destination;
}

◆ set_multiplicity_source()

void clanguml::common::model::relationship::set_multiplicity_source ( const std::string & multiplicity_source )

Set the relationship multiplicity at the source.

Parameters

multiplicity_source Source multiplicity.

Definition at line 55 of file relationship.cc.

{
    multiplicity_source_ = multiplicity_source;
}

◆ set_type()

void clanguml::common::model::relationship::set_type ( relationship_t type )

noexcept

Set the type of relatinoship.

Parameters

type	Type of relationship.

Definition at line 44 of file relationship.cc.

44{ type_ = type; }

◆ set_virtual()

void clanguml::common::model::relationship::set_virtual ( bool iv )

Sets whether an extension relationship is virtual.

Parameters

iv	True, if an extension relationship is virtual.

Definition at line 87 of file relationship.cc.

{
    assert(type() == relationship_t::kExtension);
    is_virtual_ = iv;
}

◆ type()

relationship_t clanguml::common::model::relationship::type ( ) const

noexcept

Get the type of relatinoship.

Returns: Type of relationship.

Definition at line 46 of file relationship.cc.

46{ return type_; }

Friends And Related Symbol Documentation

◆ operator==

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

friend

Definition at line 93 of file relationship.cc.

{
    return l.type() == r.type() && l.destination() == r.destination() &&
        l.label() == r.label();
}

Member Data Documentation

◆ access_

access_t clanguml::common::model::relationship::access_

private

Definition at line 179 of file relationship.h.

◆ destination_

eid_t clanguml::common::model::relationship::destination_

private

Definition at line 175 of file relationship.h.

◆ is_virtual_

bool clanguml::common::model::relationship::is_virtual_

private

Definition at line 180 of file relationship.h.

◆ label_

std::string clanguml::common::model::relationship::label_

private

Definition at line 178 of file relationship.h.

◆ multiplicity_destination_

std::string clanguml::common::model::relationship::multiplicity_destination_

private

Definition at line 177 of file relationship.h.

◆ multiplicity_source_

std::string clanguml::common::model::relationship::multiplicity_source_

private

Definition at line 176 of file relationship.h.

◆ type_

relationship_t clanguml::common::model::relationship::type_

private

Definition at line 174 of file relationship.h.

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

src/common/model/relationship.h
src/common/model/relationship.cc

Detailed Description

Public Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ relationship() [1/2]

◆ relationship() [2/2]

◆ ~relationship()

Member Function Documentation

◆ access()

◆ destination()

◆ is_virtual()

◆ label()

◆ multiplicity_destination()

◆ multiplicity_source()

◆ set_access()

◆ set_destination()

◆ set_label()

◆ set_multiplicity_destination()

◆ set_multiplicity_source()

◆ set_type()

◆ set_virtual()

◆ type()

Friends And Related Symbol Documentation

◆ operator==

Member Data Documentation

◆ access_

◆ destination_

◆ is_virtual_

◆ label_

◆ multiplicity_destination_

◆ multiplicity_source_

◆ type_