StatechartGroupDocGenerator Class Reference

#include <ArmarXCore/statechart/xmlstates/StateGroupDocGenerator.h>

Public Member Functions
void	buildReferenceIndex (const std::vector< std::string > &groups)
std::string	generateDocString (const StatechartGroupXmlReaderPtr &reader) const
void	generateDoxygenFile (const std::string &groupDefinitionFilePath)
void	generateDoxygenFiles (const std::vector< std::string > &groups)
CMakePackageFinder	getFinder (const StatechartGroupXmlReaderPtr &reader)
std::set< std::string >	getUsedProfiles (const RapidXmlReaderNode &stateNode) const
void	setOutputpath (const std::string &outputPath)
	StatechartGroupDocGenerator ()

Static Public Member Functions
static std::vector< std::string >	FindAllStatechartGroupDefinitions (const std::filesystem::path &path)

Protected Attributes
std::map< std::string, CMakePackageFinder >	finders
std::string	outputPath
std::map< std::string, std::set< std::string > >	usageMap
std::map< std::string, StateInfo >	uuidToStateInfoMap

Detailed Description

Definition at line 35 of file StateGroupDocGenerator.h.

Constructor & Destructor Documentation

StatechartGroupDocGenerator()

StatechartGroupDocGenerator

(

)

Definition at line 40 of file StateGroupDocGenerator.cpp.

Member Function Documentation

buildReferenceIndex()

void buildReferenceIndex

(

const std::vector< std::string > &

groups

)

Definition at line 401 of file StateGroupDocGenerator.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

FindAllStatechartGroupDefinitions()

std::vector< std::string > FindAllStatechartGroupDefinitions ( const std::filesystem::path &  path )

static

Definition at line 448 of file StateGroupDocGenerator.cpp.

Here is the caller graph for this function:

generateDocString()

std::string generateDocString

(

const StatechartGroupXmlReaderPtr &

reader

)

const

Definition at line 185 of file StateGroupDocGenerator.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

generateDoxygenFile()

void generateDoxygenFile

(

const std::string &

groupDefinitionFilePath

)

Definition at line 362 of file StateGroupDocGenerator.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

generateDoxygenFiles()

void generateDoxygenFiles

(

const std::vector< std::string > &

groups

)

Definition at line 435 of file StateGroupDocGenerator.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getFinder()

CMakePackageFinder getFinder

(

const StatechartGroupXmlReaderPtr &

reader

)

Definition at line 478 of file StateGroupDocGenerator.cpp.

Here is the caller graph for this function:

getUsedProfiles()

std::set< std::string > getUsedProfiles

(

const RapidXmlReaderNode &

stateNode

)

const

Definition at line 45 of file StateGroupDocGenerator.cpp.

Here is the call graph for this function:

setOutputpath()

void setOutputpath

(

const std::string &

outputPath

)

Definition at line 443 of file StateGroupDocGenerator.cpp.

Here is the caller graph for this function:

Member Data Documentation

finders

std::map<std::string, CMakePackageFinder> finders

protected

Definition at line 64 of file StateGroupDocGenerator.h.

outputPath

std::string outputPath

protected

Definition at line 65 of file StateGroupDocGenerator.h.

usageMap

std::map<std::string, std::set<std::string> > usageMap

protected

Definition at line 67 of file StateGroupDocGenerator.h.

uuidToStateInfoMap

std::map<std::string, StateInfo> uuidToStateInfoMap

protected

Definition at line 66 of file StateGroupDocGenerator.h.

---

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

• ArmarXCore/statechart/xmlstates/StateGroupDocGenerator.h
• ArmarXCore/statechart/xmlstates/StateGroupDocGenerator.cpp