The interface for the XML writer that writes VGM geometry objects to XML: More...

#include <IWriter.h>

Inheritance diagram for XmlVGM::IWriter:

Public Member Functions
virtual	~IWriter ()

virtual void	OpenFile (std::string filePath)=0
	Open output file.

virtual void	OpenDocument ()=0
	Write XML document opening.

virtual void	OpenSection (const std::string &topVolume)=0
	Write the section opening (if present)

virtual void	OpenPositions ()=0
	Write positions definitions opening.

virtual void	OpenRotations ()=0
	Write rotations definitions opening.

virtual void	OpenMaterials ()=0
	Write materials definitions opening.

virtual void	OpenMedia ()=0
	Write media definitions opening.

virtual void	OpenSolids ()=0
	Write solids definitions opening.

virtual void	OpenStructure ()=0
	Write structure definition opening (if present)

virtual void	OpenComposition (const std::string &name, const std::string &materialName)=0
	Write composition definition opening (if present)

virtual void	CloseFile ()=0
	Close output file.

virtual void	CloseDocument ()=0
	Write XML document closing.

virtual void	CloseSection (const std::string &topVolume)=0
	Write the section closing (if present)

virtual void	ClosePositions ()=0
	Write positions definitions closing.

virtual void	CloseRotations ()=0
	Write rotations definitions closing.

virtual void	CloseMaterials ()=0
	Write materials definitions closing.

virtual void	CloseMedia ()=0
	Write media definitions closing.

virtual void	CloseSolids ()=0
	Write materials definitions closing.

virtual void	CloseStructure ()=0
	Write structure definition closing (if present)

virtual void	CloseComposition ()=0
	Write composition definition closing (if present)

virtual void	WriteIsotope (const VGM::IIsotope *isotope)=0
	Write VGM isotope.

virtual void	WriteElement (const VGM::IElement *element)=0
	Write VGM element.

virtual void	WriteMaterial (const VGM::IMaterial *material)=0
	Write VGM material.

virtual void	WriteMedium (const VGM::IMedium *medium)=0
	Write VGM medium.

virtual void	WriteMedium (const VGM::IMaterial *material)=0
	Write medium element from material.

virtual void	WriteSolid (std::string lvName, const VGM::ISolid *solid, std::string mediumName)=0
	Write VGM solid.

virtual void	WritePosition (const std::string &name, const VGM::Transform &position)=0
	Write position (from VGM transformation)

virtual void	WriteRotation (const std::string &name, const VGM::Transform &rotation)=0
	Write rotation (from VGM transformation)

virtual void	WriteScale (const std::string &name)=0
	Write scale (from VGM transformation)

virtual void	WritePlacement (const VGM::IPlacement &placement)=0
	Write VGM placement.

virtual void	WriteEmptyLine ()=0
	Write empty line.

virtual void	IncreaseIndention ()=0
	Increase indention.

virtual void	DecreaseIndention ()=0
	Decrease indention.

virtual double	LengthUnit () const =0
	Return the default length unit.

virtual double	AngleUnit () const =0
	Return the default angle unit.

virtual double	AtomicWeightUnit () const =0
	Return the default atomic weight unit.

virtual double	MassDensityUnit () const =0
	Return the default mass density unit.

virtual void	SetNumWidth (int width)=0
	Set fixed format number width.

virtual void	SetNumPrecision (int precision)=0
	Set fixed format number precision.

virtual double	GetNumWidth () const =0
	Return fixed format number width.

virtual double	GetNumPrecision () const =0
	Return fixed format number precision.

Detailed Description

The interface for the XML writer that writes VGM geometry objects to XML:

Author: I. Hrivnacova, 16.01.2004

Definition at line 42 of file IWriter.h.

Constructor & Destructor Documentation

◆ ~IWriter()

virtual XmlVGM::IWriter::~IWriter ( )

inlinevirtual

Definition at line 45 of file IWriter.h.

Member Function Documentation

◆ OpenFile()

virtual void XmlVGM::IWriter::OpenFile ( std::string filePath )

pure virtual

Open output file.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ OpenDocument()

virtual void XmlVGM::IWriter::OpenDocument ( )

pure virtual

Write XML document opening.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ OpenSection()

virtual void XmlVGM::IWriter::OpenSection ( const std::string & topVolume )

pure virtual

Write the section opening (if present)

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ OpenPositions()

virtual void XmlVGM::IWriter::OpenPositions ( )

pure virtual

Write positions definitions opening.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ OpenRotations()

virtual void XmlVGM::IWriter::OpenRotations ( )

pure virtual

Write rotations definitions opening.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ OpenMaterials()

virtual void XmlVGM::IWriter::OpenMaterials ( )

pure virtual

Write materials definitions opening.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ OpenMedia()

virtual void XmlVGM::IWriter::OpenMedia ( )

pure virtual

Write media definitions opening.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ OpenSolids()

virtual void XmlVGM::IWriter::OpenSolids ( )

pure virtual

Write solids definitions opening.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ OpenStructure()

virtual void XmlVGM::IWriter::OpenStructure ( )

pure virtual

Write structure definition opening (if present)

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ OpenComposition()

virtual void XmlVGM::IWriter::OpenComposition	(	const std::string &	name,
		const std::string &	materialName )

pure virtual

Write composition definition opening (if present)

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ CloseFile()

virtual void XmlVGM::IWriter::CloseFile ( )

pure virtual

Close output file.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ CloseDocument()

virtual void XmlVGM::IWriter::CloseDocument ( )

pure virtual

Write XML document closing.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ CloseSection()

virtual void XmlVGM::IWriter::CloseSection ( const std::string & topVolume )

