Annotator Class Reference

#include <Annotator.h>

Collaboration diagram for Annotator:

Public Member Functions
	Annotator ()
string	getColor () const
string	getdirpath () const
string	getIcon () const
string	getmodeltype () const
string	getNotes () const
double	getRuntime () const
string	getSolver () const
string	getTextColor () const
double	getX () const
double	getY () const
double	getZ () const
void	setColor (string v)
void	setdirpath (string v)
void	setIcon (string v)
void	setmodeltype (string v)
void	setNotes (string v)
void	setRuntime (double v)
void	setSolver (string v)
void	setTextColor (string v)
void	setX (double v)
void	setY (double v)
void	setZ (double v)

Static Public Member Functions
static const Cinfo *	initCinfo ()

Private Attributes
string	color_
string	dirpath_
string	icon_
string	modeltype_
string	notes_
double	runtime_
string	solver_
string	textColor_
double	x_
double	y_
double	z_

Detailed Description

Definition at line 12 of file Annotator.h.

Constructor & Destructor Documentation

Annotator::Annotator

(

)

Definition at line 118 of file Annotator.cpp.

    : x_( 0.0 ), y_( 0.0 ), z_( 0.0 ),
        notes_( "" ), color_( "white" ), textColor_( "black" ),
        icon_( "sphere" ),solver_( "ee"),runtime_(100.0),dirpath_(""),modeltype_("")
{
    ;
}

Member Function Documentation

string Annotator::getColor

(

)

const

Definition at line 166 of file Annotator.cpp.

References color_.

Referenced by initCinfo().

{
    return color_;
}

Here is the caller graph for this function:

string Annotator::getdirpath

(

)

const

Definition at line 213 of file Annotator.cpp.

References dirpath_.

Referenced by initCinfo().

{
    return dirpath_;
}

Here is the caller graph for this function:

string Annotator::getIcon

(

)

const

Definition at line 186 of file Annotator.cpp.

References icon_.

Referenced by initCinfo().

{
    return icon_;
}

Here is the caller graph for this function:

string Annotator::getmodeltype

(

)

const

Definition at line 222 of file Annotator.cpp.

References modeltype_.

Referenced by initCinfo().

{
    return modeltype_;
}

Here is the caller graph for this function:

string Annotator::getNotes

(

)

const

Definition at line 156 of file Annotator.cpp.

References notes_.

Referenced by initCinfo().

{
    return notes_;
}

Here is the caller graph for this function:

double Annotator::getRuntime

(

)

const

Definition at line 204 of file Annotator.cpp.

References runtime_.

Referenced by initCinfo().

{
    return runtime_;
}

Here is the caller graph for this function:

string Annotator::getSolver

(

)

const

Definition at line 195 of file Annotator.cpp.

References solver_.

Referenced by initCinfo().

{
    return solver_;
}

Here is the caller graph for this function:

string Annotator::getTextColor

(

)

const

Definition at line 176 of file Annotator.cpp.

References textColor_.

Referenced by initCinfo().

{
    return textColor_;
}

Here is the caller graph for this function:

double Annotator::getX

(

)

const

Definition at line 126 of file Annotator.cpp.

References x_.

Referenced by initCinfo().

{
    return x_;
}

Here is the caller graph for this function:

double Annotator::getY

(

)

const

Definition at line 136 of file Annotator.cpp.

References y_.

Referenced by initCinfo().

{
    return y_;
}

Here is the caller graph for this function:

double Annotator::getZ

(

)

const

Definition at line 146 of file Annotator.cpp.

References z_.

Referenced by initCinfo().

{
    return z_;
}

Here is the caller graph for this function:

const Cinfo * Annotator::initCinfo ( )

static

Definition at line 12 of file Annotator.cpp.

References annotatorCinfo, getColor(), getdirpath(), getIcon(), getmodeltype(), getNotes(), getRuntime(), getSolver(), getTextColor(), getX(), getY(), getZ(), Neutral::initCinfo(), setColor(), setdirpath(), setIcon(), setmodeltype(), setNotes(), setRuntime(), setSolver(), setTextColor(), setX(), setY(), and setZ().

