List of all members | Public Member Functions | Protected Attributes
PropertyDefinitionFormatter Class Referenceabstract
ArmarXCore » Distributed ProcessingArmarXCore » | Utility Features » Properties

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.

Definition at line 38 of file PropertyDefinitionFormatter.h.

Constructor & Destructor Documentation

◆ ~PropertyDefinitionFormatter()

virtual ~PropertyDefinitionFormatter ( )
inlinevirtual

Definition at line 41 of file PropertyDefinitionFormatter.h.

Member Function Documentation

◆ formatAttribute()

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

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

◆ formatBounds()

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

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

Definition at line 80 of file PropertyDefinitionFormatter.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatCaseSensitivity()

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

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

◆ formatDefault()

std::string formatDefault ( std::string  default_)
pure virtual

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

Definition at line 100 of file PropertyDefinitionFormatter.cpp.

+ Here is the caller graph for this function:

◆ 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, PropertyDefinitionDoxygenFormatter, PropertyDefinitionHelpFormatter, PropertyDefinitionXmlFormatter, and PropertyDefinitionDoxygenComponentPagesFormatter.

Definition at line 32 of file PropertyDefinitionFormatter.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatDescription()

std::string formatDescription ( std::string  description)
pure virtual

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

Definition at line 75 of file PropertyDefinitionFormatter.cpp.

+ Here is the caller graph for this function:

◆ formatHeader()

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

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

+ Here is the caller graph for this function:

◆ formatName()

std::string formatName ( std::string  name)
pure virtual

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

Definition at line 70 of file PropertyDefinitionFormatter.cpp.

+ Here is the caller graph for this function:

◆ formatRegex()

std::string formatRegex ( std::string  regex)
pure virtual

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

Definition at line 115 of file PropertyDefinitionFormatter.cpp.

◆ formatRequirement()

std::string formatRequirement ( std::string  requirement)
pure virtual

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

Definition at line 110 of file PropertyDefinitionFormatter.cpp.

◆ formatValue()

std::string formatValue ( std::string  value)
pure virtual

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

Definition at line 144 of file PropertyDefinitionFormatter.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ formatValues()

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

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

Definition at line 120 of file PropertyDefinitionFormatter.cpp.

+ Here is the call graph for this function:

◆ getFormat()

std::string getFormat ( )
pure virtual

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

Definition at line 57 of file PropertyDefinitionFormatter.cpp.

+ Here is the caller graph for this function:

◆ getPrefix()

virtual std::string getPrefix ( ) const
inlinevirtual

Definition at line 75 of file PropertyDefinitionFormatter.h.

+ Here is the caller graph for this function:

◆ setPrefix()

virtual void setPrefix ( std::string  prefix)
inlinevirtual

Definition at line 70 of file PropertyDefinitionFormatter.h.

+ Here is the caller graph for this function:

Member Data Documentation

◆ prefix

std::string prefix
protected

Definition at line 81 of file PropertyDefinitionFormatter.h.

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