PropertyDefinitionBriefHelpFormatter Class Reference

PropertyDefinitionBriefHelpFormatter. More...

#include <ArmarXCore/core/application/properties/PropertyDefinitionBriefHelpFormatter.h>

Inheritance diagram for PropertyDefinitionBriefHelpFormatter:

Public Member Functions
std::string	formatAttribute (std::string name, std::string details) override
std::string	formatBounds (std::string min, std::string max) override
std::string	formatCaseSensitivity (std::string caseSensitivity) override
std::string	formatDefault (std::string default_) override
std::string	formatDefinition (std::string name, std::string description, std::string min, std::string max, std::string defaultValue, std::string casesensitivity, std::string requirement, std::string reged, std::vector< std::string > values, std::string value) override
std::string	formatDescription (std::string description) override
std::string	formatHeader (std::string headerText) override
std::string	formatName (std::string name) override
std::string	formatRegex (std::string regex) override
std::string	formatRequirement (std::string requirement) override
std::string	formatValue (std::string value) override
std::string	formatValues (std::vector< std::string > values) override
std::string	getFormat () override
	PropertyDefinitionBriefHelpFormatter (boost::program_options::options_description *optionsDescription)
Public Member Functions inherited from PropertyDefinitionFormatter
virtual std::string	getPrefix () const
virtual void	setPrefix (std::string prefix)
virtual	~PropertyDefinitionFormatter ()

Protected Attributes
boost::program_options::options_description *	optionsDescription
Protected Attributes inherited from PropertyDefinitionFormatter
std::string	prefix

Detailed Description

PropertyDefinitionBriefHelpFormatter.

Definition at line 46 of file PropertyDefinitionBriefHelpFormatter.h.

Constructor & Destructor Documentation

PropertyDefinitionBriefHelpFormatter()

PropertyDefinitionBriefHelpFormatter

(

boost::program_options::options_description *

optionsDescription

)

Definition at line 37 of file PropertyDefinitionBriefHelpFormatter.cpp.

Member Function Documentation

formatAttribute()

std::string formatAttribute ( std::string  name, std::string  details  )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 98 of file PropertyDefinitionBriefHelpFormatter.h.

formatBounds()

std::string formatBounds ( std::string  min, std::string  max  )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 70 of file PropertyDefinitionBriefHelpFormatter.h.

formatCaseSensitivity()

std::string formatCaseSensitivity ( std::string  caseSensitivity )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 78 of file PropertyDefinitionBriefHelpFormatter.h.

formatDefault()

std::string formatDefault ( std::string  default_ )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 74 of file PropertyDefinitionBriefHelpFormatter.h.

formatDefinition()

std::string formatDefinition ( std::string  name, std::string  description, std::string  min, std::string  max, std::string  defaultValue, std::string  casesensitivity, std::string  requirement, std::string  reged, std::vector< std::string >  values, std::string  value  )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 43 of file PropertyDefinitionBriefHelpFormatter.cpp.

Here is the call graph for this function:

formatDescription()

std::string formatDescription ( std::string  description )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 66 of file PropertyDefinitionBriefHelpFormatter.h.

formatHeader()

std::string formatHeader ( std::string  headerText )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 68 of file PropertyDefinitionBriefHelpFormatter.cpp.

formatName()

std::string formatName ( std::string  name )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 62 of file PropertyDefinitionBriefHelpFormatter.h.

formatRegex()

std::string formatRegex ( std::string  regex )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 86 of file PropertyDefinitionBriefHelpFormatter.h.

formatRequirement()

std::string formatRequirement ( std::string  requirement )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 82 of file PropertyDefinitionBriefHelpFormatter.h.

formatValue()

std::string formatValue ( std::string  value )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 90 of file PropertyDefinitionBriefHelpFormatter.h.

formatValues()

std::string formatValues ( std::vector< std::string >  values )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 94 of file PropertyDefinitionBriefHelpFormatter.h.

getFormat()

std::string getFormat ( )

inlineoverridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 105 of file PropertyDefinitionBriefHelpFormatter.h.

Member Data Documentation

optionsDescription

boost::program_options::options_description* optionsDescription

protected

Definition at line 111 of file PropertyDefinitionBriefHelpFormatter.h.

---

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

• ArmarXCore/core/application/properties/PropertyDefinitionBriefHelpFormatter.h
• ArmarXCore/core/application/properties/PropertyDefinitionBriefHelpFormatter.cpp