/*****************************************************************************
*
* Copyright (c) 2000 - 2018, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-442911
* 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.
*
*****************************************************************************/

#include <CoordSwapAttributes.h>
#include <DataNode.h>

//
// Enum conversion methods for CoordSwapAttributes::Coord
//

static const char *Coord_strings[] = {
"Coord1", "Coord2", "Coord3"
};

std::string
CoordSwapAttributes::Coord_ToString(CoordSwapAttributes::Coord t)
{
    int index = int(t);
    if(index < 0 || index >= 3) index = 0;
    return Coord_strings[index];
}

std::string
CoordSwapAttributes::Coord_ToString(int t)
{
    int index = (t < 0 || t >= 3) ? 0 : t;
    return Coord_strings[index];
}

bool
CoordSwapAttributes::Coord_FromString(const std::string &s, CoordSwapAttributes::Coord &val)
{
    val = CoordSwapAttributes::Coord1;
    for(int i = 0; i < 3; ++i)
    {
        if(s == Coord_strings[i])
        {
            val = (Coord)i;
            return true;
        }
    }
    return false;
}

// ****************************************************************************
// Method: CoordSwapAttributes::CoordSwapAttributes
//
// Purpose: 
//   Init utility for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

void CoordSwapAttributes::Init()
{
    newCoord1 = Coord1;
    newCoord2 = Coord2;
    newCoord3 = Coord3;

    CoordSwapAttributes::SelectAll();
}

// ****************************************************************************
// Method: CoordSwapAttributes::CoordSwapAttributes
//
// Purpose: 
//   Copy utility for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

void CoordSwapAttributes::Copy(const CoordSwapAttributes &obj)
{
    newCoord1 = obj.newCoord1;
    newCoord2 = obj.newCoord2;
    newCoord3 = obj.newCoord3;

    CoordSwapAttributes::SelectAll();
}

// Type map format string
const char *CoordSwapAttributes::TypeMapFormatString = COORDSWAPATTRIBUTES_TMFS;
const AttributeGroup::private_tmfs_t CoordSwapAttributes::TmfsStruct = {COORDSWAPATTRIBUTES_TMFS};


// ****************************************************************************
// Method: CoordSwapAttributes::CoordSwapAttributes
//
// Purpose: 
//   Default constructor for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

CoordSwapAttributes::CoordSwapAttributes() : 
    AttributeSubject(CoordSwapAttributes::TypeMapFormatString)
{
    CoordSwapAttributes::Init();
}

// ****************************************************************************
// Method: CoordSwapAttributes::CoordSwapAttributes
//
// Purpose: 
//   Constructor for the derived classes of CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

CoordSwapAttributes::CoordSwapAttributes(private_tmfs_t tmfs) : 
    AttributeSubject(tmfs.tmfs)
{
    CoordSwapAttributes::Init();
}

// ****************************************************************************
// Method: CoordSwapAttributes::CoordSwapAttributes
//
// Purpose: 
//   Copy constructor for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

CoordSwapAttributes::CoordSwapAttributes(const CoordSwapAttributes &obj) : 
    AttributeSubject(CoordSwapAttributes::TypeMapFormatString)
{
    CoordSwapAttributes::Copy(obj);
}

// ****************************************************************************
// Method: CoordSwapAttributes::CoordSwapAttributes
//
// Purpose: 
//   Copy constructor for derived classes of the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

CoordSwapAttributes::CoordSwapAttributes(const CoordSwapAttributes &obj, private_tmfs_t tmfs) : 
    AttributeSubject(tmfs.tmfs)
{
    CoordSwapAttributes::Copy(obj);
}

// ****************************************************************************
// Method: CoordSwapAttributes::~CoordSwapAttributes
//
// Purpose: 
//   Destructor for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

CoordSwapAttributes::~CoordSwapAttributes()
{
    // nothing here
}

// ****************************************************************************
// Method: CoordSwapAttributes::operator = 
//
// Purpose: 
//   Assignment operator for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

CoordSwapAttributes& 
CoordSwapAttributes::operator = (const CoordSwapAttributes &obj)
{
    if (this == &obj) return *this;

    CoordSwapAttributes::Copy(obj);

    return *this;
}

// ****************************************************************************
// Method: CoordSwapAttributes::operator == 
//
// Purpose: 
//   Comparison operator == for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

bool
CoordSwapAttributes::operator == (const CoordSwapAttributes &obj) const
{
    // Create the return value
    return ((newCoord1 == obj.newCoord1) &&
            (newCoord2 == obj.newCoord2) &&
            (newCoord3 == obj.newCoord3));
}

