---

exotkParameter_Enumeration.cxx

Go to the documentation of this file.

//   exotkParameter_Enumeration.cxx
//    Copyright (C) 2001  Stephane Routelous
//
//    This file is part of exoTK.
//
//    exoTK is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    exoTK is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with exoTK; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#include <exotkParameter_Enumeration.hxx>
#include <stdlib.h>
#ifndef _Standard_TypeDef_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef  _exotkUtils_HeaderFile
#include <exotkUtils.hxx>
#endif

//
IMPLEMENT_STANDARD_HANDLE(exotkParameter_Enumeration,exotkParameter_Root)
IMPLEMENT_STANDARD_RTTI(exotkParameter_Enumeration,exotkParameter_Root)
//
// Foreach ancestors, we add a IMPLEMENT_STANDARD_SUPERTYPE and 
// a IMPLEMENT_STANDARD_SUPERTYPE_ARRAY_ENTRY macro.
// We must respect the order: from the direct ancestor class
// to the base class.
//

IMPLEMENT_STANDARD_TYPE(exotkParameter_Enumeration)
IMPLEMENT_STANDARD_SUPERTYPE(exotkParameter_Root) 
IMPLEMENT_STANDARD_SUPERTYPE(MMgt_TShared) 
IMPLEMENT_STANDARD_SUPERTYPE(Standard_Transient)
IMPLEMENT_STANDARD_SUPERTYPE_ARRAY()
IMPLEMENT_STANDARD_SUPERTYPE_ARRAY_ENTRY(exotkParameter_Root)
IMPLEMENT_STANDARD_SUPERTYPE_ARRAY_ENTRY(MMgt_TShared)
IMPLEMENT_STANDARD_SUPERTYPE_ARRAY_ENTRY(Standard_Transient)
IMPLEMENT_STANDARD_SUPERTYPE_ARRAY_END()
IMPLEMENT_STANDARD_TYPE_END(exotkParameter_Enumeration)


//==================================================================================
// Function name        : exotkParameter_Enumeration::exotkParameter_Enumeration
//==================================================================================
// Written by       : Stephane Routelous - 08/03/2001 01:02:06
// Description      : 
// Return type          : 
//==================================================================================
// Argument         : const Standard_Integer aValue
exotkParameter_Enumeration::exotkParameter_Enumeration(const Standard_Integer aValue)
:myValue(aValue)
{
        myType = exotkParameter_Type_Enumeration;
}


//==================================================================================
// Function name        : exotkParameter_Enumeration::~exotkParameter_Enumeration
//==================================================================================
// Written by       : Stephane Routelous - 08/03/2001 01:02:08
// Description      : 
// Return type          : 
//==================================================================================
exotkParameter_Enumeration::~exotkParameter_Enumeration()
{

}

//==================================================================================
// Function name        : exotkParameter_Enumeration::DeepCopy
//==================================================================================
// Written by       : Stephane Routelous - 16/04/2001 21:49:12
// Description      : 
// Return type          : void 
//==================================================================================
// Argument         : const Handle_exotkParameter_Root &aParameterToCopy
void exotkParameter_Enumeration::DeepCopy(const Handle_exotkParameter_Root &aParameterToCopy)
{
        exotkParameter_Root::DeepCopy(aParameterToCopy);
        if ( aParameterToCopy->IsKind(STANDARD_TYPE(exotkParameter_Enumeration)) )
        {
                Handle_exotkParameter_Enumeration theEnumToCopy = Handle_exotkParameter_Enumeration::DownCast(aParameterToCopy);
                myValue = theEnumToCopy->Value();

                //copy the enumeration members
                myMapIntegerAsciiString.Clear();
                for ( theEnumToCopy->EnumInit() ; theEnumToCopy->EnumMore() ; theEnumToCopy->EnumNext())
                {
                        myMapIntegerAsciiString.Bind(theEnumToCopy->EnumCurrentIndex(),theEnumToCopy->EnumCurrentName());
                }
        }
}


//==================================================================================
// Function name        : exotkParameter_Enumeration::SetValue
//==================================================================================
// Written by       : Stephane Routelous - 08/03/2001 01:02:11
// Description      : 
// Return type          : Standard_Boolean 
//==================================================================================
// Argument         : const Standard_Integer aValue
Standard_Boolean exotkParameter_Enumeration::SetValue(const Standard_Integer aValue)
{

        if ( myMapIntegerAsciiString.IsBound1(aValue) )
        {
                myValue = aValue;
                return Standard_True;
        }
        else
                return Standard_False;
}

//==================================================================================
// Function name        : exotkParameter_Enumeration::Value
//==================================================================================
// Written by       : Stephane Routelous - 08/03/2001 01:02:13
// Description      : 
// Return type          : Standard_Integer 
//==================================================================================
Standard_Integer exotkParameter_Enumeration::Value() const
{
        return myValue;
}

