PLMD::Keywords::component Struct Reference

Public Member Functions
	component ()
component &	setDocstring (std::string_view d)
component &	setKey (std::string_view k)
component &	setType (componentType t)

Public Attributes
std::string	docstring
	The documentation for the component.
std::string	key
	The keyword that turns on this component.
componentType	type
	The type of the component.

Constructor & Destructor Documentation

component()

PLMD::Keywords::component::component

(

)

Member Function Documentation

setDocstring()

Keywords::component & PLMD::Keywords::component::setDocstring

(

std::string_view

d

)

setKey()

Keywords::component & PLMD::Keywords::component::setKey

(

std::string_view

k

)

setType()

Keywords::component & PLMD::Keywords::component::setType

(

componentType

t

)

Member Data Documentation

docstring

std::string PLMD::Keywords::component::docstring

The documentation for the component.

key

std::string PLMD::Keywords::component::key

The keyword that turns on this component.

type

componentType PLMD::Keywords::component::type

The type of the component.

---

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

• tools/Keywords.h
• tools/Keywords.cpp