votca 2024-dev
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
votca::tools::PropertyIOManipulator Class Reference

Manipulates the format state of the output stream. More...

#include <propertyiomanipulator.h>

Collaboration diagram for votca::tools::PropertyIOManipulator:
Collaboration graph
[legend]

Public Types

enum  Type { XML , HLP , TXT }
 

Public Member Functions

 PropertyIOManipulator (Type type=XML, Index level=0, std::string indentation="", ColorSchemeBase *color_scheme=nullptr)
 
 ~PropertyIOManipulator ()
 
const TypegetType ()
 
void setType (Type type)
 
const IndexgetLevel ()
 
void setLevel (Index level)
 
const std::string & getIndentation ()
 
void setIndentation (std::string indentation)
 
const ColorSchemeBasegetColorScheme ()
 
template<typename T >
const ColorSchemeBasesetColorScheme ()
 

Private Attributes

Type type_
 
Index level_
 
std::string indentation_
 
ColorSchemeBasecolor_scheme_
 

Friends

std::ostream & operator<< (std::ostream &os, PropertyIOManipulator &piom)
 

Detailed Description

Manipulates the format state of the output stream.

Changes the state of the output stream. Property class reads this state and formats its output according to this state (XML, TXT, etc)

Definition at line 34 of file propertyiomanipulator.h.

Member Enumeration Documentation

◆ Type

Enumerator
XML 
HLP 
TXT 

Definition at line 37 of file propertyiomanipulator.h.

Constructor & Destructor Documentation

◆ PropertyIOManipulator()

votca::tools::PropertyIOManipulator::PropertyIOManipulator ( Type  type = XML,
Index  level = 0,
std::string  indentation = "",
ColorSchemeBase color_scheme = nullptr 
)
inlineexplicit

Definition at line 39 of file propertyiomanipulator.h.

◆ ~PropertyIOManipulator()

votca::tools::PropertyIOManipulator::~PropertyIOManipulator ( )
inline

Definition at line 49 of file propertyiomanipulator.h.

Member Function Documentation

◆ getColorScheme()

const ColorSchemeBase * votca::tools::PropertyIOManipulator::getColorScheme ( )
inline

Definition at line 62 of file propertyiomanipulator.h.

◆ getIndentation()

const std::string & votca::tools::PropertyIOManipulator::getIndentation ( )
inline

Definition at line 60 of file propertyiomanipulator.h.

◆ getLevel()

const Index & votca::tools::PropertyIOManipulator::getLevel ( )
inline

Definition at line 58 of file propertyiomanipulator.h.

◆ getType()

const Type & votca::tools::PropertyIOManipulator::getType ( )
inline

Definition at line 56 of file propertyiomanipulator.h.

◆ setColorScheme()

template<typename T >
const ColorSchemeBase * votca::tools::PropertyIOManipulator::setColorScheme ( )
inline

Definition at line 70 of file propertyiomanipulator.h.

◆ setIndentation()

void votca::tools::PropertyIOManipulator::setIndentation ( std::string  indentation)
inline

Definition at line 61 of file propertyiomanipulator.h.

◆ setLevel()

void votca::tools::PropertyIOManipulator::setLevel ( Index  level)
inline

Definition at line 59 of file propertyiomanipulator.h.

◆ setType()

void votca::tools::PropertyIOManipulator::setType ( Type  type)
inline

Definition at line 57 of file propertyiomanipulator.h.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
PropertyIOManipulator piom 
)
friend

Definition at line 50 of file propertyiomanipulator.h.

Member Data Documentation

◆ color_scheme_

ColorSchemeBase* votca::tools::PropertyIOManipulator::color_scheme_
private

Definition at line 82 of file propertyiomanipulator.h.

◆ indentation_

std::string votca::tools::PropertyIOManipulator::indentation_
private

Definition at line 81 of file propertyiomanipulator.h.

◆ level_

Index votca::tools::PropertyIOManipulator::level_
private

Definition at line 80 of file propertyiomanipulator.h.

◆ type_

Type votca::tools::PropertyIOManipulator::type_
private

Definition at line 79 of file propertyiomanipulator.h.


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