Node.h
Go to the documentation of this file.
00001 /*********************************************************************
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Copyright (c) 2013, Institute for Artificial Intelligence,
00005  *  Universität Bremen.
00006  *  All rights reserved.
00007  *
00008  *  Redistribution and use in source and binary forms, with or without
00009  *  modification, are permitted provided that the following conditions
00010  *  are met:
00011  *
00012  *   * Redistributions of source code must retain the above copyright
00013  *     notice, this list of conditions and the following disclaimer.
00014  *   * Redistributions in binary form must reproduce the above
00015  *     copyright notice, this list of conditions and the following
00016  *     disclaimer in the documentation and/or other materials provided
00017  *     with the distribution.
00018  *   * Neither the name of the Institute for Artificial Intelligence,
00019  *     Universität Bremen, nor the names of its contributors may be
00020  *     used to endorse or promote products derived from this software
00021  *     without specific prior written permission.
00022  *
00023  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00024  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00025  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00026  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00027  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00028  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00029  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00030  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00032  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00033  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00034  *  POSSIBILITY OF SUCH DAMAGE.
00035  *********************************************************************/
00036 
00040 #ifndef __NODE_H__
00041 #define __NODE_H__
00042 
00043 
00044 // System
00045 #include <string>
00046 
00047 // Other
00048 #include <designators/CKeyValuePair.h>
00049 
00050 
00051 namespace beliefstate {
00057   class Node {
00058   private:
00062     std::string m_strTitle;
00068     std::string m_strUniqueID;
00074     int m_nID;
00075     
00077     Node* m_ndParent;
00083     std::list<CKeyValuePair*> m_lstDescription;
00085     std::list<Node*> m_lstSubnodes;
00091     CKeyValuePair* m_ckvpMetaInformation;
00092     
00098     std::list< std::pair<std::string, Node*> > m_lstCaughtFailures;
00099     
00101     void init();
00102     
00107     void clearDescription();
00112     void clearSubnodes();
00113     
00114   public:
00116     Node();
00118     Node(std::string strTitle);
00121     Node(std::list<CKeyValuePair*> lstDescription);
00123     ~Node();
00124     
00131     void setDescription(std::list<CKeyValuePair*> lstDescription);
00135     std::list<CKeyValuePair*> description();
00136     
00143     void setTitle(std::string strTitle);
00147     std::string title();
00148     
00152     void setParent(Node* ndParent);
00156     Node* parent();
00157     Node* relativeWithID(int nID, bool bIgnoreSelf = false);
00158     
00166     void addSubnode(Node* ndAdd);
00170     std::list<Node*> subnodes();
00171     
00172     void setUniqueID(std::string strUniqueID);
00173     std::string uniqueID();
00174     
00175     void setID(int nID);
00176     int id();
00177     
00178     int highestID();
00179     
00180     bool includesUniqueID(std::string strUniqueID);
00181     
00182     CKeyValuePair* metaInformation();
00183     
00184     void setPrematurelyEnded(bool bPrematurelyEnded);
00185     bool prematurelyEnded();
00186     
00187     CKeyValuePair* addDescriptionListItem(std::string strDomain, std::string strPrefix);
00188     std::string addImage(std::string strOrigin, std::string strFilename, std::string strTimestamp);
00189     std::string addObject(std::list<CKeyValuePair*> lstDescription);
00190     std::string addFailure(std::string strCondition, std::string strTimestamp);
00191     std::string catchFailure(std::string strFailureID, Node* ndEmitter, std::string strTimestamp);
00192     void removeCaughtFailure(std::string strFailureID);
00193     Node* emitterForCaughtFailure(std::string strFailureID, std::string strEmitterID, std::string strTimestamp);
00194     bool hasFailures();
00195     void addDesignator(std::string strType, std::list<CKeyValuePair*> lstDescription, std::string strUniqueID, std::string strAnnotation = "");
00196     
00197     void setSuccess(bool bSuccess);
00198     bool success();
00199     
00200     Node* previousNode();
00201     
00202     void ensureProperty(std::string strKey, std::string strDefaultValue);
00203   };
00204 }
00205 
00206 
00207 #endif /* __NODE_H__ */


beliefstate
Author(s): Jan Winkler
autogenerated on Sun Oct 5 2014 22:30:15