/*****************************************************************************
*
* Copyright (c) 2000 - 2010, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-400124
* All rights reserved.
*
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
* 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
*    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
*    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
* 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
* 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.
*
*****************************************************************************/

#ifndef STATUSATTRIBUTES_H
#define STATUSATTRIBUTES_H
#include <state_exports.h>
#include <string>
#include <AttributeSubject.h>

// ****************************************************************************
// Class: StatusAttributes
//
// Purpose:
//    This class contains the status that is displayed in the GUI's status bar.
//
// Notes:      Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

class STATE_API StatusAttributes : public AttributeSubject
{
public:
    static const int DEFAULT_DURATION;

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

    virtual StatusAttributes& operator = (const StatusAttributes &obj);
    virtual bool operator == (const StatusAttributes &obj) const;
    virtual bool operator != (const StatusAttributes &obj) const;

    virtual const std::string TypeName() const;
    virtual bool CopyAttributes(const AttributeGroup *);
    virtual AttributeSubject *CreateCompatible(const std::string &) const;
    virtual AttributeSubject *NewInstance(bool) const;

    // Property selection methods
    virtual void SelectAll();
    void SelectSender();
    void SelectStatusMessage();
    void SelectUnicode();
    void SelectCurrentStageName();

    // Property setting methods
    void SetSender(const std::string &sender_);
    void SetClearStatus(bool clearStatus_);
    void SetStatusMessage(const std::string &statusMessage_);
    void SetUnicode(const unsignedCharVector &unicode_);
    void SetHasUnicode(bool hasUnicode_);
    void SetPercent(int percent_);
    void SetCurrentStage(int currentStage_);
    void SetCurrentStageName(const std::string &currentStageName_);
    void SetMaxStage(int maxStage_);
    void SetMessageType(int messageType_);
    void SetDuration(int duration_);

    // Property getting methods
    const std::string        &GetSender() const;
          std::string        &GetSender();
    bool                     GetClearStatus() const;
    const std::string        &GetStatusMessage() const;
          std::string        &GetStatusMessage();
    const unsignedCharVector &GetUnicode() const;
          unsignedCharVector &GetUnicode();
    bool                     GetHasUnicode() const;
    int                      GetPercent() const;
    int                      GetCurrentStage() const;
    const std::string        &GetCurrentStageName() const;
          std::string        &GetCurrentStageName();
    int                      GetMaxStage() const;
    int                      GetMessageType() const;
    int                      GetDuration() const;

    // Persistence methods
    virtual bool CreateNode(DataNode *node, bool completeSave, bool forceAdd);
    virtual void SetFromNode(DataNode *node);


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


    // IDs that can be used to identify fields in case statements
    enum {
        ID_sender = 0,
        ID_clearStatus,
        ID_statusMessage,
        ID_unicode,
        ID_hasUnicode,
        ID_percent,
        ID_currentStage,
        ID_currentStageName,
        ID_maxStage,
        ID_messageType,
        ID_duration
    };

private:
    std::string        sender;
    bool               clearStatus;
    std::string        statusMessage;
    unsignedCharVector unicode;
    bool               hasUnicode;
    int                percent;
    int                currentStage;
    std::string        currentStageName;
    int                maxStage;
    int                messageType;
    int                duration;

    // Static class format string for type map.
    static const char *TypeMapFormatString;
};

#endif
