Flip Reference

 

EnumDescription Template Class Reference

Namespace

ohm::flip

Declared in

ohm/flip/EnumDescription.h

Companion Guide

Flip Programming Guide: Writing a Flip Class Part 1

See also

ohm::flip::EnumDescManager

Overview

The EnumDescription template class implements a class that holds one Flip enum declaration. The following sections will only document the public API.

Partial Class Diagram

Methods Overview

Manipulating

Methods

set_name

Declares the name of this Flip enum.

void           set_name (const char * name_0);

WARNING:name_0 must be a static character string, usually a string literal.

push_enum_desc

Declares a enum element of a this and set a name to it for the back-end document writer.

void           push_enum_desc (T val, const char * val_name_0);

WARNING:var_name_0 must be a static character string, usually a string literal.