{
        // Field Definitions
        static ValueFinfo< Annotator, double > x(
            "x",
            "x field. Typically display coordinate x",
            &Annotator::setX,
            &Annotator::getX
        );
        static ValueFinfo< Annotator, double > y(
            "y",
            "y field. Typically display coordinate y",
            &Annotator::setY,
            &Annotator::getY
        );
        static ValueFinfo< Annotator, double > z(
            "z",
            "z field. Typically display coordinate z",
            &Annotator::setZ,
            &Annotator::getZ
        );

        static ValueFinfo< Annotator, string > notes(
            "notes",
            "A string to hold some text notes about parent object",
            &Annotator::setNotes,
            &Annotator::getNotes
        );

        static ValueFinfo< Annotator, string > color(
            "color",
            "A string to hold a text string specifying display color."
            "Can be a regular English color name, or an rgb code rrrgggbbb",
            &Annotator::setColor,
            &Annotator::getColor
        );

        static ValueFinfo< Annotator, string > textColor(
            "textColor",
            "A string to hold a text string specifying color for text label"
            "that might be on the display for this object."
            "Can be a regular English color name, or an rgb code rrrgggbbb",
            &Annotator::setTextColor,
            &Annotator::getTextColor
        );

        static ValueFinfo< Annotator, string > icon(
            "icon",
            "A string to specify icon to use for display",
            &Annotator::setIcon,
            &Annotator::getIcon
        );
        static ValueFinfo< Annotator, string > solver(
            "solver",
            "A string to specify solver to store for Gui",
            &Annotator::setSolver,
            &Annotator::getSolver
        );
        static ValueFinfo< Annotator, double > runtime(
            "runtime",
            "runtime field. Store runtime ",
            &Annotator::setRuntime,
            &Annotator::getRuntime
        );
        static ValueFinfo< Annotator, string > dirpath(
            "dirpath",
            "directory path for Gui",
            &Annotator::setdirpath,
            &Annotator::getdirpath
        );
        static ValueFinfo< Annotator, string > modeltype(
            "modeltype",
            "model type ",
            &Annotator::setmodeltype,
            &Annotator::getmodeltype
        );
    static Finfo* annotatorFinfos[] = {
        &x, // Value
        &y, // Value
        &z, // Value
        &notes, // Value
        &color, // Value
        &textColor, // Value
        &icon,  // Value
        &solver,
        &runtime,
        &dirpath,
        &modeltype,
    };

    static Dinfo< Annotator > dinfo;
    static Cinfo annotatorCinfo (
        "Annotator",
        Neutral::initCinfo(),
        annotatorFinfos,
        sizeof( annotatorFinfos ) / sizeof ( Finfo* ),
        &dinfo
    );

    return &annotatorCinfo;
}

Here is the call graph for this function:

void Annotator::setColor

(

string

v

)

Definition at line 171 of file Annotator.cpp.

References color_.

Referenced by initCinfo().

{
    color_ = v;
}

Here is the caller graph for this function:

void Annotator::setdirpath

(

string

v

)

Definition at line 218 of file Annotator.cpp.

References dirpath_.

Referenced by initCinfo().

{
    dirpath_ = v;
}

Here is the caller graph for this function:

void Annotator::setIcon

(

string

v

)

Definition at line 191 of file Annotator.cpp.

References icon_.

Referenced by initCinfo().

{
    icon_ = v;
}

Here is the caller graph for this function:

void Annotator::setmodeltype

(

string

v

)

Definition at line 227 of file Annotator.cpp.

References modeltype_.

Referenced by initCinfo().

{
    modeltype_ = v;
}

Here is the caller graph for this function:

void Annotator::setNotes

(

string

v

)

Definition at line 161 of file Annotator.cpp.

References notes_.

Referenced by initCinfo().

{
    notes_ = v;
}

Here is the caller graph for this function:

void Annotator::setRuntime

(

double

v

)

Definition at line 209 of file Annotator.cpp.

References runtime_.

Referenced by initCinfo().

{
    runtime_ = v;
}

Here is the caller graph for this function:

void Annotator::setSolver

(

string

v

)

Definition at line 200 of file Annotator.cpp.

References solver_.

Referenced by initCinfo().

{
    solver_ = v;
}

Here is the caller graph for this function:

void Annotator::setTextColor

(

string

v

)

Definition at line 181 of file Annotator.cpp.

References textColor_.

Referenced by initCinfo().

{
    textColor_ = v;
}

Here is the caller graph for this function:

void Annotator::setX

(

double

v

)

Definition at line 131 of file Annotator.cpp.

References x_.

Referenced by initCinfo().

{
    x_ = v;
}

Here is the caller graph for this function:

void Annotator::setY

(

double

v

)

Definition at line 141 of file Annotator.cpp.

References y_.

Referenced by initCinfo().

{
    y_ = v;
}

Here is the caller graph for this function:

void Annotator::setZ

(

double

v

)

Definition at line 151 of file Annotator.cpp.

References z_.

Referenced by initCinfo().

{
    z_ = v;
}

Here is the caller graph for this function:

Member Data Documentation

string Annotator::color_

private

Definition at line 49 of file Annotator.h.

Referenced by getColor(), and setColor().

string Annotator::dirpath_

private

Definition at line 54 of file Annotator.h.

Referenced by getdirpath(), and setdirpath().

string Annotator::icon_

private

Definition at line 51 of file Annotator.h.

Referenced by getIcon(), and setIcon().

string Annotator::modeltype_

private

Definition at line 55 of file Annotator.h.

Referenced by getmodeltype(), and setmodeltype().

string Annotator::notes_

private

Definition at line 48 of file Annotator.h.

Referenced by getNotes(), and setNotes().

double Annotator::runtime_

private

Definition at line 53 of file Annotator.h.

Referenced by getRuntime(), and setRuntime().

string Annotator::solver_

private

Definition at line 52 of file Annotator.h.

Referenced by getSolver(), and setSolver().

string Annotator::textColor_

private

Definition at line 50 of file Annotator.h.

Referenced by getTextColor(), and setTextColor().

double Annotator::x_

private

Definition at line 45 of file Annotator.h.

Referenced by getX(), and setX().

double Annotator::y_

private

Definition at line 46 of file Annotator.h.

Referenced by getY(), and setY().

double Annotator::z_

private

Definition at line 47 of file Annotator.h.

Referenced by getZ(), and setZ().

---

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

• moose-core/utility/Annotator.h
• moose-core/utility/Annotator.cpp