ArgList.h

Go to the documentation of this file.

/*
 *****************************************************************
 *****************************************************************
 *******                                                  ********
 *******     (C) Copyright 1989-2007  by Tecplot Inc.     ********
 *******             All Rights Reserved.                 ********
 *******                                                  ********
 *****************************************************************
 *****************************************************************
 */
#ifndef TECPLOT_TOOLBOX_ARGLIST_H
#define TECPLOT_TOOLBOX_ARGLIST_H

#if defined MSWIN
#pragma once
#endif

#include <string>
#include <list>
#include <vector>
#include "tptoolbox.h"
#include "OutOfMemoryException.h"
#include "ToolboxFwd.h"

namespace tecplot
{
namespace toolbox
{

class TPTOOLBOX_DLLAPI ArgList
{
public:
    ArgList();
    virtual ~ArgList();

    virtual bool appendArbParam(std::string name,
                                ArbParam_t  value);

    virtual bool appendArbParamPtr(std::string name,
                                   ArbParam_t* value);

    virtual bool appendArray(std::string name,
                             const void* data);

    template<typename T>
    bool appendArray(std::string name,
                     const T*    data);

    template<typename T>
    bool appendArray(std::string           name,
                     const std::vector<T>& data);

    virtual bool appendDouble(std::string name,
                              double      value);

    virtual bool appendDoublePtr(std::string name,
                                 double*     value);

    virtual bool appendFunction(std::string name,
                                const void* function);

    virtual bool appendInt(std::string name,
                           LgIndex_t   value);

    virtual bool appendSet(std::string name,
                           const Set&  set);

    virtual bool appendString(std::string name,
                              std::string value);

    virtual bool appendStringList(std::string       name,
                                  const StringList& stringList);

    virtual void clear();

    virtual ArgList_pa getRef() const;
private:
    ArgList_pa            m_argList;
    std::list<StringList> m_stringLists;
    std::list<Set>        m_sets;

    ArgList(const ArgList&);
    ArgList& operator=(const ArgList&);
};

template<typename T>
bool ArgList::appendArray(std::string name,
                          const T*    data)
{
    REQUIRE(!name.empty());
    REQUIRE(VALID_REF(data));

    Boolean_t result = TecUtilArgListAppendArray(m_argList,
                                                 name.c_str(),
                                                 reinterpret_cast<const void*>(data));

    ENSURE(VALID_BOOLEAN(result));
    return (result == TRUE);
}

template<typename T>
bool ArgList::appendArray(std::string           name,
                          const std::vector<T>& data)
{
    REQUIRE(!name.empty());
    REQUIRE(!data.empty());

    Boolean_t result = TecUtilArgListAppendArray(m_argList,
                                                 name.c_str(),
                                                 reinterpret_cast<const void*>(&data[0]));

    ENSURE(VALID_BOOLEAN(result));
    return (result == TRUE);
}

}
}

#endif

---