gstlrn::ASerializable Class Reference

#include <ASerializable.hpp>

Inheritance diagram for gstlrn::ASerializable:

Public Member Functions
	ASerializable ()
	ASerializable (const ASerializable &r)
ASerializable &	operator= (const ASerializable &r)
	ASerializable (ASerializable &&r) noexcept
ASerializable &	operator= (ASerializable &&r) noexcept
virtual	~ASerializable ()
bool	dumpToNF (const String &NFFilename, const EFormatNF &format=EFormatNF::fromKey("DEFAULT"), bool verbose=false) const
	Dump the contents of an object into an Output File using a given Output NF Format.
void	setDefaultFormatNF (const EFormatNF &format)
virtual String	_getNFName () const =0

Static Public Member Functions
static String	buildFileName (Id status, const String &filename, bool ensureDirExist=false)
static String	getFileIdentity (const String &filename, bool verbose=false)
static void	setPrefixName (const String &prefixName)
static void	unsetPrefixName ()
static const String &	getPrefixName ()

Constructor & Destructor Documentation

ASerializable() [1/3]

gstlrn::ASerializable::ASerializable ( )

default

ASerializable() [2/3]

gstlrn::ASerializable::ASerializable ( const ASerializable &  r )

default

ASerializable() [3/3]

gstlrn::ASerializable::ASerializable ( ASerializable &&  r )

defaultnoexcept

~ASerializable()

gstlrn::ASerializable::~ASerializable ( )

virtualdefault

Member Function Documentation

_getNFName()

virtual String gstlrn::ASerializable::_getNFName ( ) const

pure virtual

buildFileName()

String gstlrn::ASerializable::buildFileName ( Id  status, const String &  filename, bool  ensureDirExist = false  )

static

Build a standard filename for Read or Write operation

Parameters

status	1 for Read and 2 for Write
filename	Name of the filename (see remark)
ensureDirExist	When TRUE, the Directory is created if not already existing

Returns

dumpToNF()

bool gstlrn::ASerializable::dumpToNF	(	const String &	NFFilename,
		const EFormatNF &	format = EFormatNF::fromKey("DEFAULT"),
		bool	verbose = false
	)		const

Dump the contents of an object into an Output File using a given Output NF Format.

Parameters

NFFilename	Name of the Output File
format	Choice of the format (see remarks)
verbose	Verbose flag

Returns

true or false

Remarks

In the argument 'format', the user can select the format for encoding the contents of the output file. If the value DEFAULT is used, the package uses the Format currently defined as the defaulted one. This default value can be updated using the method ASerializable::DefaultFormatNF()

getFileIdentity()

String gstlrn::ASerializable::getFileIdentity ( const String &  filename, bool  verbose = false  )

static

Returns the Identity of a Neutral File which allows knowing its type

Parameters

filename	Name of the Neutral File
verbose	Verbose flag

Returns

getPrefixName()

const String & gstlrn::ASerializable::getPrefixName ( )

static

operator=() [1/2]

ASerializable & gstlrn::ASerializable::operator= ( ASerializable &&  r )

defaultnoexcept

operator=() [2/2]

ASerializable & gstlrn::ASerializable::operator= ( const ASerializable &  r )

default

setDefaultFormatNF()

void gstlrn::ASerializable::setDefaultFormatNF

(

const EFormatNF &

format

)

setPrefixName()

void gstlrn::ASerializable::setPrefixName ( const String &  prefixName )

static

unsetPrefixName()

void gstlrn::ASerializable::unsetPrefixName ( void  )

static

---

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

• include/Basic/ASerializable.hpp
• src/Basic/ASerializable.cpp