Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   Related Pages  

Atlas::Objects::Operation::RootOperation Class Reference

Base operation for all operators. More...

#include <RootOperation.h>

Inheritance diagram for Atlas::Objects::Operation::RootOperation:

Atlas::Objects::Root Atlas::Objects::Operation::Action Atlas::Objects::Operation::Info Atlas::Objects::Operation::Create Atlas::Objects::Operation::Delete Atlas::Objects::Operation::Get Atlas::Objects::Operation::Imaginary Atlas::Objects::Operation::Set Atlas::Objects::Operation::Error Atlas::Objects::Operation::Perception Atlas::Objects::Operation::Combine Atlas::Objects::Operation::Communicate Atlas::Objects::Operation::Divide Atlas::Objects::Operation::Login Atlas::Objects::Operation::Perceive Atlas::Objects::Operation::Move Atlas::Objects::Operation::Feel Atlas::Objects::Operation::Sight Atlas::Objects::Operation::Smell Atlas::Objects::Operation::Sound List of all members.

Public Member Functions

 RootOperation ()
 Construct a RootOperation class definition.

virtual ~RootOperation ()
 Default destructor.

virtual bool HasAttr (const std::string &name) const
 Check whether the attribute "name" exists.

virtual Atlas::Message::Object GetAttr (const std::string &name) const throw (NoSuchAttrException)
 Retrieve the attribute "name".

virtual void SetAttr (const std::string &name, const Atlas::Message::Object &attr)
 Set the attribute "name" to the value given by"attr".

virtual void RemoveAttr (const std::string &name)
 Remove the attribute "name". This will not work for static attributes.

virtual void SendContents (Atlas::Bridge *b) const
 Send the contents of this object to a Bridge.

virtual Atlas::Message::Object AsObject () const
 Convert this object to a Message::Object.

virtual Atlas::Message::Object::MapType AsMap () const
 Convert this object to a Message::Object::MapType.

void SetSerialno (long val)
 Set the "serialno" attribute.

void SetRefno (long val)
 Set the "refno" attribute.

void SetFrom (const std::string &val)
 Set the "from" attribute.

void SetTo (const std::string &val)
 Set the "to" attribute.

void SetSeconds (double val)
 Set the "seconds" attribute.

void SetFutureSeconds (double val)
 Set the "future_seconds" attribute.

void SetTimeString (const std::string &val)
 Set the "time_string" attribute.

void SetArgs (const Atlas::Message::Object::ListType &val)
 Set the "args" attribute.

long GetSerialno () const
 Retrieve the "serialno" attribute.

long & GetSerialno ()
 Retrieve the "serialno" attribute as a non-const reference.

long GetRefno () const
 Retrieve the "refno" attribute.

long & GetRefno ()
 Retrieve the "refno" attribute as a non-const reference.

const std::string & GetFrom () const
 Retrieve the "from" attribute.

std::string & GetFrom ()
 Retrieve the "from" attribute as a non-const reference.

const std::string & GetTo () const
 Retrieve the "to" attribute.

std::string & GetTo ()
 Retrieve the "to" attribute as a non-const reference.

double GetSeconds () const
 Retrieve the "seconds" attribute.

double & GetSeconds ()
 Retrieve the "seconds" attribute as a non-const reference.

double GetFutureSeconds () const
 Retrieve the "future_seconds" attribute.

double & GetFutureSeconds ()
 Retrieve the "future_seconds" attribute as a non-const reference.

const std::string & GetTimeString () const
 Retrieve the "time_string" attribute.

std::string & GetTimeString ()
 Retrieve the "time_string" attribute as a non-const reference.

const Atlas::Message::Object::ListType & GetArgs () const
 Retrieve the "args" attribute.

Atlas::Message::Object::ListType & GetArgs ()
 Retrieve the "args" attribute as a non-const reference.


Static Public Member Functions

RootOperation Instantiate ()
 Create a new instance of RootOperation.


Protected Member Functions

 RootOperation (const std::string &, const std::string &)
void SendSerialno (Atlas::Bridge *) const
void SendRefno (Atlas::Bridge *) const
void SendFrom (Atlas::Bridge *) const
void SendTo (Atlas::Bridge *) const
void SendSeconds (Atlas::Bridge *) const
void SendFutureSeconds (Atlas::Bridge *) const
void SendTimeString (Atlas::Bridge *) const
void SendArgs (Atlas::Bridge *) const

Protected Attributes

long attr_serialno
long attr_refno
std::string attr_from
std::string attr_to
double attr_seconds
double attr_future_seconds
std::string attr_time_string
Atlas::Message::Object::ListType attr_args

Detailed Description

Base operation for all operators.

This is base operation for all other operations and defines basic attributes. You can use this as starting point for browsing whole operation hiearchy. refno refers to operation this is reply for. In examples all attributes that are just as examples (and thus world specific) are started with 'e_'.


Member Function Documentation

virtual Atlas::Message::Object Atlas::Objects::Operation::RootOperation::GetAttr const std::string &    name const throw (NoSuchAttrException) [virtual]
 

Retrieve the attribute "name".

Throws NoSuchAttrException if it does not exist.

Reimplemented from Atlas::Objects::Root.


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

Copyright 2000 the respective authors.

This document is licensed under the terms of the GNU Free Documentation License and may be freely distributed under the conditions given by this license.