//==================================================================================
// Function name        : exotkParameter_Enumeration::SetParameterAsString
//==================================================================================
// Written by       : Stephane Routelous - 08/03/2001 01:02:17
// Description      : 
// Return type          : Standard_Boolean 
//==================================================================================
// Argument         : const TCollection_AsciiString& aParameter
Standard_Boolean exotkParameter_Enumeration::SetParameterAsString(const TCollection_AsciiString& aParameter)
{
        Standard_Boolean theIsSuccess = Standard_False;
        Standard_Integer theIntegerValue;
        //try with an integer value
        if ( exotkUtils::AsciiStringToInteger(aParameter,theIntegerValue) )
        {
                theIsSuccess = SetValue(theIntegerValue);
        }
        else
        {
                TCollection_AsciiString theParameterAsString = aParameter;
                theParameterAsString.LowerCase();
                //it is not an integer value ; try with the name
                exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString theIter;
                Standard_Boolean theNameIsFound = Standard_False;
                for ( theIter.Initialize(myMapIntegerAsciiString);theIter.More() && (!theNameIsFound );theIter.Next() )
                {
                        TCollection_AsciiString theNameLowerCase = theIter.Key2();
                        theNameLowerCase.LowerCase();
                        if ( theParameterAsString == theNameLowerCase )
                        {
                                theIsSuccess = SetValue(theIter.Key1());
                                theNameIsFound = Standard_True;
                        }
                }
        }
        return theIsSuccess;
}

//==================================================================================
// Function name        : exotkParameter_Enumeration::ParameterAsString
//==================================================================================
// Written by       : Stephane Routelous - 08/03/2001 01:02:18
// Description      : 
// Return type          : TCollection_AsciiString 
//==================================================================================
TCollection_AsciiString exotkParameter_Enumeration::ParameterAsString() const
{
        TCollection_AsciiString theParameterAsString ;
        if ( myMapIntegerAsciiString.IsBound1(myValue) )
        {
                theParameterAsString = myMapIntegerAsciiString.Find1(myValue);
        }
        else
        {
                theParameterAsString = TCollection_AsciiString(myValue);
        }
        return theParameterAsString;
}


//==================================================================================
// Function name        : exotkParameter_Enumeration::AddEnumerationMember
//==================================================================================
// Written by       : Stephane Routelous - 08/03/2001 01:02:24
// Description      : 
// Return type          : Standard_Boolean 
//==================================================================================
// Argument         : const Standard_Integer anIndex
// Argument         : const TCollection_AsciiString &aName
Standard_Boolean exotkParameter_Enumeration::AddEnumerationMember(const Standard_Integer anIndex, const TCollection_AsciiString &aName)
{
        if ( !myMapIntegerAsciiString.IsBound1(anIndex) )
        {
                if ( !myMapIntegerAsciiString.IsBound2(aName) )
                {
                        myMapIntegerAsciiString.Bind(anIndex,aName);
                        return Standard_True;
                }
        }
        return Standard_False;
}

//==================================================================================
// Function name        : exotkParameter_Enumeration::EnumerationMember
//==================================================================================
// Written by       : Stephane Routelous - 08/03/2001 01:02:26
// Description      : 
// Return type          : Standard_Boolean 
//==================================================================================
// Argument         : const Standard_Integer anIndex
// Argument         : TCollection_AsciiString& aName
Standard_Boolean exotkParameter_Enumeration::EnumerationMember(const Standard_Integer anIndex,TCollection_AsciiString& aName) const
{
        if ( myMapIntegerAsciiString.IsBound1(anIndex) )
        {
                aName = myMapIntegerAsciiString.Find1(anIndex);
                return Standard_True;
        }
        return Standard_False;
}

//==================================================================================
// Function name        : exotkParameter_Enumeration::Dump
//==================================================================================
// Written by       : Stephane Routelous - 08/03/2001 01:02:31
// Description      : 
// Return type          : Standard_OStream& 
//==================================================================================
// Argument         : Standard_OStream& anOS
Standard_OStream& exotkParameter_Enumeration::Dump(Standard_OStream& anOS) const
{
        exotkParameter_Root::Dump(anOS);
        exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString theIter;
        for ( theIter.Initialize(myMapIntegerAsciiString);theIter.More();theIter.Next() )
        {
                anOS  << "\t index:" << theIter.Key1() << " Name=" << theIter.Key2().ToCString()<< endl;
        }
        return anOS;
}


//==================================================================================
// Function name        : exotkParameter_Enumeration::EnumInit
//==================================================================================
// Written by       : Stephane Routelous - 16/04/2001 21:48:44
// Description      : 
// Return type          : void 
//==================================================================================
void exotkParameter_Enumeration::EnumInit()
{
        myMapIterator.Initialize(myMapIntegerAsciiString);
}

//==================================================================================
// Function name        : exotkParameter_Enumeration::EnumMore
//==================================================================================
// Written by       : Stephane Routelous - 16/04/2001 21:48:47
// Description      : 
// Return type          : Standard_Boolean 
//==================================================================================
Standard_Boolean exotkParameter_Enumeration::EnumMore()
{
        return myMapIterator.More();
}

//==================================================================================
// Function name        : exotkParameter_Enumeration::EnumNext
//==================================================================================
// Written by       : Stephane Routelous - 16/04/2001 21:48:50
// Description      : 
// Return type          : void 
//==================================================================================
void exotkParameter_Enumeration::EnumNext()
{
        myMapIterator.Next();
}

//==================================================================================
// Function name        : exotkParameter_Enumeration::EnumCurrentIndex
//==================================================================================
// Written by       : Stephane Routelous - 16/04/2001 21:48:53
// Description      : 
// Return type          : Standard_Integer 
//==================================================================================
Standard_Integer exotkParameter_Enumeration::EnumCurrentIndex()
{
        return myMapIterator.Key1();
}

//==================================================================================
// Function name        : exotkParameter_Enumeration::EnumCurrentName
//==================================================================================
// Written by       : Stephane Routelous - 16/04/2001 21:48:56
// Description      : 
// Return type          : TCollection_AsciiString 
//==================================================================================
TCollection_AsciiString exotkParameter_Enumeration::EnumCurrentName()
{
        return myMapIterator.Key2();
}

---