// ****************************************************************************
// Method: CoordSwapAttributes::operator != 
//
// Purpose: 
//   Comparison operator != for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

bool
CoordSwapAttributes::operator != (const CoordSwapAttributes &obj) const
{
    return !(this->operator == (obj));
}

// ****************************************************************************
// Method: CoordSwapAttributes::TypeName
//
// Purpose: 
//   Type name method for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

const std::string
CoordSwapAttributes::TypeName() const
{
    return "CoordSwapAttributes";
}

// ****************************************************************************
// Method: CoordSwapAttributes::CopyAttributes
//
// Purpose: 
//   CopyAttributes method for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

bool
CoordSwapAttributes::CopyAttributes(const AttributeGroup *atts)
{
    if(TypeName() != atts->TypeName())
        return false;

    // Call assignment operator.
    const CoordSwapAttributes *tmp = (const CoordSwapAttributes *)atts;
    *this = *tmp;

    return true;
}

// ****************************************************************************
// Method: CoordSwapAttributes::CreateCompatible
//
// Purpose: 
//   CreateCompatible method for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

AttributeSubject *
CoordSwapAttributes::CreateCompatible(const std::string &tname) const
{
    AttributeSubject *retval = 0;
    if(TypeName() == tname)
        retval = new CoordSwapAttributes(*this);
    // Other cases could go here too. 

    return retval;
}

// ****************************************************************************
// Method: CoordSwapAttributes::NewInstance
//
// Purpose: 
//   NewInstance method for the CoordSwapAttributes class.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

AttributeSubject *
CoordSwapAttributes::NewInstance(bool copy) const
{
    AttributeSubject *retval = 0;
    if(copy)
        retval = new CoordSwapAttributes(*this);
    else
        retval = new CoordSwapAttributes;

    return retval;
}

// ****************************************************************************
// Method: CoordSwapAttributes::SelectAll
//
// Purpose: 
//   Selects all attributes.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

void
CoordSwapAttributes::SelectAll()
{
    Select(ID_newCoord1, (void *)&newCoord1);
    Select(ID_newCoord2, (void *)&newCoord2);
    Select(ID_newCoord3, (void *)&newCoord3);
}

///////////////////////////////////////////////////////////////////////////////
// Persistence methods
///////////////////////////////////////////////////////////////////////////////

// ****************************************************************************
// Method: CoordSwapAttributes::CreateNode
//
// Purpose: 
//   This method creates a DataNode representation of the object so it can be saved to a config file.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

bool
CoordSwapAttributes::CreateNode(DataNode *parentNode, bool completeSave, bool forceAdd)
{
    if(parentNode == 0)
        return false;

    CoordSwapAttributes defaultObject;
    bool addToParent = false;
    // Create a node for CoordSwapAttributes.
    DataNode *node = new DataNode("CoordSwapAttributes");

    if(completeSave || !FieldsEqual(ID_newCoord1, &defaultObject))
    {
        addToParent = true;
        node->AddNode(new DataNode("newCoord1", Coord_ToString(newCoord1)));
    }

    if(completeSave || !FieldsEqual(ID_newCoord2, &defaultObject))
    {
        addToParent = true;
        node->AddNode(new DataNode("newCoord2", Coord_ToString(newCoord2)));
    }

    if(completeSave || !FieldsEqual(ID_newCoord3, &defaultObject))
    {
        addToParent = true;
        node->AddNode(new DataNode("newCoord3", Coord_ToString(newCoord3)));
    }


    // Add the node to the parent node.
    if(addToParent || forceAdd)
        parentNode->AddNode(node);
    else
        delete node;

    return (addToParent || forceAdd);
}

// ****************************************************************************
// Method: CoordSwapAttributes::SetFromNode
//
// Purpose: 
//   This method sets attributes in this object from values in a DataNode representation of the object.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

void
CoordSwapAttributes::SetFromNode(DataNode *parentNode)
{
    if(parentNode == 0)
        return;

    DataNode *searchNode = parentNode->GetNode("CoordSwapAttributes");
    if(searchNode == 0)
        return;

    DataNode *node;
    if((node = searchNode->GetNode("newCoord1")) != 0)
    {
        // Allow enums to be int or string in the config file
        if(node->GetNodeType() == INT_NODE)
        {
            int ival = node->AsInt();
            if(ival >= 0 && ival < 3)
                SetNewCoord1(Coord(ival));
        }
        else if(node->GetNodeType() == STRING_NODE)
        {
            Coord value;
            if(Coord_FromString(node->AsString(), value))
                SetNewCoord1(value);
        }
    }
    if((node = searchNode->GetNode("newCoord2")) != 0)
    {
        // Allow enums to be int or string in the config file
        if(node->GetNodeType() == INT_NODE)
        {
            int ival = node->AsInt();
            if(ival >= 0 && ival < 3)
                SetNewCoord2(Coord(ival));
        }
        else if(node->GetNodeType() == STRING_NODE)
        {
            Coord value;
            if(Coord_FromString(node->AsString(), value))
                SetNewCoord2(value);
        }
    }
    if((node = searchNode->GetNode("newCoord3")) != 0)
    {
        // Allow enums to be int or string in the config file
        if(node->GetNodeType() == INT_NODE)
        {
            int ival = node->AsInt();
            if(ival >= 0 && ival < 3)
                SetNewCoord3(Coord(ival));
        }
        else if(node->GetNodeType() == STRING_NODE)
        {
            Coord value;
            if(Coord_FromString(node->AsString(), value))
                SetNewCoord3(value);
        }
    }
}

