Atlas-C++
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Atlas::Objects::Operation::AffectData Class Reference

Sets attributes for existing entity. More...

#include <Operation.h>

Inheritance diagram for Atlas::Objects::Operation::AffectData:
Atlas::Objects::Operation::SetData Atlas::Objects::Operation::ActionData Atlas::Objects::Operation::RootOperationData Atlas::Objects::RootData Atlas::Objects::BaseObjectData

Public Member Functions

virtual AffectDatacopy () const
 Copy this object.
 
virtual bool instanceOf (int classNo) const
 Is this instance of some class?
 
virtual void iterate (int &current_class, std::string &attr) const
 Iterate over the attributes of this instance.
 
virtual void free ()
 Free an instance of this class, returning it to the memory pool. More...
 
virtual AffectDatagetDefaultObject ()
 Get the reference object that contains the default values for attributes of instances of the same class as this object. More...
 
- Public Member Functions inherited from Atlas::Objects::Operation::RootOperationData
virtual int copyAttr (const std::string &name, Atlas::Message::Element &attr) const
 Retrieve the attribute "name". More...
 
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?
 
- Public Member Functions inherited from Atlas::Objects::RootData
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?
 
- Public Member Functions inherited from Atlas::Objects::BaseObjectData
 BaseObjectData (BaseObjectData *defaults)
 Construct a new BaseObjectData from a subclass. More...
 
int getClassNo () const
 Get class number:
 
int getAttrFlags () const
 
bool hasAttr (const std::string &name) const
 Check whether the attribute "name" exists.
 
bool hasAttrFlag (int flag) const
 Check whether the attribute "name" exists.
 
const Atlas::Message::Element getAttr (const std::string &name) const
 Retrieve the attribute "name". More...
 
virtual void removeAttrFlag (int flag)
 Remove the attribute "name".
 
const Atlas::Message::MapType asMessage () const
 Convert this object to a Object. More...
 
void incRef ()
 
void decRef ()
 
iterator begin ()
 
iterator end ()
 
iterator find (const std::string &)
 
const_iterator begin () const
 
const_iterator end () const
 
const_iterator find (const std::string &) const
 

Static Public Member Functions

static AffectDataalloc ()
 
static AffectDatagetDefaultObjectInstance ()
 Get the reference object that contains the default values for attributes of instances of this class. More...
 
- Static Public Member Functions inherited from Atlas::Objects::Operation::SetData
static SetDataalloc ()
 
static SetDatagetDefaultObjectInstance ()
 Get the reference object that contains the default values for attributes of instances of this class. More...
 
- Static Public Member Functions inherited from Atlas::Objects::Operation::ActionData
static ActionDataalloc ()
 
static ActionDatagetDefaultObjectInstance ()
 Get the reference object that contains the default values for attributes of instances of this class. More...
 
- Static Public Member Functions inherited from Atlas::Objects::Operation::RootOperationData
static RootOperationDataalloc ()
 
static RootOperationDatagetDefaultObjectInstance ()
 Get the reference object that contains the default values for attributes of instances of this class. More...
 
- Static Public Member Functions inherited from Atlas::Objects::RootData
static RootDataalloc ()
 
static RootDatagetDefaultObjectInstance ()
 Get the reference object that contains the default values for attributes of instances of this class. More...
 
- Static Public Member Functions inherited from Atlas::Objects::BaseObjectData
static BaseObjectDataalloc ()
 Allocate a new instance of this class, using an existing instance if available. More...
 

Protected Member Functions

 AffectData (AffectData *defaults=NULL)
 Construct a AffectData class definition.
 
virtual ~AffectData ()
 Default destructor.
 
- Protected Member Functions inherited from Atlas::Objects::Operation::SetData
 SetData (SetData *defaults=NULL)
 Construct a SetData class definition.
 
virtual ~SetData ()
 Default destructor.
 
- Protected Member Functions inherited from Atlas::Objects::Operation::ActionData
 ActionData (ActionData *defaults=NULL)
 Construct a ActionData class definition.
 
virtual ~ActionData ()
 Default destructor.
 
- Protected Member Functions inherited from Atlas::Objects::Operation::RootOperationData
 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.
 
- Protected Member Functions inherited from Atlas::Objects::RootData
 RootData (RootData *defaults=NULL)
 Construct a RootData class definition.
 
virtual ~RootData ()
 Default destructor.
 
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.
 

Additional Inherited Members

- Protected Attributes inherited from Atlas::Objects::Operation::RootOperationData
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< Rootattr_args
 List of arguments this operation has.
 
- Protected Attributes inherited from Atlas::Objects::RootData
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.
 
- Protected Attributes inherited from Atlas::Objects::BaseObjectData
int m_class_no
 
int m_refCount
 
BaseObjectDatam_defaults
 
BaseObjectDatam_next
 
std::map< std::string, Atlas::Message::Elementm_attributes
 
int m_attrFlags
 

Detailed Description

Sets attributes for existing entity.

.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

◆ free()

virtual void Atlas::Objects::Operation::AffectData::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::Operation::SetData.

◆ getDefaultObject()

virtual AffectData* Atlas::Objects::Operation::AffectData::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::Operation::SetData.

◆ getDefaultObjectInstance()

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

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

Copyright 2000-2004 the respective authors.

This document can be licensed under the terms of the GNU Free Documentation License or the GNU General Public License and may be freely distributed under the terms given by one of these licenses.