OpenJAUS Software Development Kit  4.3.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
openjaus::core::StatusEnumeration Class Reference

#include <StatusEnumeration.h>

Inherits openjaus::model::fields::Enumeration.

Public Types

enum  StatusEnum {
  INIT = 0, READY = 1, STANDBY = 2, SHUTDOWN = 3,
  FAILURE = 4, EMERGENCY = 5, UNKNOWN = 255
}
 

Public Member Functions

 StatusEnumeration ()
 
 StatusEnumeration (StatusEnum value)
 
 ~StatusEnumeration ()
 
virtual int to (system::Buffer *dst)
 Operation to. More...
 
virtual int from (system::Buffer *src)
 Operation from. More...
 
virtual int length (void)
 Serializes object to internal transport buffer. More...
 
std::string toXml (unsigned char ojIndentLevel=0) const
 
std::string toString () const
 
StatusEnum getValue (void) const
 
void setValue (StatusEnum value)
 
- Public Member Functions inherited from openjaus::model::fields::Enumeration
 Enumeration ()
 
virtual ~Enumeration ()
 
long getValue () const
 Accessor to get the value of value. More...
 
bool setValue (long value)
 Accessor to set value of value. More...
 
- Public Member Functions inherited from openjaus::model::fields::ComplexField
virtual ~ComplexField ()
 
- Public Member Functions inherited from openjaus::model::fields::Field
 Field ()
 
virtual ~Field ()
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 
- Public Member Functions inherited from openjaus::system::Transportable
virtual ~Transportable ()
 
 Transportable ()
 

Static Public Member Functions

static std::string toString (StatusEnum value)
 

Protected Attributes

StatusEnum value
 
- Protected Attributes inherited from openjaus::model::fields::Enumeration
long value
 
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Member Enumeration Documentation

§ StatusEnum

Enumerator
INIT 
READY 
STANDBY 
SHUTDOWN 
FAILURE 
EMERGENCY 
UNKNOWN 

Constructor & Destructor Documentation

§ StatusEnumeration() [1/2]

openjaus::core::StatusEnumeration::StatusEnumeration ( )

§ StatusEnumeration() [2/2]

openjaus::core::StatusEnumeration::StatusEnumeration ( StatusEnumeration::StatusEnum  value)

§ ~StatusEnumeration()

openjaus::core::StatusEnumeration::~StatusEnumeration ( )

Member Function Documentation

§ from()

int openjaus::core::StatusEnumeration::from ( system::Buffer src)
virtual
Parameters
src

Reimplemented from openjaus::model::fields::Enumeration.

§ getValue()

StatusEnumeration::StatusEnum openjaus::core::StatusEnumeration::getValue ( void  ) const

§ length()

int openjaus::core::StatusEnumeration::length ( void  )
virtual

§ setValue()

void openjaus::core::StatusEnumeration::setValue ( StatusEnumeration::StatusEnum  value)

§ to()

int openjaus::core::StatusEnumeration::to ( system::Buffer dst)
virtual
Parameters
dst

Reimplemented from openjaus::model::fields::Enumeration.

§ toString() [1/2]

std::string openjaus::core::StatusEnumeration::toString ( ) const
virtual

§ toString() [2/2]

std::string openjaus::core::StatusEnumeration::toString ( StatusEnumeration::StatusEnum  value)
static

§ toXml()

std::string openjaus::core::StatusEnumeration::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

§ value

StatusEnum openjaus::core::StatusEnumeration::value
protected

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