clanguml::class_diagram::model::method_parameter Class Reference

Model of a method parameter. More...

Detailed Description

Model of a method parameter.

Definition at line 31 of file method_parameter.h.

#include <method_parameter.h>

Public Member Functions
	method_parameter ()=default
	method_parameter (std::string type, std::string name, std::string default_value={})
	Constructor.
	~method_parameter () override=default
void	set_type (const std::string &type)
	Set parameters type.
std::string	type () const
	Get parameters type.
void	set_name (const std::string &name)
	Set parameters name.
std::string	name () const
	Get parameters name.
void	set_default_value (const std::string &value)
	Set parameters default value.
std::string	default_value () const
	Get parameters name.
std::string	to_string (const common::model::namespace_ &using_namespaces) const
	Render the method parameter to a string.
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

Private Attributes
std::string	type_
std::string	name_
std::string	default_value_

Constructor & Destructor Documentation

method_parameter() [1/2]

clanguml::class_diagram::model::method_parameter::method_parameter ( )

default

method_parameter() [2/2]

clanguml::class_diagram::model::method_parameter::method_parameter	(	std::string	type,
		std::string	name,
		std::string	default_value = {}
	)

Constructor.

Parameters

type	Type of the method parameter as string.
name	Name of the method parameter.
default_value	Default value of the parameter or empty.

Definition at line 25 of file method_parameter.cc.

    : type_{std::move(type)}
    , name_{std::move(name)}
    , default_value_{std::move(default_value)}
{
}

~method_parameter()

clanguml::class_diagram::model::method_parameter::~method_parameter ( )

overridedefault

Member Function Documentation

default_value()

std::string clanguml::class_diagram::model::method_parameter::default_value

(

)

const

Get parameters name.

Returns

Parameters name.

Definition at line 46 of file method_parameter.cc.

{ return default_value_; }

name()

std::string clanguml::class_diagram::model::method_parameter::name

(

)

const

Get parameters name.

Returns

Parameters name.

Definition at line 39 of file method_parameter.cc.

{ return name_; }

set_default_value()

void clanguml::class_diagram::model::method_parameter::set_default_value

(

const std::string &

value

)

Set parameters default value.

Parameters

type	Parameters default value as string.

Definition at line 41 of file method_parameter.cc.

{
    default_value_ = value;
}

set_name()

void clanguml::class_diagram::model::method_parameter::set_name

(

const std::string &

name

)

Set parameters name.

Parameters

type	Parameters name.

Definition at line 37 of file method_parameter.cc.

{ name_ = name; }

set_type()

void clanguml::class_diagram::model::method_parameter::set_type

(

const std::string &

type

)

Set parameters type.

Parameters

type	Parameters type as string.

Definition at line 33 of file method_parameter.cc.

{ type_ = type; }

to_string()

std::string clanguml::class_diagram::model::method_parameter::to_string

(

const common::model::namespace_ &

using_namespaces

)

const

Render the method parameter to a string.

Parameters

using_namespaces

If provided, make all namespaces relative to it.

Returns

String representation of the parameter.

Definition at line 48 of file method_parameter.cc.

{
    using namespace clanguml::util;
    auto type_ns =
        using_namespace.relative(common::model::namespace_{type()}.to_string());
 
    auto name_ns =
        using_namespace.relative(common::model::namespace_{name()}.to_string());
 
    if (default_value().empty()) {
        if (name_ns.empty())
            return type_ns;
 
        return fmt::format("{} {}", type_ns, name_ns);
    }
 
    return fmt::format("{} {} = {}", type_ns, name_ns, default_value());
}

type()

std::string clanguml::class_diagram::model::method_parameter::type

(

)

const

Get parameters type.

Returns

Parameters type as string.

Definition at line 35 of file method_parameter.cc.

{ return type_; }

Member Data Documentation

default_value_

std::string clanguml::class_diagram::model::method_parameter::default_value_

private

Definition at line 101 of file method_parameter.h.

name_

std::string clanguml::class_diagram::model::method_parameter::name_

private

Definition at line 100 of file method_parameter.h.

type_

std::string clanguml::class_diagram::model::method_parameter::type_

private

Definition at line 99 of file method_parameter.h.

---

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

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