go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
xoutlibrary::xoutrow< charT, traits > Class Template Reference

#include <xoutrow.h>

Detailed Description

template<class charT, class traits = char_traits< charT >>
class xoutlibrary::xoutrow< charT, traits >

The xoutrow class can easily generate tables.

The xoutrow class is used in elastix for printing the registration information, such as metric value, gradient information, etc. You can fill in all this information, and only after calling WriteBufferedData() the entire row is printed to the desired outputs.

Definition at line 42 of file xoutrow.h.

+ Inheritance diagram for xoutlibrary::xoutrow< charT, traits >:

Public Types

typedef Superclass::char_type char_type
 
typedef Superclass::CStreamMapEntryType CStreamMapEntryType
 
typedef Superclass::CStreamMapIteratorType CStreamMapIteratorType
 
typedef Superclass::CStreamMapType CStreamMapType
 
typedef Superclass::int_type int_type
 
typedef Superclass::ios_type ios_type
 
typedef Superclass::off_type off_type
 
typedef Superclass::ostream_type ostream_type
 
typedef Superclass::pos_type pos_type
 
typedef xoutrow Self
 
typedef xoutbase< charT, traits > Superclass
 
typedef Superclass::traits_type traits_type
 
typedef xoutcell< charT, traits > XOutCellType
 
typedef Superclass::XStreamMapEntryType XStreamMapEntryType
 
typedef Superclass::XStreamMapIteratorType XStreamMapIteratorType
 
typedef Superclass::XStreamMapType XStreamMapType
 
- Public Types inherited from xoutlibrary::xoutbase< charT, char_traits< charT > >
typedef charT char_type
 
typedef CStreamMapType::value_type CStreamMapEntryType
 
typedef CStreamMapType::iterator CStreamMapIteratorType
 
typedef std::map< std::string, ostream_type * > CStreamMapType
 
typedef traits::int_type int_type
 
typedef basic_ios< charT, char_traits< charT > > ios_type
 
typedef traits::off_type off_type
 
typedef basic_ostream< charT, char_traits< charT > > ostream_type
 
typedef traits::pos_type pos_type
 
typedef xoutbase Self
 
typedef char_traits< charT > traits_type
 
typedef XStreamMapType::value_type XStreamMapEntryType
 
typedef XStreamMapType::iterator XStreamMapIteratorType
 
typedef std::map< std::string, Self * > XStreamMapType
 

Public Member Functions

int AddOutput (const char *name, ostream_type *output) override
 
int AddOutput (const char *name, Superclass *output) override
 
int AddTargetCell (const char *name) override
 
int RemoveOutput (const char *name) override
 
int RemoveTargetCell (const char *name) override
 
void SetOutputs (const CStreamMapType &outputmap) override
 
void SetOutputs (const XStreamMapType &outputmap) override
 
void SetTargetCells (const XStreamMapType &cellmap) override
 
void WriteBufferedData (void) override
 
virtual void WriteHeaders (void)
 
 xoutrow ()
 
 ~xoutrow () override
 
- Public Member Functions inherited from xoutlibrary::xoutbase< charT, char_traits< charT > >
virtual int AddOutput (const char *name, ostream_type *output)
 
virtual int AddOutput (const char *name, Self *output)
 
virtual int AddTargetCell (const char *)
 
virtual int AddTargetCell (const char *name, ostream_type *cell)
 
virtual int AddTargetCell (const char *name, Self *cell)
 
virtual const CStreamMapTypeGetCOutputs (void)
 
virtual const XStreamMapTypeGetXOutputs (void)
 
Selfoperator<< (const T &_arg)
 
Selfoperator<< (ios_base &(*pf)(ios_base &))
 
Selfoperator<< (ios_type &(*pf)(ios_type &))
 
Selfoperator<< (ostream_type &(*pf)(ostream_type &))
 
Selfoperator[] (const char *cellname)
 
virtual int RemoveOutput (const char *name)
 
virtual int RemoveTargetCell (const char *name)
 
virtual void SetOutputs (const CStreamMapType &outputmap)
 
virtual void SetOutputs (const XStreamMapType &outputmap)
 
virtual void SetTargetCells (const CStreamMapType &cellmap)
 
virtual void SetTargetCells (const XStreamMapType &cellmap)
 