///////////////////////////////////////////////////////////////////////////////
// Set property methods
///////////////////////////////////////////////////////////////////////////////

void
CoordSwapAttributes::SetNewCoord1(CoordSwapAttributes::Coord newCoord1_)
{
    newCoord1 = newCoord1_;
    Select(ID_newCoord1, (void *)&newCoord1);
}

void
CoordSwapAttributes::SetNewCoord2(CoordSwapAttributes::Coord newCoord2_)
{
    newCoord2 = newCoord2_;
    Select(ID_newCoord2, (void *)&newCoord2);
}

void
CoordSwapAttributes::SetNewCoord3(CoordSwapAttributes::Coord newCoord3_)
{
    newCoord3 = newCoord3_;
    Select(ID_newCoord3, (void *)&newCoord3);
}

///////////////////////////////////////////////////////////////////////////////
// Get property methods
///////////////////////////////////////////////////////////////////////////////

CoordSwapAttributes::Coord
CoordSwapAttributes::GetNewCoord1() const
{
    return Coord(newCoord1);
}

CoordSwapAttributes::Coord
CoordSwapAttributes::GetNewCoord2() const
{
    return Coord(newCoord2);
}

CoordSwapAttributes::Coord
CoordSwapAttributes::GetNewCoord3() const
{
    return Coord(newCoord3);
}

///////////////////////////////////////////////////////////////////////////////
// Keyframing methods
///////////////////////////////////////////////////////////////////////////////

// ****************************************************************************
// Method: CoordSwapAttributes::GetFieldName
//
// Purpose: 
//   This method returns the name of a field given its index.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

std::string
CoordSwapAttributes::GetFieldName(int index) const
{
    switch (index)
    {
    case ID_newCoord1: return "newCoord1";
    case ID_newCoord2: return "newCoord2";
    case ID_newCoord3: return "newCoord3";
    default:  return "invalid index";
    }
}

// ****************************************************************************
// Method: CoordSwapAttributes::GetFieldType
//
// Purpose: 
//   This method returns the type of a field given its index.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

AttributeGroup::FieldType
CoordSwapAttributes::GetFieldType(int index) const
{
    switch (index)
    {
    case ID_newCoord1: return FieldType_enum;
    case ID_newCoord2: return FieldType_enum;
    case ID_newCoord3: return FieldType_enum;
    default:  return FieldType_unknown;
    }
}

// ****************************************************************************
// Method: CoordSwapAttributes::GetFieldTypeName
//
// Purpose: 
//   This method returns the name of a field type given its index.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

std::string
CoordSwapAttributes::GetFieldTypeName(int index) const
{
    switch (index)
    {
    case ID_newCoord1: return "enum";
    case ID_newCoord2: return "enum";
    case ID_newCoord3: return "enum";
    default:  return "invalid index";
    }
}

// ****************************************************************************
// Method: CoordSwapAttributes::FieldsEqual
//
// Purpose: 
//   This method compares two fields and return true if they are equal.
//
// Note:       Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

bool
CoordSwapAttributes::FieldsEqual(int index_, const AttributeGroup *rhs) const
{
    const CoordSwapAttributes &obj = *((const CoordSwapAttributes*)rhs);
    bool retval = false;
    switch (index_)
    {
    case ID_newCoord1:
        {  // new scope
        retval = (newCoord1 == obj.newCoord1);
        }
        break;
    case ID_newCoord2:
        {  // new scope
        retval = (newCoord2 == obj.newCoord2);
        }
        break;
    case ID_newCoord3:
        {  // new scope
        retval = (newCoord3 == obj.newCoord3);
        }
        break;
    default: retval = false;
    }

    return retval;
}

///////////////////////////////////////////////////////////////////////////////
// User-defined methods.
///////////////////////////////////////////////////////////////////////////////

