OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | Friends | List of all members
openjaus::model::fields::EnumerationLiteral Class Reference

This is a brief description. More...

#include <EnumerationLiteral.h>

Inherits openjaus::model::fields::EnumerationItem.

Public Member Functions

 EnumerationLiteral ()
 
virtual ~EnumerationLiteral ()
 
long getIndex () const
 Accessor to get the value of index. More...
 
bool setIndex (long index)
 Accessor to set value of index. More...
 
virtual std::string toString () const
 
- Public Member Functions inherited from openjaus::model::fields::EnumerationItem
 EnumerationItem ()
 
virtual ~EnumerationItem ()
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 

Protected Attributes

long index
 
- Protected Attributes inherited from openjaus::model::fields::EnumerationItem
std::string name
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const EnumerationLiteral &object)
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const EnumerationLiteral *object)
 

Detailed Description

Detailed description.

Author
Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

§ EnumerationLiteral()

openjaus::model::fields::EnumerationLiteral::EnumerationLiteral ( )

§ ~EnumerationLiteral()

openjaus::model::fields::EnumerationLiteral::~EnumerationLiteral ( )
virtual

Member Function Documentation

§ getIndex()

long openjaus::model::fields::EnumerationLiteral::getIndex ( ) const

§ setIndex()

bool openjaus::model::fields::EnumerationLiteral::setIndex ( long  index)
Parameters
indexThe value of the new index.

§ toString()

std::string openjaus::model::fields::EnumerationLiteral::toString ( ) const
virtual

Friends And Related Function Documentation

§ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const EnumerationLiteral object 
)
friend

§ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const EnumerationLiteral object 
)
friend

Member Data Documentation

§ index

long openjaus::model::fields::EnumerationLiteral::index
protected

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