Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Feb 15, 2008, 4:31:58 PM (16 years ago)
Author:
landauf
Message:
  • removed IdentifierList and replaced it by a std::list
  • changed several doxygen tags
File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/branches/core/src/orxonox/core/OrxonoxClass.h

    r792 r813  
    2626 */
    2727
    28 /*!
     28/**
    2929    @file OrxonoxClass.h
    3030    @brief Definition of the OrxonoxClass Class.
    … …  
    3737#define _OrxonoxClass_H__
    3838
     39#include <list>
    3940#include <string>
    4041
    … …  
    5960            void setConfigValues() {};
    6061
    61             /** @returns the Identifier of the object */
     62            /** @brief Returns the Identifier of the object. @return The Identifier */
    6263            inline Identifier* getIdentifier() const { return this->identifier_; }
    6364
    … …  
    6566            inline void setIdentifier(Identifier* identifier) { this->identifier_ = identifier; }
    6667
    67             /** @returns the list of all parents of the object */
    68             inline IdentifierList* getParents() const { return this->parents_; }
     68            /** @brief Returns the list of all parents of the object. @return The list */
     69            inline std::list<const Identifier*>* getParents() const { return this->parents_; }
    6970
    70             /** @brief Sets the Parents of the object. Used by the RegisterObject-macro. */
    71             inline void setParents(IdentifierList* parents) { this->parents_ = parents; }
     71            /** @brief Creates the parents-list. */
     72            inline void createParents() { this->parents_ = new std::list<const Identifier*>(); }
    7273
    73             /** @returns the MetaObjectList of the object, containing a link to all ObjectLists and ObjectListElements the object is registered in. */
     74//            /** @brief Sets the Parents of the object. Used by the RegisterObject-macro. */
     75//            inline void setParents(std::list<const Identifier*>* parents) { this->parents_ = parents; }
     76
     77            /** @brief Returns the MetaObjectList of the object, containing a link to all ObjectLists and ObjectListElements the object is registered in. @return The list */
    7478            inline MetaObjectList& getMetaList() { return this->metaList_; }
    7579
    7680
    77             /** @returns true if the objects class is of the given type or a derivative. */
     81            /** @brief Returns true if the objects class is of the given type or a derivative. */
    7882            inline bool isA(const Identifier* identifier)
    7983                { return this->getIdentifier()->isA(identifier); }
    80             /** @returns true if the objects class is exactly of the given type. */
     84            /** @brief Returns true if the objects class is exactly of the given type. */
    8185            inline bool isDirectlyA(const Identifier* identifier)
    8286                { return this->getIdentifier()->isDirectlyA(identifier); }
    83             /** @returns true if the objects class is a child of the given type. */
     87            /** @brief Returns true if the objects class is a child of the given type. */
    8488            inline bool isChildOf(const Identifier* identifier)
    8589                { return this->getIdentifier()->isChildOf(identifier); }
    86             /** @returns true if the objects class is a parent of the given type. */
     90            /** @brief Returns true if the objects class is a parent of the given type. */
    8791            inline bool isParentOf(const Identifier* identifier)
    8892                { return this->getIdentifier()->isParentOf(identifier); }
    8993
    9094
    91             /** @returns true if the objects class is of the given type or a derivative. */
     95            /** @brief Returns true if the objects class is of the given type or a derivative. */
    9296            inline bool isA(const SubclassIdentifier<class B>* identifier)
    9397                { return this->getIdentifier()->isA(identifier->getIdentifier()); }
    94             /** @returns true if the objects class is exactly of the given type. */
     98            /** @brief Returns true if the objects class is exactly of the given type. */
    9599            inline bool isDirectlyA(const SubclassIdentifier<class B>* identifier)
    96100                { return this->getIdentifier()->isDirectlyA(identifier->getIdentifier()); }
    97             /** @returns true if the objects class is a child of the given type. */
     101            /** @brief Returns true if the objects class is a child of the given type. */
    98102            inline bool isChildOf(const SubclassIdentifier<class B>* identifier)
    99103                { return this->getIdentifier()->isChildOf(identifier->getIdentifier()); }
    100             /** @returns true if the objects class is a parent of the given type. */
     104            /** @brief Returns true if the objects class is a parent of the given type. */
    101105            inline bool isParentOf(const SubclassIdentifier<class B>* identifier)
    102106                { return this->getIdentifier()->isParentOf(identifier->getIdentifier()); }
    103107
    104108
    105             /** @returns true if the objects class is of the given type or a derivative. */
     109            /** @brief Returns true if the objects class is of the given type or a derivative. */
    106110            inline bool isA(const SubclassIdentifier<class B> identifier)
    107111                { return this->getIdentifier()->isA(identifier.getIdentifier()); }
    108             /** @returns true if the objects class is exactly of the given type. */
     112            /** @brief Returns true if the objects class is exactly of the given type. */
    109113            inline bool isDirectlyA(const SubclassIdentifier<class B> identifier)
    110114                { return this->getIdentifier()->isDirectlyA(identifier.getIdentifier()); }
    111             /** @returns true if the objects class is a child of the given type. */
     115            /** @brief Returns true if the objects class is a child of the given type. */
    112116            inline bool isChildOf(const SubclassIdentifier<class B> identifier)
    113117                { return this->getIdentifier()->isChildOf(identifier.getIdentifier()); }
    114             /** @returns true if the objects class is a parent of the given type. */
     118            /** @brief Returns true if the objects class is a parent of the given type. */
    115119            inline bool isParentOf(const SubclassIdentifier<class B> identifier)
    116120                { return this->getIdentifier()->isParentOf(identifier.getIdentifier()); }
    117121
    118122
    119             /** @returns true if the objects class is of the given type or a derivative. */
     123            /** @brief Returns true if the objects class is of the given type or a derivative. */
    120124            inline bool isA(const OrxonoxClass* object)
    121125                { return this->getIdentifier()->isA(object->getIdentifier()); }
    122             /** @returns true if the objects class is exactly of the given type. */
     126            /** @brief Returns true if the objects class is exactly of the given type. */
    123127            inline bool isDirectlyA(const OrxonoxClass* object)
    124128                { return this->getIdentifier()->isDirectlyA(object->getIdentifier()); }
    125             /** @returns true if the objects class is a child of the given type. */
     129            /** @brief Returns true if the objects class is a child of the given type. */
    126130            inline bool isChildOf(const OrxonoxClass* object)
    127131                { return this->getIdentifier()->isChildOf(object->getIdentifier()); }
    128             /** @returns true if the objects class is a parent of the given type. */
     132            /** @brief Returns true if the objects class is a parent of the given type. */
    129133            inline bool isParentOf(const OrxonoxClass* object)
    130134                { return this->getIdentifier()->isParentOf(object->getIdentifier()); }
    … …  
    134138            inline virtual void setName(const std::string& name) { this->name_ = name; }
    135139
    136             /** @returns the name of the object. */
     140            /** @brief Returns the name of the object. @return The name */
    137141            inline const std::string& getName() const { return this->name_; }
    138142
    … …  
    140144            inline virtual void setActive(bool bActive) { this->bActive_ = bActive; }
    141145
    142             /** @returns the state of the objects activity. */
     146            /** @brief Returns the state of the objects activity. @return The state of the activity */
    143147            inline const bool isActive() const { return this->bActive_; }
    144148
    … …  
    146150            inline virtual void setVisible(bool bVisible) { this->bVisible_ = bVisible; }
    147151
    148             /** @returns the state of the objects visibility. */
     152            /** @brief Returns the state of the objects visibility. @return The state of the visibility */
    149153            inline const bool isVisible() const { return this->bVisible_; }
    150154
    151155        private:
    152             Identifier* identifier_;        //!< The Identifier of the object
    153             IdentifierList* parents_;       //!< List of all parents of the object
    154             MetaObjectList metaList_;       //!< MetaObjectList, containing all ObjectLists and ObjectListElements the object is registered in
     156            Identifier* identifier_;                    //!< The Identifier of the object
     157            std::list<const Identifier*>* parents_;     //!< List of all parents of the object
     158            MetaObjectList metaList_;                   //!< MetaObjectList, containing all ObjectLists and ObjectListElements the object is registered in
    155159
    156             std::string name_;              //!< The name of the object
    157             bool bActive_;                  //!< True = the object is active
    158             bool bVisible_;                 //!< True = the object is visible
     160            std::string name_;                          //!< The name of the object
     161            bool bActive_;                              //!< True = the object is active
     162            bool bVisible_;                             //!< True = the object is visible
    159163    };
    160164    template class _CoreExport orxonox::ClassIdentifier<OrxonoxClass>;
Note: See TracChangeset for help on using the changeset viewer.