InverseGhostZoneAttributes.h 5.16 KB
Newer Older
hrchilds's avatar
hrchilds committed
1 2
/*****************************************************************************
*
brugger's avatar
 
brugger committed
3
* Copyright (c) 2000 - 2010, Lawrence Livermore National Security, LLC
hrchilds's avatar
hrchilds committed
4
* Produced at the Lawrence Livermore National Laboratory
brugger's avatar
 
brugger committed
5
* LLNL-CODE-400124
hrchilds's avatar
hrchilds committed
6 7
* All rights reserved.
*
brugger's avatar
 
brugger committed
8
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
hrchilds's avatar
hrchilds committed
9 10 11 12 13 14 15 16 17 18
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution  and  use  in  source  and  binary  forms,  with  or  without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of  source code must  retain the above  copyright notice,
*    this list of conditions and the disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
brugger's avatar
 
brugger committed
19 20 21
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL nor the names of  its contributors may
*    be used to endorse or promote products derived from this software without
hrchilds's avatar
hrchilds committed
22 23 24 25 26
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
brugger's avatar
 
brugger committed
27 28 29
* ARE  DISCLAIMED. IN  NO EVENT  SHALL LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  OR  CONTRIBUTORS BE  LIABLE  FOR  ANY
* DIRECT,  INDIRECT,   INCIDENTAL,   SPECIAL,   EXEMPLARY,  OR   CONSEQUENTIAL
hrchilds's avatar
hrchilds committed
30 31 32 33 34 35 36 37 38
* DAMAGES (INCLUDING, BUT NOT  LIMITED TO, PROCUREMENT OF  SUBSTITUTE GOODS OR
* SERVICES; LOSS OF  USE, DATA, OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER
* CAUSED  AND  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT
* LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY  WAY
* OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/

hrchilds's avatar
hrchilds committed
39 40
#ifndef INVERSEGHOSTZONEATTRIBUTES_H
#define INVERSEGHOSTZONEATTRIBUTES_H
hrchilds's avatar
hrchilds committed
41
#include <string>
hrchilds's avatar
hrchilds committed
42 43
#include <AttributeSubject.h>

44

hrchilds's avatar
hrchilds committed
45 46 47 48 49 50 51 52 53
// ****************************************************************************
// Class: InverseGhostZoneAttributes
//
// Purpose:
//    This class contains attributes for the inverse ghost zone operator.
//
// Notes:      Autogenerated by xml2atts.
//
// Programmer: xml2atts
54
// Creation:   omitted
hrchilds's avatar
hrchilds committed
55 56 57 58 59 60 61 62
//
// Modifications:
//   
// ****************************************************************************

class InverseGhostZoneAttributes : public AttributeSubject
{
public:
hrchilds's avatar
hrchilds committed
63 64 65 66 67 68
    enum ShowType
    {
        GhostZonesOnly,
        GhostZonesAndRealZones
    };

69
    // These constructors are for objects of this class
hrchilds's avatar
hrchilds committed
70 71
    InverseGhostZoneAttributes();
    InverseGhostZoneAttributes(const InverseGhostZoneAttributes &obj);
72 73 74 75 76
protected:
    // These constructors are for objects derived from this class
    InverseGhostZoneAttributes(private_tmfs_t tmfs);
    InverseGhostZoneAttributes(const InverseGhostZoneAttributes &obj, private_tmfs_t tmfs);
public:
hrchilds's avatar
hrchilds committed
77 78
    virtual ~InverseGhostZoneAttributes();

79
    virtual InverseGhostZoneAttributes& operator = (const InverseGhostZoneAttributes &obj);
hrchilds's avatar
hrchilds committed
80 81
    virtual bool operator == (const InverseGhostZoneAttributes &obj) const;
    virtual bool operator != (const InverseGhostZoneAttributes &obj) const;
82 83 84 85
private:
    void Init();
    void Copy(const InverseGhostZoneAttributes &obj);
public:
hrchilds's avatar
hrchilds committed
86 87 88 89

    virtual const std::string TypeName() const;
    virtual bool CopyAttributes(const AttributeGroup *);
    virtual AttributeSubject *CreateCompatible(const std::string &) const;
hrchilds's avatar
hrchilds committed
90
    virtual AttributeSubject *NewInstance(bool) const;
hrchilds's avatar
hrchilds committed
91 92 93 94 95

    // Property selection methods
    virtual void SelectAll();

    // Property setting methods
96
    void SetRequestGhostZones(bool requestGhostZones_);
hrchilds's avatar
hrchilds committed
97
    void SetShowType(ShowType showType_);
hrchilds's avatar
hrchilds committed
98 99

    // Property getting methods
100
    bool GetRequestGhostZones() const;
hrchilds's avatar
hrchilds committed
101
    ShowType GetShowType() const;
hrchilds's avatar
hrchilds committed
102 103

    // Persistence methods
104
    virtual bool CreateNode(DataNode *node, bool completeSave, bool forceAdd);
hrchilds's avatar
hrchilds committed
105 106
    virtual void SetFromNode(DataNode *node);

hrchilds's avatar
hrchilds committed
107 108 109 110 111 112
    // Enum conversion functions
    static std::string ShowType_ToString(ShowType);
    static bool ShowType_FromString(const std::string &, ShowType &);
protected:
    static std::string ShowType_ToString(int);
public:
hrchilds's avatar
hrchilds committed
113 114 115 116 117 118 119

    // Keyframing methods
    virtual std::string               GetFieldName(int index) const;
    virtual AttributeGroup::FieldType GetFieldType(int index) const;
    virtual std::string               GetFieldTypeName(int index) const;
    virtual bool                      FieldsEqual(int index, const AttributeGroup *rhs) const;

120 121 122

    // IDs that can be used to identify fields in case statements
    enum {
123 124 125
        ID_requestGhostZones = 0,
        ID_showType,
        ID__LAST
126 127
    };

hrchilds's avatar
hrchilds committed
128
private:
129 130
    bool requestGhostZones;
    int  showType;
131 132 133

    // Static class format string for type map.
    static const char *TypeMapFormatString;
134
    static const private_tmfs_t TmfsStruct;
hrchilds's avatar
hrchilds committed
135
};
136
#define INVERSEGHOSTZONEATTRIBUTES_TMFS "bi"
hrchilds's avatar
hrchilds committed
137 138

#endif