GranOO  3.0
A robust and versatile workbench to build 3D dynamic simulations based on the Discrete Element Method
Public Member Functions | Static Public Member Functions | Public Attributes | Static Private Member Functions | List of all members
GranOO3::Core::Doc Class Reference

#include <Doc.hpp>

Public Member Functions

 Doc (const std::string &, const std::string &, const std::string &, const std::string &)
 
 Doc (const std::string &, const std::string &, const std::string &)
 

Static Public Member Functions

static bool add (const std::string &section, const std::string &subsection, const std::string &file_name, const std::string &description)
 
static bool add (const std::string &section, const std::string &file_name, const std::string &description)
 
static std::string list (const std::vector< Doc > &, bool desc)
 
static std::string list_all (bool desc)
 
static std::string list_section (const std::string base_regexp, bool desc)
 
static std::string list_subsection (const std::string child_regexp, const std::string base_regexp, bool desc)
 
static std::vector< Docget_section (const std::string base_regexp)
 

Public Attributes

const std::string section
 
const std::string subsection
 
const std::string file_name
 
const std::string description
 
const bool subsection_description
 

Static Private Member Functions

static std::vector< Doc > & all ()
 

Constructor & Destructor Documentation

◆ Doc() [1/2]

GranOO3::Core::Doc::Doc ( const std::string &  section,
const std::string &  subsection,
const std::string &  file_name,
const std::string &  desc 
)

◆ Doc() [2/2]

GranOO3::Core::Doc::Doc ( const std::string &  section,
const std::string &  file_name,
const std::string &  desc 
)

Member Function Documentation

◆ add() [1/2]

bool GranOO3::Core::Doc::add ( const std::string &  section,
const std::string &  file_name,
const std::string &  description 
)
static

◆ add() [2/2]

bool GranOO3::Core::Doc::add ( const std::string &  section,
const std::string &  subsection,
const std::string &  file_name,
const std::string &  description 
)
static

◆ all()

std::vector< Doc > & GranOO3::Core::Doc::all ( )
staticprivate

◆ get_section()

std::vector< Doc > GranOO3::Core::Doc::get_section ( const std::string  base_regexp)
static

◆ list()

std::string GranOO3::Core::Doc::list ( const std::vector< Doc > &  vec,
bool  desc 
)
static

◆ list_all()

std::string GranOO3::Core::Doc::list_all ( bool  desc)
static

◆ list_section()

std::string GranOO3::Core::Doc::list_section ( const std::string  base_regexp,
bool  desc 
)
static

◆ list_subsection()

std::string GranOO3::Core::Doc::list_subsection ( const std::string  child_regexp,
const std::string  base_regexp,
bool  desc 
)
static

Member Data Documentation

◆ description

const std::string GranOO3::Core::Doc::description

◆ file_name

const std::string GranOO3::Core::Doc::file_name

◆ section

const std::string GranOO3::Core::Doc::section

◆ subsection

const std::string GranOO3::Core::Doc::subsection

◆ subsection_description

const bool GranOO3::Core::Doc::subsection_description

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