MessageAttributes.h 5.09 KB
Newer Older
hrchilds's avatar
hrchilds committed
1
2
/*****************************************************************************
*
brugger's avatar
 
brugger committed
3
* Copyright (c) 2000 - 2008, 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-400142
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
41
42
43
44
45
46
47
48
49
50
51
52
53
#ifndef MESSAGEATTRIBUTES_H
#define MESSAGEATTRIBUTES_H
#include <state_exports.h>
#include <string>
#include <AttributeSubject.h>

// ****************************************************************************
// Class: MessageAttributes
//
// Purpose:
//    This class contains attributes for sending messages.
//
// Notes:      Autogenerated by xml2atts.
//
// Programmer: xml2atts
54
// Creation:   omitted
hrchilds's avatar
hrchilds committed
55
56
57
58
59
60
61
62
63
64
65
66
//
// Modifications:
//   
// ****************************************************************************

class STATE_API MessageAttributes : public AttributeSubject
{
public:
    enum Severity
    {
        Error,
        Warning,
hrchilds's avatar
hrchilds committed
67
        Message,
whitlocb's avatar
whitlocb committed
68
69
        ErrorClear,
        Information
hrchilds's avatar
hrchilds committed
70
71
72
73
74
75
    };

    MessageAttributes();
    MessageAttributes(const MessageAttributes &obj);
    virtual ~MessageAttributes();

hrchilds's avatar
hrchilds committed
76
    virtual MessageAttributes& operator = (const MessageAttributes &obj);
hrchilds's avatar
hrchilds committed
77
78
79
80
81
82
    virtual bool operator == (const MessageAttributes &obj) const;
    virtual bool operator != (const MessageAttributes &obj) const;

    virtual const std::string TypeName() const;
    virtual bool CopyAttributes(const AttributeGroup *);
    virtual AttributeSubject *CreateCompatible(const std::string &) const;
hrchilds's avatar
hrchilds committed
83
    virtual AttributeSubject *NewInstance(bool) const;
hrchilds's avatar
hrchilds committed
84
85
86
87

    // Property selection methods
    virtual void SelectAll();
    void SelectText();
88
    void SelectUnicode();
hrchilds's avatar
hrchilds committed
89
90
91

    // Property setting methods
    void SetText(const std::string &text_);
92
93
    void SetUnicode(const unsignedCharVector &unicode_);
    void SetHasUnicode(bool hasUnicode_);
hrchilds's avatar
hrchilds committed
94
95
96
    void SetSeverity(Severity severity_);

    // Property getting methods
97
98
99
100
101
102
    const std::string        &GetText() const;
          std::string        &GetText();
    const unsignedCharVector &GetUnicode() const;
          unsignedCharVector &GetUnicode();
    bool                     GetHasUnicode() const;
    Severity                 GetSeverity() const;
hrchilds's avatar
hrchilds committed
103
104

    // Persistence methods
hrchilds's avatar
hrchilds committed
105
    virtual bool CreateNode(DataNode *node, bool completeSave, bool forceAdd);
hrchilds's avatar
hrchilds committed
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
    virtual void SetFromNode(DataNode *node);

    // Enum conversion functions
    static std::string Severity_ToString(Severity);
    static bool Severity_FromString(const std::string &, Severity &);
protected:
    static std::string Severity_ToString(int);
public:

    // 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;

whitlocb's avatar
whitlocb committed
121
122
123
124

    // IDs that can be used to identify fields in case statements
    enum {
        ID_text = 0,
125
126
        ID_unicode,
        ID_hasUnicode,
whitlocb's avatar
whitlocb committed
127
128
129
        ID_severity
    };

hrchilds's avatar
hrchilds committed
130
private:
131
132
133
134
    std::string        text;
    unsignedCharVector unicode;
    bool               hasUnicode;
    int                severity;
whitlocb's avatar
whitlocb committed
135
136
137

    // Static class format string for type map.
    static const char *TypeMapFormatString;
hrchilds's avatar
hrchilds committed
138
139
140
};

#endif