simPersistSet.h

Classes:

class
A SimSet that can be safely persisted.
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _SIMPERSISTSET_H_
25#define _SIMPERSISTSET_H_
26
27#ifndef _SIMSET_H_
28   #include "console/simSet.h"
29#endif
30
31
32/// A SimSet that can be safely persisted.  Uses SimPersistIDs to reference
33/// objects in the set while persisted on disk.  This allows the set to resolve
34/// its references no matter whether they are loaded before or after the set
35/// is created.
36///
37class SimPersistSet : public SimSet
38{
39   public:
40   
41      typedef SimSet Parent;
42      
43   protected:
44   
45      /// List of unresolved persistent IDs.
46      Vector< SimPersistID*> mUnresolvedPIDs;
47      
48      /// If true, the set is currently resolving persistent IDs.
49      bool mIsResolvingPIDs;
50
51   public:
52   
53      ///
54      SimPersistSet();
55   
56      /// Try to resolve all persistent IDs that as of yet are still unresolved.
57      void resolvePIDs();
58
59      // SimSet.
60      virtual void addObject( SimObject* );
61      virtual void write( Stream &stream, U32 tabStop, U32 flags = 0 );
62      virtual bool processArguments( S32 argc, ConsoleValueRef *argv );
63      
64      DECLARE_CONOBJECT( SimPersistSet );
65      DECLARE_CATEGORY( "Console" );
66      DECLARE_DESCRIPTION( "A SimSet that can be safely persisted." );
67};
68
69#endif // !_SIMPERSISTSET_H_
70