virtual void WriteBufferedData (void)
 
 xoutbase ()=default
 
virtual ~xoutbase ()=default
 

Protected Member Functions

SuperclassSelectXCell (const char *name) override
 
- Protected Member Functions inherited from xoutlibrary::xoutbase< charT, char_traits< charT > >
virtual void Callback (void)
 
virtual SelfSelectXCell (const char *name)
 
SelfSendToTargets (const T &_arg)
 

Protected Attributes

XStreamMapType m_CellMap
 
- Protected Attributes inherited from xoutlibrary::xoutbase< charT, char_traits< charT > >
bool m_Call
 
CStreamMapType m_COutputs
 
CStreamMapType m_CTargetCells
 
XStreamMapType m_XOutputs
 
XStreamMapType m_XTargetCells
 

Member Typedef Documentation

◆ char_type

template<class charT , class traits = char_traits< charT >>
typedef Superclass::char_type xoutlibrary::xoutrow< charT, traits >::char_type

Definition at line 51 of file xoutrow.h.

◆ CStreamMapEntryType

template<class charT , class traits = char_traits< charT >>
typedef Superclass::CStreamMapEntryType xoutlibrary::xoutrow< charT, traits >::CStreamMapEntryType

Definition at line 62 of file xoutrow.h.

◆ CStreamMapIteratorType

template<class charT , class traits = char_traits< charT >>
typedef Superclass::CStreamMapIteratorType xoutlibrary::xoutrow< charT, traits >::CStreamMapIteratorType

Definition at line 60 of file xoutrow.h.

◆ CStreamMapType

template<class charT , class traits = char_traits< charT >>
typedef Superclass::CStreamMapType xoutlibrary::xoutrow< charT, traits >::CStreamMapType

Definition at line 58 of file xoutrow.h.

◆ int_type

template<class charT , class traits = char_traits< charT >>
typedef Superclass::int_type xoutlibrary::xoutrow< charT, traits >::int_type

Definition at line 52 of file xoutrow.h.

◆ ios_type

template<class charT , class traits = char_traits< charT >>
typedef Superclass::ios_type xoutlibrary::xoutrow< charT, traits >::ios_type

Definition at line 56 of file xoutrow.h.

◆ off_type

template<class charT , class traits = char_traits< charT >>
typedef Superclass::off_type xoutlibrary::xoutrow< charT, traits >::off_type

Definition at line 54 of file xoutrow.h.

◆ ostream_type

template<class charT , class traits = char_traits< charT >>
typedef Superclass::ostream_type xoutlibrary::xoutrow< charT, traits >::ostream_type

Definition at line 55 of file xoutrow.h.

◆ pos_type

template<class charT , class traits = char_traits< charT >>
typedef Superclass::pos_type xoutlibrary::xoutrow< charT, traits >::pos_type

Definition at line 53 of file xoutrow.h.

◆ Self

template<class charT , class traits = char_traits< charT >>
typedef xoutrow xoutlibrary::xoutrow< charT, traits >::Self

Definition at line 46 of file xoutrow.h.

◆ Superclass

template<class charT , class traits = char_traits< charT >>
typedef xoutbase< charT, traits > xoutlibrary::xoutrow< charT, traits >::Superclass

Definition at line 47 of file xoutrow.h.

◆ traits_type

template<class charT , class traits = char_traits< charT >>
typedef Superclass::traits_type xoutlibrary::xoutrow< charT, traits >::traits_type

Typedefs of Superclass

Definition at line 50 of file xoutrow.h.

◆ XOutCellType

template<class charT , class traits = char_traits< charT >>
typedef xoutcell< charT, traits > xoutlibrary::xoutrow< charT, traits >::XOutCellType

Extra typedefs

Definition at line 66 of file xoutrow.h.

◆ XStreamMapEntryType

template<class charT , class traits = char_traits< charT >>
typedef Superclass::XStreamMapEntryType xoutlibrary::xoutrow< charT, traits >::XStreamMapEntryType

Definition at line 63 of file xoutrow.h.

◆ XStreamMapIteratorType

template<class charT , class traits = char_traits< charT >>
typedef Superclass::XStreamMapIteratorType xoutlibrary::xoutrow< charT, traits >::XStreamMapIteratorType

Definition at line 61 of file xoutrow.h.

◆ XStreamMapType

