OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
openjaus::model::Service Class Reference

This is a brief description. More...

#include <Service.h>

Public Member Functions

 Service ()
 
virtual ~Service ()
 
 Service (const Service &copy)
 
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 getUri () const
 Accessor to get the value of uri. More...
 
bool setUri (std::string uri)
 Accessor to set value of uri. More...
 
std::string getDescription () const
 Accessor to get the value of description. More...
 
bool setDescription (std::string description)
 Accessor to set value of description. More...
 
int getVersionMajor () const
 Accessor to get the value of versionMajor. More...
 
bool setVersionMajor (int versionMajor)
 Accessor to set value of versionMajor. More...
 
int getVersionMinor () const
 Accessor to get the value of versionMinor. More...
 
bool setVersionMinor (int versionMinor)
 Accessor to set value of versionMinor. More...
 
ServicegetInheritsFrom () const
 Accessor to get the value of inheritsFrom. More...
 
bool setInheritsFrom (Service *inheritsFrom)
 Accessor to set value of inheritsFrom. More...
 
const std::vector< Trigger *> & getTriggers () const
 Accessor to get the value of triggers. More...
 
bool setTriggers (const Trigger &triggers)
 Accessor to set value of triggers. More...
 
const std::vector< StateMachine *> & getStateMachines () const
 Accessor to get the value of stateMachines. More...
 
bool setStateMachines (const StateMachine &stateMachines)
 Accessor to set value of stateMachines. More...
 
const std::vector< Action *> & getActions () const
 Accessor to get the value of actions. More...
 
bool setActions (const Action &actions)
 Accessor to set value of actions. More...
 
const std::vector< Transition *> & getTransitions () const
 Accessor to get the value of transitions. More...
 
bool setTransitions (const Transition &transitions)
 Accessor to set value of transitions. More...
 
const std::vector< State *> & getStates () const
 Accessor to get the value of states. More...
 
bool setStates (const State &states)
 Accessor to set value of states. More...
 
StateMachine getStateMachine (std::string name)
 Operation getStateMachine. More...
 
virtual std::string toString () const
 
std::string toXml (unsigned char level=0) const
 
virtual void start ()
 
virtual void stop ()
 

Static Public Attributes

static const int ANY_VERSION = -1
 

Protected Attributes

std::string name
 
std::string uri
 
std::string description
 
int versionMajor
 
int versionMinor
 
ServiceinheritsFrom
 
std::vector< Trigger *> triggers
 
std::vector< StateMachine *> stateMachines
 
std::vector< Action *> actions
 
std::vector< Transition *> transitions
 
std::vector< State *> states
 

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

◆ Service() [1/2]

openjaus::model::Service::Service ( )

◆ ~Service()

openjaus::model::Service::~Service ( )
virtual

◆ Service() [2/2]

openjaus::model::Service::Service ( const Service copy)

Member Function Documentation

◆ getActions()

const std::vector< Action *> & openjaus::model::Service::getActions ( ) const

◆ getDescription()

std::string openjaus::model::Service::getDescription ( ) const

◆ getInheritsFrom()

Service * openjaus::model::Service::getInheritsFrom ( ) const

◆ getName()

std::string openjaus::model::Service::getName ( ) const

◆ getStateMachine()

StateMachine openjaus::model::Service::getStateMachine ( std::string  name)
Parameters
name

◆ getStateMachines()

const std::vector< StateMachine *> & openjaus::model::Service::getStateMachines ( ) const

◆ getStates()

const std::vector< State *> & openjaus::model::Service::getStates ( ) const

◆ getTransitions()

const std::vector< Transition *> & openjaus::model::Service::getTransitions ( ) const

◆ getTriggers()

const std::vector< Trigger *> & openjaus::model::Service::getTriggers ( ) const

◆ getUri()

std::string openjaus::model::Service::getUri ( ) const

◆ getVersionMajor()

int openjaus::model::Service::getVersionMajor ( ) const

◆ getVersionMinor()

int openjaus::model::Service::getVersionMinor ( ) const

◆ setActions()

bool openjaus::model::Service::setActions ( const Action actions)
Parameters
actionsThe value of the new actions.

◆ setDescription()

bool openjaus::model::Service::setDescription ( std::string  description)
Parameters
descriptionThe value of the new description.

◆ setInheritsFrom()

bool openjaus::model::Service::setInheritsFrom ( Service inheritsFrom)
Parameters
inheritsFromThe value of the new inheritsFrom.

◆ setName()

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

◆ setStateMachines()

bool openjaus::model::Service::setStateMachines ( const StateMachine stateMachines)
Parameters
stateMachinesThe value of the new stateMachines.

◆ setStates()

bool openjaus::model::Service::setStates ( const State states)
Parameters
statesThe value of the new states.

◆ setTransitions()

bool openjaus::model::Service::setTransitions ( const Transition transitions)
Parameters
transitionsThe value of the new transitions.

◆ setTriggers()

bool openjaus::model::Service::setTriggers ( const Trigger triggers)
Parameters
triggersThe value of the new triggers.

◆ setUri()

bool openjaus::model::Service::setUri ( std::string  uri)
Parameters
uriThe value of the new uri.

◆ setVersionMajor()

bool openjaus::model::Service::setVersionMajor ( int  versionMajor)
Parameters
versionMajorThe value of the new versionMajor.

◆ setVersionMinor()

bool openjaus::model::Service::setVersionMinor ( int  versionMinor)
Parameters
versionMinorThe value of the new versionMinor.

◆ start()

void openjaus::model::Service::start ( )
virtual

◆ stop()

void openjaus::model::Service::stop ( )
virtual

◆ toString()

std::string openjaus::model::Service::toString ( ) const
virtual

◆ toXml()

std::string openjaus::model::Service::toXml ( unsigned char  level = 0) const

Friends And Related Function Documentation

◆ operator<< [1/2]

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

◆ operator<< [2/2]

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

Member Data Documentation

◆ actions

std::vector< Action* > openjaus::model::Service::actions
protected

◆ ANY_VERSION

const int openjaus::model::Service::ANY_VERSION = -1
static

◆ description

std::string openjaus::model::Service::description
protected

◆ inheritsFrom

Service* openjaus::model::Service::inheritsFrom
protected

◆ name

std::string openjaus::model::Service::name
protected

◆ stateMachines

std::vector< StateMachine* > openjaus::model::Service::stateMachines
protected

◆ states

std::vector< State* > openjaus::model::Service::states
protected

◆ transitions

std::vector< Transition* > openjaus::model::Service::transitions
protected

◆ triggers

std::vector< Trigger* > openjaus::model::Service::triggers
protected

◆ uri

std::string openjaus::model::Service::uri
protected

◆ versionMajor

int openjaus::model::Service::versionMajor
protected

◆ versionMinor

int openjaus::model::Service::versionMinor
protected

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