AuxData.h

Go to the documentation of this file.

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

#if defined MSWIN
#pragma once
#endif

#include <string>
#include "tptoolbox.h"

namespace tecplot
{
namespace toolbox
{

class Set;

class TPTOOLBOX_DLLAPI AuxData
{
public:
    AuxData(const AuxDataLocation_e auxDataLocation,
            const EntIndex_t        zoneOrMapOrVariable = 1);
    virtual ~AuxData();

    virtual bool isValid() const;

    virtual AuxData_pa getRef() const;

    virtual bool set(std::string name,
                     const char* value,
                     bool        retain = true) const;
    virtual inline bool set(std::string name,
                            std::string value,
                            bool        retain = true) const
    {
        return set(name, value.c_str(), retain);
    }

    virtual bool set(std::string name,
                     LgIndex_t   value,
                     bool        retain = true) const;

    virtual bool set(std::string name,
                     double      value,
                     bool        retain = true) const;

    virtual bool set(std::string name,
                     bool        value,
                     bool        retain = true) const;

    virtual bool set(std::string name,
                     const Set&  value,
                     bool        retain = true) const;

    template <typename T>
    inline bool get(std::string name,
                    T*          value,
                    bool*       retain = NULL) const
    {
        REQUIRE(VALID_NON_ZERO_LEN_STR(name.c_str()));
        REQUIRE(VALID_REF(value));
        REQUIRE(VALID_REF_OR_NULL(retain));
        // NOTE: It would be more efficient to call TecUtilAuxDataGetItemByName()
        //       directly, but by going through these calls we consolodate
        //       code into one location, everything goes through getItemByIndex().
        //
        //       Even though we have an inefficiency here, the probability that
        //       getting auxdata is a bottleneck is pretty slim.
        LgIndex_t index;
        bool result = getIndex(name, &index);
        if (result)
            get(index,
                value,
                NULL, // name
                retain);
        return result;
    }

    virtual void get(LgIndex_t    index,
                     std::string* value,
                     std::string* name   = NULL,
                     bool*        retain = NULL) const;

    virtual void get(LgIndex_t    index,
                     LgIndex_t*   value,
                     std::string* name   = NULL,
                     bool*        retain = NULL) const;

    virtual void get(LgIndex_t    index,
                     double*      value,
                     std::string* name   = NULL,
                     bool*        retain = NULL) const;

    virtual void get(LgIndex_t    index,
                     bool*        value,
                     std::string* name = NULL,
                     bool*        retain = NULL) const;

    virtual void get(LgIndex_t    index,
                     Set*         value,
                     std::string* name   = NULL,
                     bool*        retain = NULL) const;

    virtual void remove(LgIndex_t index) const;

    virtual bool remove(std::string name)  const;

    virtual bool getIndex(std::string name,
                          LgIndex_t*  index) const;

    virtual LgIndex_t size() const;

    AuxDataLocation_e getAuxDataLocation() const
    {
        return m_auxDataLocation;
    }

    EntIndex_t getZoneOrMapOrVarIndex() const
    {
        return m_zoneOrMapOrVar;
    }

private:
    AuxData& operator=(const AuxData&);

private:
    const AuxDataLocation_e m_auxDataLocation;
    const EntIndex_t        m_zoneOrMapOrVar;
};

}
}

#endif

---