Atlas::Objects::RootData

Section: C Library Functions (3)
Updated: 24 Jul 2009
Index Return to Main Contents

NAME

Atlas::Objects::RootData - All objects inherit from this.

SYNOPSIS

#include <Root.h>

Inherits Atlas::Objects::BaseObjectData.

Inherited by Atlas::Objects::Entity::RootEntityData, and Atlas::Objects::Operation::RootOperationData.

Public Member Functions

virtual RootData * 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 setId (const std::string &val)
Set the 'id' attribute.
void setParents (const std::list< std::string > &val)
Set the 'parents' attribute.
void setParentsAsList (const Atlas::Message::ListType &val)
Set the 'parents' attribute AsList.
void setStamp (double val)
Set the 'stamp' attribute.
void setObjtype (const std::string &val)
Set the 'objtype' attribute.
void setName (const std::string &val)
Set the 'name' attribute.
const std::string & getId () const
Retrieve the 'id' attribute.
std::string & modifyId ()
Retrieve the 'id' attribute as a non-const reference.
const std::list< std::string > & getParents () const
Retrieve the 'parents' attribute.
std::list< std::string > & modifyParents ()
Retrieve the 'parents' attribute as a non-const reference.
const Atlas::Message::ListType getParentsAsList () const
Retrieve the 'parents' attribute AsList.
double getStamp () const
Retrieve the 'stamp' attribute.
double & modifyStamp ()
Retrieve the 'stamp' attribute as a non-const reference.
const std::string & getObjtype () const
Retrieve the 'objtype' attribute.
std::string & modifyObjtype ()
Retrieve the 'objtype' attribute as a non-const reference.
const std::string & getName () const
Retrieve the 'name' attribute.
std::string & modifyName ()
Retrieve the 'name' attribute as a non-const reference.
bool isDefaultId () const
Is 'id' value default?
bool isDefaultParents () const
Is 'parents' value default?
bool isDefaultStamp () const
Is 'stamp' value default?
bool isDefaultObjtype () const
Is 'objtype' value default?
bool isDefaultName () const
Is 'name' value default?
virtual void free ()
Free an instance of this class, returning it to the memory pool.
virtual RootData * 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 RootData * alloc ()
Allocate a new instance of this class, using an existing instance if available.
static RootData * getDefaultObjectInstance ()
Get the reference object that contains the default values for attributes of instances of this class.

Protected Member Functions

RootData (RootData *defaults=NULL)
Construct a RootData class definition.
virtual ~RootData ()
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 sendId (Atlas::Bridge &) const
Send the 'id' attribute to an Atlas::Bridge.
void sendParents (Atlas::Bridge &) const
Send the 'parents' attribute to an Atlas::Bridge.
void sendStamp (Atlas::Bridge &) const
Send the 'stamp' attribute to an Atlas::Bridge.
void sendObjtype (Atlas::Bridge &) const
Send the 'objtype' attribute to an Atlas::Bridge.
void sendName (Atlas::Bridge &) const
Send the 'name' attribute to an Atlas::Bridge.
virtual void iterate (int &current_class, std::string &attr) const
Iterate over the attributes of this instance.

Protected Attributes

std::string attr_id
Id of object.
std::list< std::string > attr_parents
List of objects this inherits attributes from.
double attr_stamp
Last time this object was modified.
std::string attr_objtype
What kind of object this is.
std::string attr_name
Name of object.

Detailed Description

All objects inherit from this.

Member Function Documentation

static RootData* Atlas::Objects::RootData::alloc () [static]

Allocate a new instance of this class, using an existing instance if available.

This is the key function for implementing the memory pool for the Atlas::Objects API.

Reimplemented from Atlas::Objects::BaseObjectData.

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

virtual int Atlas::Objects::RootData::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::BaseObjectData.

Reimplemented in Atlas::Objects::Entity::AccountData, Atlas::Objects::Entity::RootEntityData, and Atlas::Objects::Operation::RootOperationData.

virtual void Atlas::Objects::RootData::free () [virtual]

Free an instance of this class, returning it to the memory pool.

This function in combination with alloc() handle the memory pool.

Implements Atlas::Objects::BaseObjectData.

virtual RootData* Atlas::Objects::RootData::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.

static RootData* Atlas::Objects::RootData::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.