CVEX/CVEX_ValueList.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:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        CVEX_ValueList.h ( CVEX Library, C++)
 *
 * COMMENTS:    C++ interface to VEX.  This class is used to specify
 *              a list of input/output values
 */

#ifndef __CVEX_ValueList__
#define __CVEX_ValueList__

#include "CVEX_API.h"
#include "CVEX_Value.h"
#include <UT/UT_PtrArray.h>
#include <UT/UT_SymbolTable.h>

class CVEX_API CVEX_ValueList {
public:
     CVEX_ValueList();
    ~CVEX_ValueList();

    // Returns the number of values in the list
    int          entries()              { return myValues.entries(); }

    // Get a value by index or by name
    CVEX_Value  *getValue(int i)        { return myValues(i); }
    CVEX_Value  *getValue(const char *name, CVEX_Type type);

    // Add a value.  This fails if:
    //  - There's already a symbol with the name
    //  - The type is invalid
    bool         addValue(const char *name, CVEX_Type type, bool varying);
    bool         addValue(const char *name, CVEX_Type type,
                            void *data, int array_size);
    bool         addValue(const char *name, UT_StringArray &strings);

private:
    void                clear();
    void                addValue(CVEX_Value *value);

    UT_SymbolTable               mySymbols;
    UT_PtrArray<CVEX_Value *>    myValues;

    friend class                 CVEX_Context;
};

#endif

---