HOPS
HOPS class reference
Public Member Functions | List of all members
hops::MHO_MK4VexInterface Class Reference

MHO_MK4VexInterface convers root (ovex) file to json file for HOPS4 consumption. More...

#include <MHO_MK4VexInterface.hh>

Public Member Functions

 MHO_MK4VexInterface ()
 
virtual ~MHO_MK4VexInterface ()
 
bool ExportVexFileToJSON (mho_json &json_obj)
 Exports Vex file data to a JSON object if available. More...
 
mho_json GetVex ()
 Getter for vex as JSON object. More...
 
void OpenVexFile (std::string file_path)
 Opens a VEX file and parses its contents into an internal JSON representation. More...
 

Detailed Description

MHO_MK4VexInterface convers root (ovex) file to json file for HOPS4 consumption.

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Tue May 19 01:47:28 2020 -0400

Constructor & Destructor Documentation

◆ MHO_MK4VexInterface()

hops::MHO_MK4VexInterface::MHO_MK4VexInterface ( )

◆ ~MHO_MK4VexInterface()

hops::MHO_MK4VexInterface::~MHO_MK4VexInterface ( )
virtual

Member Function Documentation

◆ ExportVexFileToJSON()

bool hops::MHO_MK4VexInterface::ExportVexFileToJSON ( mho_json json_obj)

Exports Vex file data to a JSON object if available.

Parameters
json_objReference to an mho_json object that will receive the exported data.
Returns
True if successful, false if no Vex file data is available.

◆ GetVex()

mho_json hops::MHO_MK4VexInterface::GetVex ( )

Getter for vex as JSON object.

Returns
mho_json containing vex data or an empty json object.

◆ OpenVexFile()

void hops::MHO_MK4VexInterface::OpenVexFile ( std::string  file_path)

Opens a VEX file and parses its contents into an internal JSON representation.

Parameters
file_pathPath to the VEX file to be opened and parsed

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