template<class charT , class traits = char_traits< charT >>
typedef Superclass::XStreamMapType xoutlibrary::xoutrow< charT, traits >::XStreamMapType

Definition at line 59 of file xoutrow.h.

Constructor & Destructor Documentation

◆ xoutrow()

template<class charT , class traits = char_traits< charT >>
xoutlibrary::xoutrow< charT, traits >::xoutrow ( )

Constructor

◆ ~xoutrow()

template<class charT , class traits = char_traits< charT >>
xoutlibrary::xoutrow< charT, traits >::~xoutrow ( )
override

Destructor

Member Function Documentation

◆ AddOutput() [1/2]

template<class charT , class traits = char_traits< charT >>
int xoutlibrary::xoutrow< charT, traits >::AddOutput ( const char *  name,
ostream_type output 
)
override

Add/Remove an output stream (like cout, or an fstream, or an xout-object). In addition to the behaviour of the Superclass's methods, these functions set the outputs of the TargetCells as well.

◆ AddOutput() [2/2]

template<class charT , class traits = char_traits< charT >>
int xoutlibrary::xoutrow< charT, traits >::AddOutput ( const char *  name,
Superclass output 
)
override

◆ AddTargetCell()

template<class charT , class traits = char_traits< charT >>
int xoutlibrary::xoutrow< charT, traits >::AddTargetCell ( const char *  name)
overridevirtual

This method adds an xoutcell to the map of Targets.

Reimplemented from xoutlibrary::xoutbase< charT, char_traits< charT > >.

◆ RemoveOutput()

template<class charT , class traits = char_traits< charT >>
int xoutlibrary::xoutrow< charT, traits >::RemoveOutput ( const char *  name)
overridevirtual

◆ RemoveTargetCell()

template<class charT , class traits = char_traits< charT >>
int xoutlibrary::xoutrow< charT, traits >::RemoveTargetCell ( const char *  name)
overridevirtual

This method removes an xoutcell to the map of Targets.

Reimplemented from xoutlibrary::xoutbase< charT, char_traits< charT > >.

◆ SelectXCell()

template<class charT , class traits = char_traits< charT >>
Superclass & xoutlibrary::xoutrow< charT, traits >::SelectXCell ( const char *  name)
overrideprotectedvirtual

Returns a target cell. Extension: if input = "WriteHeaders" it calls this->WriteHeaders() and returns 'this'.

Reimplemented from xoutlibrary::xoutbase< charT, char_traits< charT > >.

◆ SetOutputs() [1/2]

template<class charT , class traits = char_traits< charT >>
void xoutlibrary::xoutrow< charT, traits >::SetOutputs ( const CStreamMapType outputmap)
overridevirtual

◆ SetOutputs() [2/2]

template<class charT , class traits = char_traits< charT >>
void xoutlibrary::xoutrow< charT, traits >::SetOutputs ( const XStreamMapType outputmap)
overridevirtual

◆ SetTargetCells()

template<class charT , class traits = char_traits< charT >>
void xoutlibrary::xoutrow< charT, traits >::SetTargetCells ( const XStreamMapType cellmap)
overridevirtual

Method to set all targets at once. The outputs of these targets are not set automatically, so make sure to do it yourself.

Reimplemented from xoutlibrary::xoutbase< charT, char_traits< charT > >.

◆ WriteBufferedData()

template<class charT , class traits = char_traits< charT >>
void xoutlibrary::xoutrow< charT, traits >::WriteBufferedData ( void  )
overridevirtual

Write the buffered cell data in a row to the outputs, separated by tabs.

Reimplemented from xoutlibrary::xoutbase< charT, char_traits< charT > >.

◆ WriteHeaders()

template<class charT , class traits = char_traits< charT >>
virtual void xoutlibrary::xoutrow< charT, traits >::WriteHeaders ( void  )
virtual

Writes the names of the target cells to the outputs; This method can also be executed by selecting the "WriteHeaders" target: xout["WriteHeaders"]

Field Documentation

◆ m_CellMap

template<class charT , class traits = char_traits< charT >>
XStreamMapType xoutlibrary::xoutrow< charT, traits >::m_CellMap
protected

Definition at line 118 of file xoutrow.h.



Generated on 1667476801 for elastix by doxygen 1.9.4 elastix logo