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

This is a brief description. More...

#include <BitFieldItem.h>

Inherited by openjaus::model::fields::BitFieldEnumeration, and openjaus::model::fields::BitFieldRange.

Public Member Functions

 BitFieldItem ()
 
virtual ~BitFieldItem ()
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 
std::string getInterpretation () const
 Accessor to get the value of interpretation. More...
 
bool setInterpretation (std::string interpretation)
 Accessor to set value of interpretation. More...
 
long getStartIndex () const
 Accessor to get the value of startIndex. More...
 
bool setStartIndex (long startIndex)
 Accessor to set value of startIndex. More...
 
long getEndIndex () const
 Accessor to get the value of endIndex. More...
 
bool setEndIndex (long endIndex)
 Accessor to set value of endIndex. More...
 
virtual std::string toString () const
 

Protected Attributes

std::string name
 
std::string interpretation
 
long startIndex
 
long endIndex
 

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

§ BitFieldItem()

openjaus::model::fields::BitFieldItem::BitFieldItem ( )

§ ~BitFieldItem()

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

Member Function Documentation

§ getEndIndex()

long openjaus::model::fields::BitFieldItem::getEndIndex ( ) const

§ getInterpretation()

std::string openjaus::model::fields::BitFieldItem::getInterpretation ( ) const

§ getName()

std::string openjaus::model::fields::BitFieldItem::getName ( void  ) const

§ getStartIndex()

long openjaus::model::fields::BitFieldItem::getStartIndex ( ) const

§ setEndIndex()

bool openjaus::model::fields::BitFieldItem::setEndIndex ( long  endIndex)
Parameters
endIndexThe value of the new endIndex.

§ setInterpretation()

bool openjaus::model::fields::BitFieldItem::setInterpretation ( std::string  interpretation)
Parameters
interpretationThe value of the new interpretation.

§ setName()

bool openjaus::model::fields::BitFieldItem::setName ( std::string  name)
Parameters
nameThe value of the new name.

§ setStartIndex()

bool openjaus::model::fields::BitFieldItem::setStartIndex ( long  startIndex)
Parameters
startIndexThe value of the new startIndex.

§ toString()

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

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ endIndex

long openjaus::model::fields::BitFieldItem::endIndex
protected

§ interpretation

std::string openjaus::model::fields::BitFieldItem::interpretation
protected

§ name

std::string openjaus::model::fields::BitFieldItem::name
protected

§ startIndex

long openjaus::model::fields::BitFieldItem::startIndex
protected

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