Writes an InfluenceDiagram in the GUM json format. More...

#include <agrum/ID/io/GUM/GumIDWriter.h>

Inheritance diagram for gum::GumIDWriter< GUM_SCALAR >:

Collaboration diagram for gum::GumIDWriter< GUM_SCALAR >:

Public Member Functions
std::string	toString (const InfluenceDiagram< GUM_SCALAR > &id)
	Serializes an InfluenceDiagram to a string in GUM json format.
void	write (std::ostream &output, const InfluenceDiagram< GUM_SCALAR > &id) override
	Writes an InfluenceDiagram to the output stream.
void	write (std::string_view filePath, InfluenceDiagram< GUM_SCALAR > &id) override
	Writes an InfluenceDiagram to the file at filePath, updating metadata first.
void	write (std::string_view filePath, const InfluenceDiagram< GUM_SCALAR > &id) override
	Writes an InfluenceDiagram to the file at filePath (const variant, no metadata update).
Constructor & destructor
	GumIDWriter (bool binary=false, int indent=-1)
	Default constructor.
	~GumIDWriter () override
	Default constructor.
	GumIDWriter (const GumIDWriter &)=delete
	Default constructor.
	GumIDWriter (GumIDWriter &&) noexcept=delete
	Default constructor.
GumIDWriter &	operator= (const GumIDWriter &)=delete
	Default constructor.
GumIDWriter &	operator= (GumIDWriter &&) noexcept=delete
	Default constructor.

Private Attributes
bool	_binary_
int	_indent_

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::GumIDWriter< GUM_SCALAR >

Writes an InfluenceDiagram in the GUM json format.

Supports both text (.jgum) and binary msgpack (.bgum) output.

Definition at line 72 of file GumIDWriter.h.

Constructor & Destructor Documentation

◆ GumIDWriter() [1/3]

template<GUM_Numeric GUM_SCALAR>

gum::GumIDWriter< GUM_SCALAR >::GumIDWriter	(	bool	binary = false,
		int	indent = -1 )

Default constructor.

Parameters

binary	If true, output uses the msgpack binary format; otherwise JSON text.
indent	Indentation level for text output. -1 produces compact output.

Referenced by GumIDWriter(), GumIDWriter(), operator=(), and operator=().

Here is the caller graph for this function:

◆ ~GumIDWriter()

template<GUM_Numeric GUM_SCALAR>

gum::GumIDWriter< GUM_SCALAR >::~GumIDWriter ( )

override

Default constructor.

Parameters

binary	If true, output uses the msgpack binary format; otherwise JSON text.
indent	Indentation level for text output. -1 produces compact output.

◆ GumIDWriter() [2/3]

template<GUM_Numeric GUM_SCALAR>

gum::GumIDWriter< GUM_SCALAR >::GumIDWriter ( const GumIDWriter< GUM_SCALAR > & )

delete

Default constructor.

Parameters

binary	If true, output uses the msgpack binary format; otherwise JSON text.
indent	Indentation level for text output. -1 produces compact output.

References GumIDWriter().

Here is the call graph for this function:

◆ GumIDWriter() [3/3]

template<GUM_Numeric GUM_SCALAR>

gum::GumIDWriter< GUM_SCALAR >::GumIDWriter ( GumIDWriter< GUM_SCALAR > && )

deletenoexcept

Default constructor.

Parameters

binary	If true, output uses the msgpack binary format; otherwise JSON text.
indent	Indentation level for text output. -1 produces compact output.

References GumIDWriter().

Here is the call graph for this function:

Member Function Documentation

◆ operator=() [1/2]

template<GUM_Numeric GUM_SCALAR>

GumIDWriter & gum::GumIDWriter< GUM_SCALAR >::operator= ( const GumIDWriter< GUM_SCALAR > & )

delete

Default constructor.

Parameters

binary	If true, output uses the msgpack binary format; otherwise JSON text.
indent	Indentation level for text output. -1 produces compact output.

References GumIDWriter().

Here is the call graph for this function:

◆ operator=() [2/2]

template<GUM_Numeric GUM_SCALAR>

GumIDWriter & gum::GumIDWriter< GUM_SCALAR >::operator= ( GumIDWriter< GUM_SCALAR > && )

deletenoexcept

Default constructor.

Parameters

binary	If true, output uses the msgpack binary format; otherwise JSON text.
indent	Indentation level for text output. -1 produces compact output.

References GumIDWriter().

Here is the call graph for this function:

◆ toString()

template<GUM_Numeric GUM_SCALAR>

std::string gum::GumIDWriter< GUM_SCALAR >::toString ( const InfluenceDiagram< GUM_SCALAR > & id )

Serializes an InfluenceDiagram to a string in GUM json format.

References toString().

Referenced by toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [1/3]

template<GUM_Numeric GUM_SCALAR>

void gum::GumIDWriter< GUM_SCALAR >::write	(	std::ostream &	output,
		const InfluenceDiagram< GUM_SCALAR > &	id )

overridevirtual

Writes an InfluenceDiagram to the output stream.

Parameters

output	The output stream.
id	The InfluenceDiagram to write.

Exceptions

IOError if the stream is not writable.

Implements gum::IDWriter< GUM_SCALAR >.

References write().

Referenced by write(), write(), and write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [2/3]

template<GUM_Numeric GUM_SCALAR>

void gum::GumIDWriter< GUM_SCALAR >::write	(	std::string_view	filePath,
		const InfluenceDiagram< GUM_SCALAR > &	id )

overridevirtual

Writes an InfluenceDiagram to the file at filePath (const variant, no metadata update).

Parameters

filePath	Path to the output file (created or overwritten).
id	The InfluenceDiagram to write.

Exceptions

IOError if an I/O error occurs.

Implements gum::IDWriter< GUM_SCALAR >.

References write().

Here is the call graph for this function:

◆ write() [3/3]

template<GUM_Numeric GUM_SCALAR>

void gum::GumIDWriter< GUM_SCALAR >::write	(	std::string_view	filePath,
		InfluenceDiagram< GUM_SCALAR > &	id )

overridevirtual

Writes an InfluenceDiagram to the file at filePath, updating metadata first.

Parameters

filePath	Path to the output file (created or overwritten).
id	The InfluenceDiagram to write (non-const to allow metadata update).

Exceptions

IOError if an I/O error occurs.

Reimplemented from gum::IDWriter< GUM_SCALAR >.

References write().

Here is the call graph for this function:

Member Data Documentation

◆ _binary_

template<GUM_Numeric GUM_SCALAR>

bool gum::GumIDWriter< GUM_SCALAR >::_binary_

private

Definition at line 129 of file GumIDWriter.h.

◆ _indent_

template<GUM_Numeric GUM_SCALAR>

int gum::GumIDWriter< GUM_SCALAR >::_indent_

private

Definition at line 130 of file GumIDWriter.h.

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

agrum/ID/io/GUM/GumIDWriter.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GumIDWriter() [1/3]

◆ ~GumIDWriter()

◆ GumIDWriter() [2/3]

◆ GumIDWriter() [3/3]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ toString()

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

Member Data Documentation

◆ _binary_

◆ _indent_