hops::MHO_SerializableObjectFactory Class Reference

Class MHO_SerializableObjectFactory. More...

#include <MHO_SerializableObjectFactory.hh>

Inheritance diagram for hops::MHO_SerializableObjectFactory:

Public Member Functions
	MHO_SerializableObjectFactory ()
virtual	~MHO_SerializableObjectFactory ()
virtual MHO_Serializable *	Build ()
	Virtual function to build and return an instance of a MHO_Serializable object. More...
virtual MHO_Serializable *	BuildFromFileInterface (MHO_BinaryFileInterface &)
	Builds an MHO_Serializable object from a given MHO_BinaryFileInterface. More...
virtual bool	WriteToFileInterface (MHO_BinaryFileInterface &, const MHO_Serializable *, const std::string &shortname="")
	Writes an object to a binary file interface using a short name. More...

Detailed Description

Class MHO_SerializableObjectFactory.

Author

J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du

Date

Sun Feb 13 19:54:27 2022 -0500

Constructor & Destructor Documentation

MHO_SerializableObjectFactory()

hops::MHO_SerializableObjectFactory::MHO_SerializableObjectFactory ( )

inline

~MHO_SerializableObjectFactory()

virtual hops::MHO_SerializableObjectFactory::~MHO_SerializableObjectFactory ( )

inlinevirtual

Member Function Documentation

Build()

virtual MHO_Serializable* hops::MHO_SerializableObjectFactory::Build ( )

inlinevirtual

Virtual function to build and return an instance of a MHO_Serializable object.

Returns

Pointer to MHO_Serializable object.

Note

This is a virtual function.

Reimplemented in hops::MHO_SerializableObjectFactorySpecific< XClassType >.

BuildFromFileInterface()

virtual MHO_Serializable* hops::MHO_SerializableObjectFactory::BuildFromFileInterface ( MHO_BinaryFileInterface &  )

inlinevirtual

Builds an MHO_Serializable object from a given MHO_BinaryFileInterface.

Parameters

!inter

Reference to an MHO_BinaryFileInterface object

Returns

Pointer to an MHO_Serializable object, or nullptr if failed

Note

This is a virtual function.

Reimplemented in hops::MHO_SerializableObjectFactorySpecific< XClassType >.

WriteToFileInterface()

virtual bool hops::MHO_SerializableObjectFactory::WriteToFileInterface ( MHO_BinaryFileInterface &  , const MHO_Serializable *  , const std::string &  shortname = ""  )

inlinevirtual

Writes an object to a binary file interface using a short name.

Parameters

!inter	Reference to MHO_BinaryFileInterface for writing operations
!object	Pointer to const MHO_Serializable object to be written
shortname	Short name associated with the object (default is empty string)

Returns

Boolean indicating success of write operation

Note

This is a virtual function.

Reimplemented in hops::MHO_SerializableObjectFactorySpecific< XClassType >.

---

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

• MHO_SerializableObjectFactory.hh