credit Class Reference

Class that defines the name, argument name, author's name, email address, date and the version of the code. More...

#include <credit.h>

Inheritance diagram for credit:

Public Member Functions
	credit ()=default
	Default constructor.
	credit (std::string name, std::string argument_name)
	Constructor for credit. More...
virtual void	set_name (std::string name, std::string argument_name="")
	Set name (and perhaps, argument name together) More...
virtual std::string	get_name () const
	Get the name.
virtual void	set_argument_name (std::string argument_name)
	Set an argument name. More...
virtual std::string	get_argument_name () const
	Get an argument name. More...
virtual double	get_version () const
	Get version. More...
virtual std::string	get_author () const
	Get author's name. More...
virtual std::tuple< int, int, int >	get_date () const
	Get currently set date. More...
virtual std::string	get_email_address () const
	Get email address. More...

Protected Attributes
std::string	m_name
	Name of credit.
std::string	m_argument_name
	Argument name.

Detailed Description

Class that defines the name, argument name, author's name, email address, date and the version of the code.

Constructor & Destructor Documentation

credit()

credit::credit ( std::string  name, std::string  argument_name  )

inline

Constructor for credit.

Parameters

[in]	name	Name.
[in]	argument_name	Name for the argument (alternatively, space-less short name).

Member Function Documentation

get_argument_name()

virtual std::string credit::get_argument_name ( ) const

inlinevirtual

Get an argument name.

Returns

Currently set argument name.

get_author()

virtual std::string credit::get_author ( ) const

inlinevirtual

Get author's name.

Returns

Currently set author's name.

get_date()

virtual std::tuple<int,int,int> credit::get_date ( ) const

inlinevirtual

Get currently set date.

Returns

Currently set date.

get_email_address()

virtual std::string credit::get_email_address ( ) const

inlinevirtual

Get email address.

Returns

Currently set email address.

get_version()

virtual double credit::get_version ( ) const

inlinevirtual

Get version.

Returns

Currently set version.

set_argument_name()

virtual void credit::set_argument_name ( std::string  argument_name )

inlinevirtual

Set an argument name.

Parameters

[in]

argument_name

Name for the argument to set.

set_name()

virtual void credit::set_name ( std::string  name, std::string  argument_name = ""  )

inlinevirtual

Set name (and perhaps, argument name together)

Parameters

[in]	name	Name to set.
[in]	argument_name	Name for the argument to set (can be omitted).

---

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

• include/shiokaze/core/credit.h