hops::MHO_VexDefinitions Class Reference

Class MHO_VexDefinitions. More...

#include <MHO_VexDefinitions.hh>

Public Member Functions
	MHO_VexDefinitions ()
virtual	~MHO_VexDefinitions ()
std::vector< std::string >	GetBlockNames () const
	Getter for block names. More...
std::string	GetFormatDirectory () const
	Getter for format directory. More...
void	SetVexVersion (std::string version)
	Setter for vex version. More...

Static Public Member Functions
static std::string	AssignmentDelim ()
	Returns a string '=;' as the assignment delimiter. More...
static std::string	AssignmentOp ()
	Returns a string literal '='. More...
static std::string	BlockStartFlag ()
	Returns a static string representing the start block flag. More...
static std::string	CommentFlag ()
	Returns a string containing an asterisk (*). This is a static function. More...
static std::string	DetermineFileVersion (std::string filename)
	Determines and returns the version of a VEX file given its filename. More...
static vex_element_type	DetermineType (std::string etype)
static std::string	ElementDelim ()
	Returns a static string ':' as an element delimiter. More...
static std::string	EndLiteralFlag ()
	Returns a static string 'end_literal'. More...
static bool	IsOptionalField (std::string &field_name)
static std::string	OptionalFlag ()
static std::string	OVexRevisionFlag ()
	Returns a string containing the OVEX revision flag. More...
static std::string	RefTag ()
	Returns a static string 'ref'. More...
static std::string	StartLiteralFlag ()
	Returns a static string 'start_literal'. More...
static std::string	StartTagDelim ()
	Returns a string containing whitespace characters. More...
static std::string	StatementEndFlag ()
	Returns a string representing the statement end flag. More...
static std::string	StatementLineEnd ()
static std::string	VexRevisionFlag ()
	Returns a static string 'VEX_rev' for revision flag. More...
static std::string	WhitespaceDelim ()

Detailed Description

Class MHO_VexDefinitions.

Constructor & Destructor Documentation

MHO_VexDefinitions()

MHO_VexDefinitions::MHO_VexDefinitions

(

)

~MHO_VexDefinitions()

MHO_VexDefinitions::~MHO_VexDefinitions ( )

virtual

Member Function Documentation

AssignmentDelim()

static std::string hops::MHO_VexDefinitions::AssignmentDelim ( )

inlinestatic

Returns a string '=;' as the assignment delimiter.

Returns

A std::string containing '=;'.

Note

This is a static function.

AssignmentOp()

static std::string hops::MHO_VexDefinitions::AssignmentOp ( )

inlinestatic

Returns a string literal '='.

Returns

A std::string containing the assignment operator ('=').

Note

This is a static function.

BlockStartFlag()

static std::string hops::MHO_VexDefinitions::BlockStartFlag ( )

inlinestatic

Returns a static string representing the start block flag.

Returns

A std::string containing the character '$'.

Note

This is a static function.

CommentFlag()

static std::string hops::MHO_VexDefinitions::CommentFlag ( )

inlinestatic

Returns a string containing an asterisk (*). This is a static function.

Returns

A string containing an asterisk (*)

Note

This is a static function.

DetermineFileVersion()

std::string MHO_VexDefinitions::DetermineFileVersion ( std::string  filename )

static

Determines and returns the version of a VEX file given its filename.

Parameters

filename

The path to the VEX file.

Returns

A string representing the file's version (e.g., '1.5', '2.0', or 'ovex'), or 'unknown' if not determined.

Note

This is a static function.

DetermineType()

vex_element_type MHO_VexDefinitions::DetermineType ( std::string  etype )

static

ElementDelim()

static std::string hops::MHO_VexDefinitions::ElementDelim ( )

inlinestatic

Returns a static string ':' as an element delimiter.

Returns

A std::string containing ':'

Note

This is a static function.

EndLiteralFlag()

static std::string hops::MHO_VexDefinitions::EndLiteralFlag ( )

inlinestatic

Returns a static string 'end_literal'.

Returns

std::string containing 'end_literal'

Note

This is a static function.

GetBlockNames()

std::vector< std::string > hops::MHO_VexDefinitions::GetBlockNames ( ) const

inline

Getter for block names.

Returns

std::vector<std::string containing block names.

GetFormatDirectory()

std::string MHO_VexDefinitions::GetFormatDirectory

(

)

const

Getter for format directory.

Returns

std::string - The format directory path.

IsOptionalField()

bool MHO_VexDefinitions::IsOptionalField ( std::string &  field_name )

static

OptionalFlag()

static std::string hops::MHO_VexDefinitions::OptionalFlag ( )

inlinestatic

OVexRevisionFlag()

static std::string hops::MHO_VexDefinitions::OVexRevisionFlag ( )

inlinestatic

Returns a string containing the OVEX revision flag.

Returns

A std::string containing '$OVEX_REV'.

Note

This is a static function.

RefTag()

static std::string hops::MHO_VexDefinitions::RefTag ( )

inlinestatic

Returns a static string 'ref'.

Returns

std::string containing 'ref'

Note

This is a static function.

SetVexVersion()

void MHO_VexDefinitions::SetVexVersion

(

std::string

version

)

Setter for vex version.

Parameters

version

New vex version as string

StartLiteralFlag()

static std::string hops::MHO_VexDefinitions::StartLiteralFlag ( )

inlinestatic

Returns a static string 'start_literal'.

Returns

A std::string containing 'start_literal'

Note

This is a static function.

StartTagDelim()

static std::string hops::MHO_VexDefinitions::StartTagDelim ( )

inlinestatic

Returns a string containing whitespace characters.

Returns

A std::string containing whitespace

Note

This is a static function.

StatementEndFlag()

static std::string hops::MHO_VexDefinitions::StatementEndFlag ( )

inlinestatic

Returns a string representing the statement end flag.

Returns

A std::string containing ';'.

Note

This is a static function.

StatementLineEnd()

static std::string hops::MHO_VexDefinitions::StatementLineEnd ( )

inlinestatic

       @brief Returns a string representing the end of a statement line.

       @return A std::string containing ';

'.

Note

This is a static function.

VexRevisionFlag()

static std::string hops::MHO_VexDefinitions::VexRevisionFlag ( )

inlinestatic

Returns a static string 'VEX_rev' for revision flag.

Returns

std::string containing 'VEX_rev'

Note

This is a static function.

WhitespaceDelim()

static std::string hops::MHO_VexDefinitions::WhitespaceDelim ( )

inlinestatic

       @brief Returns a string containing whitespace characters.

       @return A std::string containing space (' '), tab (\t), carriage return (\r

), and newline (
) characters.

Note

This is a static function.

---

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

• MHO_VexDefinitions.hh
• MHO_VexDefinitions.cc