SIM/SIM_DataHint.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        SIM_DataHint.h ( SIM Library, C++)
 *
 * COMMENTS:    Holds information about what sort of simulation data
 *              relationships are likely valid, and which are likely not.
 */

#ifndef __SIM_DataHint__
#define __SIM_DataHint__

#include "SIM_API.h"
#include <UT/UT_String.h>
#include <UT/UT_IntArray.h>
#include <UT/UT_PtrArray.h>
#include <UT/UT_SymbolTable.h>

class UT_StringArray;
class SIM_Data;
class SIM_Object;
class SIM_Engine;
class SIM_DataHint;
class SIM_RootData;

typedef UT_PtrArray<SIM_DataHint *>      SIM_DataHintArray;

class SIM_API SIM_DataHint
{
public:
    static void          addHint(const UT_String &parentdatatype,
                                 const UT_String &expectedchildtype,
                                 const UT_String &expectedchildname,
                                 int maxcount);
    static void          getAllDataHints(UT_StringArray &parentdatatypes,
                                         UT_StringArray &expectedchildtypes,
                                         UT_StringArray &expectedchildnames,
                                         UT_IntArray &maxcounts);
    static void          getAllSubdataTypes(const char *parentdatatype,
                                            UT_StringArray &subdatatypes,
                                            UT_IntArray &maxcountindices,
                                            UT_IntArray &maxcounts);
    static void          verifySimulationData(const SIM_Engine &engine);
    static void          destroyAllDataHints();

    static void          addAlias(const char *datatype, const char *alias);
    static const char   *getDataTypeFromAlias(const char *alias);
    static void          getAllDataTypeAliases(UT_StringArray &aliases,
                                               UT_StringArray &datatypes);

private:
                         SIM_DataHint(const char *parentdatatype,
                                      const char *expecteddatatype,
                                      const char *expecteddataname,
                                      int maxcount);
    virtual             ~SIM_DataHint();

    bool                 getDataIsExpected(const SIM_Data &child,
                                           const UT_String &childname) const;

    static int           mergeHintsForParent(UT_Thing &, const char *, void *);
    static void          processHintsForData(const SIM_Engine &engine,
                                             const SIM_RootData &rootdata,
                                             const SIM_Data &parentdata);
    static int           destroyHintTableEntry(UT_Thing &thing,
                                               const char *, void *);
    static void          destroyDataHints(void *);

    UT_String            myParentDataType;
    UT_String            myExpectedDataType;
    UT_String            myExpectedDataName;
    int                  myMaxCount;

    static SIM_DataHintArray    *theMasterHintArray;
    static UT_SymbolTable       *theHintTable;
    static UT_SymbolTable        theDataTypeAliases;
};

#endif

---