Atlas_Objects_Operation_RootOperationData man page

Atlas::Objects::Operation::RootOperationData — Base operation for all operators.

Synopsis

#include <RootOperation.h>

Inherits Atlas::Objects::RootData.

Inherited by Atlas::Objects::Operation::ActionData, Atlas::Objects::Operation::GenericData, and Atlas::Objects::Operation::InfoData.

Public Member Functions

virtual RootOperationData * copy () const
Copy this object.
virtual bool instanceOf (int classNo) const
Is this instance of some class?
virtual int copyAttr (const std::string &name, Atlas::Message::Element &attr) const
Retrieve the attribute 'name'.
virtual void setAttr (const std::string &name, const Atlas::Message::Element &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 void addToMessage (Atlas::Message::MapType &) const
Write this object to an existing Element.
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 setArgs (const std::vector< Root > &val)
Set the 'args' attribute.
void setArgsAsList (const Atlas::Message::ListType &val)
Set the 'args' attribute AsList.
template<class ObjectData > void setArgs1 (const SmartPtr< ObjectData > &val)
Set the first member of 'args'.
long getSerialno () const
Retrieve the 'serialno' attribute.
long & modifySerialno ()
Retrieve the 'serialno' attribute as a non-const reference.
long getRefno () const
Retrieve the 'refno' attribute.
long & modifyRefno ()
Retrieve the 'refno' attribute as a non-const reference.
const std::string & getFrom () const
Retrieve the 'from' attribute.
std::string & modifyFrom ()
Retrieve the 'from' attribute as a non-const reference.
const std::string & getTo () const
Retrieve the 'to' attribute.
std::string & modifyTo ()
Retrieve the 'to' attribute as a non-const reference.
double getSeconds () const
Retrieve the 'seconds' attribute.
double & modifySeconds ()
Retrieve the 'seconds' attribute as a non-const reference.
double getFutureSeconds () const
Retrieve the 'future_seconds' attribute.
double & modifyFutureSeconds ()
Retrieve the 'future_seconds' attribute as a non-const reference.
const std::vector< Root > & getArgs () const
Retrieve the 'args' attribute.
std::vector< Root > & modifyArgs ()
Retrieve the 'args' attribute as a non-const reference.
const Atlas::Message::ListType getArgsAsList () const
Retrieve the 'args' attribute AsList.
bool isDefaultSerialno () const
Is 'serialno' value default?
bool isDefaultRefno () const
Is 'refno' value default?
bool isDefaultFrom () const
Is 'from' value default?
bool isDefaultTo () const
Is 'to' value default?
bool isDefaultSeconds () const
Is 'seconds' value default?
bool isDefaultFutureSeconds () const
Is 'future_seconds' value default?
bool isDefaultArgs () const
Is 'args' value default?
virtual void free ()
Free an instance of this class, returning it to the memory pool.
virtual RootOperationData * getDefaultObject ()
Get the reference object that contains the default values for attributes of instances of the same class as this object.

Static Public Member Functions

static RootOperationData * alloc ()

static RootOperationData * getDefaultObjectInstance ()
Get the reference object that contains the default values for attributes of instances of this class.

Protected Member Functions

RootOperationData (RootOperationData *defaults=NULL)
Construct a RootOperationData class definition.
virtual ~RootOperationData ()
Default destructor.
virtual int getAttrClass (const std::string &name) const
Find the class which contains the attribute 'name'.
virtual int getAttrFlag (const std::string &name) const
Find the flag for the attribute 'name'.
void sendSerialno (Atlas::Bridge &) const
Send the 'serialno' attribute to an Atlas::Bridge.
void sendRefno (Atlas::Bridge &) const
Send the 'refno' attribute to an Atlas::Bridge.
void sendFrom (Atlas::Bridge &) const
Send the 'from' attribute to an Atlas::Bridge.
void sendTo (Atlas::Bridge &) const
Send the 'to' attribute to an Atlas::Bridge.
void sendSeconds (Atlas::Bridge &) const
Send the 'seconds' attribute to an Atlas::Bridge.
void sendFutureSeconds (Atlas::Bridge &) const
Send the 'future_seconds' attribute to an Atlas::Bridge.
void sendArgs (Atlas::Bridge &) const
Send the 'args' attribute to an Atlas::Bridge.
virtual void iterate (int &current_class, std::string &attr) const
Iterate over the attributes of this instance.

Protected Attributes

long attr_serialno
Serial number.
long attr_refno
Reference to serial number.
std::string attr_from
Source of message/operation.
std::string attr_to
Target of message/operation.
double attr_seconds
Time in seconds.
double attr_future_seconds
Time in seconds to add current time.
std::vector< Root > attr_args
List of arguments this operation has.

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 int Atlas::Objects::Operation::RootOperationData::copyAttr (const std::string & name, Atlas::Message::Element & attr) const [virtual]

Retrieve the attribute 'name'. Return non-zero if it does not exist.

Reimplemented from Atlas::Objects::RootData.

virtual void Atlas::Objects::Operation::RootOperationData::free () [virtual]

Free an instance of this class, returning it to the memory pool. This function in combination with alloc() handle the memory pool.

Reimplemented from Atlas::Objects::RootData.

Reimplemented in Atlas::Objects::Operation::ErrorData, Atlas::Objects::Operation::FeelData, Atlas::Objects::Operation::SmellData, Atlas::Objects::Operation::SoundData, Atlas::Objects::Operation::DisappearanceData, Atlas::Objects::Operation::AppearanceData, Atlas::Objects::Operation::SightData, Atlas::Objects::Operation::PerceptionData, Atlas::Objects::Operation::InfoData, Atlas::Objects::Operation::UseData, Atlas::Objects::Operation::ImaginaryData, Atlas::Objects::Operation::LogoutData, Atlas::Objects::Operation::LoginData, Atlas::Objects::Operation::TouchData, Atlas::Objects::Operation::SniffData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::PerceiveData, Atlas::Objects::Operation::GetData, Atlas::Objects::Operation::WieldData, Atlas::Objects::Operation::MoveData, Atlas::Objects::Operation::AffectData, Atlas::Objects::Operation::SetData, Atlas::Objects::Operation::DeleteData, Atlas::Objects::Operation::TalkData, Atlas::Objects::Operation::CommunicateData, Atlas::Objects::Operation::DivideData, Atlas::Objects::Operation::CombineData, Atlas::Objects::Operation::CreateData, Atlas::Objects::Operation::GenericData, and Atlas::Objects::Operation::ActionData.

virtual RootOperationData* Atlas::Objects::Operation::RootOperationData::getDefaultObject () [virtual]

Get the reference object that contains the default values for attributes of instances of the same class as this object.

Returns:

a pointer to the default object.

Reimplemented from Atlas::Objects::RootData.

Reimplemented in Atlas::Objects::Operation::ErrorData, Atlas::Objects::Operation::FeelData, Atlas::Objects::Operation::SmellData, Atlas::Objects::Operation::SoundData, Atlas::Objects::Operation::DisappearanceData, Atlas::Objects::Operation::AppearanceData, Atlas::Objects::Operation::SightData, Atlas::Objects::Operation::PerceptionData, Atlas::Objects::Operation::InfoData, Atlas::Objects::Operation::UseData, Atlas::Objects::Operation::ImaginaryData, Atlas::Objects::Operation::LogoutData, Atlas::Objects::Operation::LoginData, Atlas::Objects::Operation::TouchData, Atlas::Objects::Operation::SniffData, Atlas::Objects::Operation::ListenData, Atlas::Objects::Operation::LookData, Atlas::Objects::Operation::PerceiveData, Atlas::Objects::Operation::GetData, Atlas::Objects::Operation::WieldData, Atlas::Objects::Operation::MoveData, Atlas::Objects::Operation::AffectData, Atlas::Objects::Operation::SetData, Atlas::Objects::Operation::DeleteData, Atlas::Objects::Operation::TalkData, Atlas::Objects::Operation::CommunicateData, Atlas::Objects::Operation::DivideData, Atlas::Objects::Operation::CombineData, Atlas::Objects::Operation::CreateData, Atlas::Objects::Operation::GenericData, and Atlas::Objects::Operation::ActionData.

static RootOperationData* Atlas::Objects::Operation::RootOperationData::getDefaultObjectInstance () [static]

Get the reference object that contains the default values for attributes of instances of this class.

Returns:

a pointer to the default object.

Author

Generated automatically by Doxygen for Atlas-C++ from the source code.

Info

Wed Feb 3 2016 Atlas-C++