PropertyDefinitionFormatter Class Reference

PropertyDefinitionFormatter is the base class for all formatters of PropertyDefinitions. More...

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

Inheritance diagram for PropertyDefinitionFormatter:

Public Member Functions
virtual std::string	formatAttribute (std::string name, std::string details)=0
virtual std::string	formatBounds (std::string min, std::string max)=0
virtual std::string	formatCaseSensitivity (std::string caseSensitivity)=0
virtual std::string	formatDefault (std::string default_)=0
virtual std::string	formatDefinition (std::string name, std::string description, std::string min, std::string max, std::string default_, std::string casesensitivity, std::string requirement, std::string reged, std::vector< std::string > values, std::string value)=0
virtual std::string	formatDescription (std::string description)=0
virtual std::string	formatHeader (std::string headerText)=0
virtual std::string	formatName (std::string name)=0
virtual std::string	formatRegex (std::string regex)=0
virtual std::string	formatRequirement (std::string requirement)=0
virtual std::string	formatValue (std::string value)=0
virtual std::string	formatValues (std::vector< std::string > values)=0
virtual std::string	getFormat ()=0
virtual std::string	getPrefix () const
virtual void	setPrefix (std::string prefix)
virtual	~PropertyDefinitionFormatter ()

Protected Attributes
std::string	prefix

Detailed Description

PropertyDefinitionFormatter is the base class for all formatters of PropertyDefinitions.

Constructor & Destructor Documentation

~PropertyDefinitionFormatter()

virtual ~PropertyDefinitionFormatter ( )

inlinevirtual

Member Function Documentation

formatAttribute()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenComponentPagesFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatBounds()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatCaseSensitivity()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatDefault()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatDefinition()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenComponentPagesFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatDescription()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatHeader()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatName()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatRegex()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatRequirement()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatValue()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

formatValues()

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

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenComponentPagesFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

getFormat()

std::string getFormat ( )

pure virtual

Implemented in PropertyDefinitionBriefHelpFormatter, PropertyDefinitionConfigFormatter, PropertyDefinitionDoxygenComponentPagesFormatter, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, and PropertyDefinitionXmlFormatter.

getPrefix()

virtual std::string getPrefix ( ) const

inlinevirtual

setPrefix()

virtual void setPrefix ( std::string prefix )

inlinevirtual

Member Data Documentation

prefix

std::string prefix

protected

---

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

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