secondo/Algebras/Tile/Properties/Propertiesstring.cpp

/*
This file is part of SECONDO.

Copyright (C) 2013, University in Hagen, Department of Computer Science,
Database Systems for New Applications.

SECONDO 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.

SECONDO 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 SECONDO; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/

/*
TileAlgebra includes

*/

#include "Propertiesstring.h"

/*
declaration of namespace TileAlgebra

*/

namespace TileAlgebra
{

/*
Method GetUndefinedValue returns the undefined value of base datatype string.

author: Dirk Zacher
parameters: -
return value: undefined value of base datatype string
exceptions: -

*/

std::string Properties<std::string>::GetUndefinedValue()
{
  return UNDEFINED_STRING;
}

/*
Method GetValue returns the value of given NList representation.

author: Dirk Zacher
parameters: rNList - reference to a NList object
return value: value of given NList representation
exceptions: -

*/

std::string Properties<std::string>::GetValue(const NList& rNList)
{
  return rNList.str();
}

/*
Method GetUnwrappedValue returns the unwrapped value of given wrapped value.

author: Dirk Zacher
parameters: rWrappedValue - reference to a wrapped value
return value: unwrapped value
exceptions: -

*/

std::string Properties<std::string>::GetUnwrappedValue(const CcString&
                                                       rWrappedValue)
{
  std::string unwrappedValue = GetUndefinedValue();

  if(rWrappedValue.IsDefined())
  {
    unwrappedValue = rWrappedValue.GetValue();
  }

  return unwrappedValue;
}

/*
Method GetWrappedValue returns the wrapped value of given value.

author: Dirk Zacher
parameters: rValue - reference to a value
return value: wrapped value
exceptions: -

*/

CcString Properties<std::string>::GetWrappedValue(const std::string& rValue)
{
  return CcString(!IsUndefinedValue(rValue), rValue);
}

/*
Method IsUndefinedValue checks if given value is an undefined value.

author: Dirk Zacher
parameters: rValue - reference to a value
return value: true, if rValue is an undefined value, otherwise false
exceptions: -

*/

bool Properties<std::string>::IsUndefinedValue(const std::string& rValue)
{
  bool bUndefinedValue = false;
  
  if(rValue == GetUndefinedValue())
  {
    bUndefinedValue = true;
  }

  return bUndefinedValue;
}

/*
Method IsValidValueType checks if given NList is NList of type string.

author: Dirk Zacher
parameters: rNList - reference to a NList object
return value: true, if given NList is NList of type string, otherwise false
exceptions: -

*/

bool Properties<std::string>::IsValidValueType(const NList& rNList)
{
  bool bValidValueType = rNList.isString();

  return bValidValueType;
}

/*
Method ToNList returns NList representation of given value.

author: Dirk Zacher
parameters: rValue - reference to a value
return value: NList representation of given value
exceptions: -

*/

NList Properties<std::string>::ToNList(const std::string& rValue)
{
  NList nList = NList(Symbol::UNDEFINED());

  if(IsUndefinedValue(rValue) == false)
  {
    nList = NList(rValue, true);
  }

  return nList;
}

}