Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

# Tools/Xabsl2/Xabsl2Engine/Xabsl2Agent.h

Go to the documentation of this file.

    00001 /**
    00002 * @file Xabsl2Agent.h
    00003 *
    00004 * Definition of class Xabsl2Agent
    00005 *
    00006 * @author Martin Lötzsch
    00007 */
    00008
    00009 #ifndef __Xabsl2Agent_h_
    00010 #define __Xabsl2Agent_h_
    00011
    00012 #include "Xabsl2Option.h"
    00013
    00014 /**
    00015 * @class Xabsl2Agent
    00016 *
    00017 * Combines some options to an agent
    00018 *
    00019 * @author Martin Lötzsch
    00020 */
    00021 class Xabsl2Agent : public Xabsl2NamedItem
    00022 {
    00023 public:
    00024   /**
    00025   * Constructor
    00026   * @param name The name of the agent
    00027   * @param rootOption A pointer to the initial option of the agent
    00028   * @param errorHandler Is invoked when errors occur
    00029   */
    00030   Xabsl2Agent(const char* name, Xabsl2Option* rootOption,
    00031     Xabsl2ErrorHandler& errorHandler);
    00032
    00033   /** Returns the root option */
    00034   Xabsl2Option* getRootOption() const;
    00035 private:
    00036
    00037   /** A pointer to the root option */
    00038   Xabsl2Option* rootOption;
    00039
    00040   /** Is invoked when errors occur */
    00041   Xabsl2ErrorHandler& errorHandler;
    00042 };
    00043
    00044 #endif // __Xabsl2Agent_h_