InfoOut Class Reference

Base class for all InfoOut<xyz> classes. More...

#include <infoout.h>

Inheritance diagram for InfoOut:

Collaboration diagram for InfoOut:

Public Member Functions
	InfoOut ()
virtual MBool	setRootOnly (MBool rootOnly=true)=0
MInt	addAttribute (std::pair< MString, MString >)
	Adds an attribute to the prefix of the XML string. More...
void	eraseAttribute (MInt)
	Erases an attribute from the prefix of the XML string. More...
void	modifyAttribute (MInt, std::pair< MString, MString >)
	Modifies an attribute of the prefix of the XML string. More...

Protected Attributes
InfoOut_buffer *	m_buffer = nullptr

Friends
class	InfoOut_buffer

Detailed Description

Author

Michael Schlottke

Date

June 2012

This class is used to hold stream/buffer-independent methods. All InfoOut<xyz> subclasses inherit from this class. The auxiliary classes InfoOut_<xyz> (especially the buffers), however, should NOT have this class as their parent.

Definition at line 78 of file infoout.h.

Constructor & Destructor Documentation

InfoOut()

InfoOut::InfoOut ( )

inline

Definition at line 90 of file infoout.h.

: std::ostream(m_buffer){};

Member Function Documentation

addAttribute()

MInt InfoOut::addAttribute

(

std::pair< MString, MString >

)

Author

Andreas Lintermann

Date

13.08.2012

Parameters

[in]

att

The attribute to add, consists of a pair of MStrings.

Returns

The location of the attribute in the vector of pairs.

Definition at line 38 of file infoout.cpp.

                                                     {
  m_buffer->m_prefixAttributes.push_back(att);
  m_buffer->createPrefixMessage();
  return m_buffer->m_prefixAttributes.size() - 1;
}

eraseAttribute()

void InfoOut::eraseAttribute

(

MInt

attId

)

Author

Andreas Lintermann

Date

13.08.2012

Parameters

[in]

attId

The ID of the attribute to delete.

Definition at line 50 of file infoout.cpp.

                                       {
  m_buffer->m_prefixAttributes.erase(m_buffer->m_prefixAttributes.begin() + attId);
  m_buffer->createPrefixMessage();
}

modifyAttribute()

void InfoOut::modifyAttribute	(	MInt	,
		std::pair< MString, MString >
	)

Author

Andreas Lintermann

Date

13.08.2012

Parameters

[in]	attId	The ID of the attribute to modify.
[in]	att	The new attribute to replace the old one, given by a pair of MStrings.

Definition at line 62 of file infoout.cpp.

                                                                    {
  m_buffer->m_prefixAttributes[attId] = att;
  m_buffer->createPrefixMessage();
}

setRootOnly()

virtual MBool InfoOut::setRootOnly ( MBool  rootOnly = true )

pure virtual

Implemented in InfoOutFile, and InfoOutStream.

Friends And Related Function Documentation

InfoOut_buffer

friend class InfoOut_buffer

friend

Definition at line 79 of file infoout.h.

Member Data Documentation

m_buffer

InfoOut_buffer* InfoOut::m_buffer = nullptr

protected

Definition at line 82 of file infoout.h.

---

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

• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/IO/infoout.h
• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/IO/infoout.cpp