HOPS
HOPS class reference
Public Member Functions | List of all members
hops::MHO_SerializableObjectFactorySpecific< XClassType > Class Template Reference

Class MHO_SerializableObjectFactorySpecific. More...

#include <MHO_SerializableObjectFactory.hh>

Inheritance diagram for hops::MHO_SerializableObjectFactorySpecific< XClassType >:
[legend]

Public Member Functions

 MHO_SerializableObjectFactorySpecific ()
 
virtual ~MHO_SerializableObjectFactorySpecific ()
 
virtual MHO_SerializableBuild ()
 Virtual function to build and return an instance of an MHO_Serializable which points to the underlying XClassType object. More...
 
virtual MHO_SerializableBuildFromFileInterface (MHO_BinaryFileInterface &inter)
 Builds an MHO_Serializable object from a file interface, which points to the underlying XClassType object. More...
 
virtual bool WriteToFileInterface (MHO_BinaryFileInterface &inter, const MHO_Serializable *object, const std::string &shortname="")
 Writes an object to a binary file interface using its short name, with full knowledge of the underlying XClassType. More...
 
- Public Member Functions inherited from hops::MHO_SerializableObjectFactory
 MHO_SerializableObjectFactory ()
 
virtual ~MHO_SerializableObjectFactory ()
 

Detailed Description

template<typename XClassType>
class hops::MHO_SerializableObjectFactorySpecific< XClassType >

Class MHO_SerializableObjectFactorySpecific.

Constructor & Destructor Documentation

◆ MHO_SerializableObjectFactorySpecific()

template<typename XClassType >
hops::MHO_SerializableObjectFactorySpecific< XClassType >::MHO_SerializableObjectFactorySpecific ( )
inline

◆ ~MHO_SerializableObjectFactorySpecific()

template<typename XClassType >
virtual hops::MHO_SerializableObjectFactorySpecific< XClassType >::~MHO_SerializableObjectFactorySpecific ( )
inlinevirtual

Member Function Documentation

◆ Build()

template<typename XClassType >
virtual MHO_Serializable* hops::MHO_SerializableObjectFactorySpecific< XClassType >::Build ( )
inlinevirtual

Virtual function to build and return an instance of an MHO_Serializable which points to the underlying XClassType object.

Returns
Pointer to MHO_Serializable object.
Note
This is a virtual function.

Reimplemented from hops::MHO_SerializableObjectFactory.

◆ BuildFromFileInterface()

template<typename XClassType >
virtual MHO_Serializable* hops::MHO_SerializableObjectFactorySpecific< XClassType >::BuildFromFileInterface ( MHO_BinaryFileInterface inter)
inlinevirtual

Builds an MHO_Serializable object from a file interface, which points to the underlying XClassType object.

Parameters
interReference to an MHO_BinaryFileInterface object.
Returns
Pointer to an MHO_Serializable object or nullptr if failed.
Note
This is a virtual function.

Reimplemented from hops::MHO_SerializableObjectFactory.

◆ WriteToFileInterface()

template<typename XClassType >
virtual bool hops::MHO_SerializableObjectFactorySpecific< XClassType >::WriteToFileInterface ( MHO_BinaryFileInterface inter,
const MHO_Serializable object,
const std::string &  shortname = "" 
)
inlinevirtual

Writes an object to a binary file interface using its short name, with full knowledge of the underlying XClassType.

Parameters
interReference to MHO_BinaryFileInterface for writing operations
objectPointer to const MHO_Serializable object to be written
shortnameShort name associated with the object
Returns
Boolean indicating success of write operation
Note
This is a virtual function.

Reimplemented from hops::MHO_SerializableObjectFactory.


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