0.5.4
C++ to UML diagram generator based on Clang
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
clanguml::class_diagram::model::class_member Class Reference

Class member model. More...

Detailed Description

Class member model.

Definition at line 29 of file class_member.h.

#include <class_member.h>

Public Member Functions

 class_member (common::model::access_t access, const std::string &name, const std::string &type)
 Constructor.
 
 ~class_member () override=default
 
bool is_static () const
 Whether the member is static.
 
void is_static (bool is_static)
 Set members static status.
 
void set_destination_multiplicity (std::optional< size_t > m)
 Set members destination multiplicity.
 
std::optional< size_t > destination_multiplicity () const
 Get members destination multiplicity.
 
- Public Member Functions inherited from clanguml::class_diagram::model::class_element
 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_tcomment () 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

bool is_static_ {false}
 
std::optional< size_t > destination_multiplicity_ {}
 

Constructor & Destructor Documentation

◆ class_member()

clanguml::class_diagram::model::class_member::class_member ( common::model::access_t  access,
const std::string &  name,
const std::string &  type 
)

Constructor.

Parameters
accessMembers access scope (e.g. public)
nameMembers name.
typeMembers type as string.

Definition at line 23 of file class_member.cc.

26{
27}

◆ ~class_member()

clanguml::class_diagram::model::class_member::~class_member ( )
overridedefault

Member Function Documentation

◆ destination_multiplicity()

std::optional< size_t > clanguml::class_diagram::model::class_member::destination_multiplicity ( ) const

Get members destination multiplicity.

Returns
Optional multiplicity value

Definition at line 38 of file class_member.cc.

39{
41}

◆ is_static() [1/2]

bool clanguml::class_diagram::model::class_member::is_static ( ) const

Whether the member is static.

Returns
True, if the member is static.

Definition at line 29 of file class_member.cc.

29{ return is_static_; }

◆ is_static() [2/2]

void clanguml::class_diagram::model::class_member::is_static ( bool  is_static)

Set members static status.

Parameters
is_staticTrue, if the member is static.

Definition at line 31 of file class_member.cc.

◆ set_destination_multiplicity()

void clanguml::class_diagram::model::class_member::set_destination_multiplicity ( std::optional< size_t >  m)

Set members destination multiplicity.

Parameters
mOptional multiplicity value

Definition at line 33 of file class_member.cc.

34{
36}

Member Data Documentation

◆ destination_multiplicity_

std::optional<size_t> clanguml::class_diagram::model::class_member::destination_multiplicity_ {}
private

Definition at line 73 of file class_member.h.

◆ is_static_

bool clanguml::class_diagram::model::class_member::is_static_ {false}
private

Definition at line 72 of file class_member.h.


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