pure virtual

Write the section closing (if present)

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ ClosePositions()

virtual void XmlVGM::IWriter::ClosePositions ( )

pure virtual

Write positions definitions closing.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ CloseRotations()

virtual void XmlVGM::IWriter::CloseRotations ( )

pure virtual

Write rotations definitions closing.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ CloseMaterials()

virtual void XmlVGM::IWriter::CloseMaterials ( )

pure virtual

Write materials definitions closing.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ CloseMedia()

virtual void XmlVGM::IWriter::CloseMedia ( )

pure virtual

Write media definitions closing.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ CloseSolids()

virtual void XmlVGM::IWriter::CloseSolids ( )

pure virtual

Write materials definitions closing.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ CloseStructure()

virtual void XmlVGM::IWriter::CloseStructure ( )

pure virtual

Write structure definition closing (if present)

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ CloseComposition()

virtual void XmlVGM::IWriter::CloseComposition ( )

pure virtual

Write composition definition closing (if present)

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WriteIsotope()

virtual void XmlVGM::IWriter::WriteIsotope ( const VGM::IIsotope * isotope )

pure virtual

Write VGM isotope.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WriteElement()

virtual void XmlVGM::IWriter::WriteElement ( const VGM::IElement * element )

pure virtual

Write VGM element.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WriteMaterial()

virtual void XmlVGM::IWriter::WriteMaterial ( const VGM::IMaterial * material )

pure virtual

Write VGM material.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WriteMedium() [1/2]

virtual void XmlVGM::IWriter::WriteMedium ( const VGM::IMedium * medium )

pure virtual

Write VGM medium.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WriteMedium() [2/2]

virtual void XmlVGM::IWriter::WriteMedium ( const VGM::IMaterial * material )

pure virtual

Write medium element from material.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WriteSolid()

virtual void XmlVGM::IWriter::WriteSolid	(	std::string	lvName,
		const VGM::ISolid *	solid,
		std::string	mediumName )

pure virtual

Write VGM solid.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WritePosition()

virtual void XmlVGM::IWriter::WritePosition	(	const std::string &	name,
		const VGM::Transform &	position )

pure virtual

Write position (from VGM transformation)

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WriteRotation()

virtual void XmlVGM::IWriter::WriteRotation	(	const std::string &	name,
		const VGM::Transform &	rotation )

pure virtual

Write rotation (from VGM transformation)

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WriteScale()

virtual void XmlVGM::IWriter::WriteScale ( const std::string & name )

pure virtual

Write scale (from VGM transformation)

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WritePlacement()

virtual void XmlVGM::IWriter::WritePlacement ( const VGM::IPlacement & placement )

pure virtual

Write VGM placement.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ WriteEmptyLine()

virtual void XmlVGM::IWriter::WriteEmptyLine ( )

pure virtual

Write empty line.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ IncreaseIndention()

virtual void XmlVGM::IWriter::IncreaseIndention ( )

pure virtual

Increase indention.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ DecreaseIndention()

virtual void XmlVGM::IWriter::DecreaseIndention ( )

pure virtual

Decrease indention.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ LengthUnit()

virtual double XmlVGM::IWriter::LengthUnit ( ) const

pure virtual

Return the default length unit.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ AngleUnit()

virtual double XmlVGM::IWriter::AngleUnit ( ) const

pure virtual

Return the default angle unit.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ AtomicWeightUnit()

virtual double XmlVGM::IWriter::AtomicWeightUnit ( ) const

pure virtual

Return the default atomic weight unit.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ MassDensityUnit()

virtual double XmlVGM::IWriter::MassDensityUnit ( ) const

pure virtual

Return the default mass density unit.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ SetNumWidth()

virtual void XmlVGM::IWriter::SetNumWidth ( int width )

pure virtual

Set fixed format number width.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ SetNumPrecision()

virtual void XmlVGM::IWriter::SetNumPrecision ( int precision )

pure virtual

Set fixed format number precision.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ GetNumWidth()

virtual double XmlVGM::IWriter::GetNumWidth ( ) const

pure virtual

Return fixed format number width.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

◆ GetNumPrecision()

virtual double XmlVGM::IWriter::GetNumPrecision ( ) const

pure virtual

Return fixed format number precision.

Implemented in XmlVGM::AGDDWriter, and XmlVGM::GDMLWriter.

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

packages/XmlVGM/include/XmlVGM/IWriter.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IWriter()

Member Function Documentation

◆ OpenFile()

◆ OpenDocument()

◆ OpenSection()

◆ OpenPositions()

◆ OpenRotations()

◆ OpenMaterials()

◆ OpenMedia()

◆ OpenSolids()

◆ OpenStructure()

◆ OpenComposition()

◆ CloseFile()

◆ CloseDocument()

◆ CloseSection()

◆ ClosePositions()

◆ CloseRotations()

◆ CloseMaterials()

◆ CloseMedia()

◆ CloseSolids()

◆ CloseStructure()

◆ CloseComposition()

◆ WriteIsotope()

◆ WriteElement()

◆ WriteMaterial()

◆ WriteMedium() [1/2]

◆ WriteMedium() [2/2]

◆ WriteSolid()

◆ WritePosition()

◆ WriteRotation()

◆ WriteScale()

◆ WritePlacement()

◆ WriteEmptyLine()

◆ IncreaseIndention()

◆ DecreaseIndention()

◆ LengthUnit()

◆ AngleUnit()

◆ AtomicWeightUnit()

◆ MassDensityUnit()

◆ SetNumWidth()

◆ SetNumPrecision()

◆ GetNumWidth()

◆ GetNumPrecision()