Property.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/Property.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS 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 PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) 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 __PCL_Property_h
#define __PCL_Property_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/PropertyDescription.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Property
{
public:
 
   using identifier_type = IsoString;
 
   using value_type = Variant;
 
   using data_type = value_type::data_type;
 
   Property() = default;
 
   Property( const Property& ) = default;
 
   Property( Property&& ) = default;
 
   Property( const identifier_type& identifier, const value_type& value )
      : m_id( identifier )
      , m_value( value )
   {
   }
 
   Property( const identifier_type& identifier )
      : m_id( identifier )
   {
   }
 
   Property& operator =( const Property& ) = default;
 
   Property& operator =( Property&& ) = default;
 
   virtual ~Property()
   {
   }
 
   const identifier_type& Identifier() const
   {
      return m_id;
   }
 
   const identifier_type& Id() const
   {
      return Identifier();
   }
 
   const value_type& Value() const
   {
      return m_value;
   }
 
   void SetValue( const value_type& value )
   {
      m_value = value;
   }
 
   data_type Type() const
   {
      return m_value.Type();
   }
 
   PropertyDescription Description() const
   {
      return PropertyDescription( m_id, m_value.Type() );
   }
 
   static bool IsValidIdentifier( const IsoString& id )
   {
      if ( id.IsEmpty() )
         return false;
      IsoStringList tokens;
      id.Break( tokens, ':' );
      for ( const IsoString& token : tokens )
         if ( !token.IsValidIdentifier() )
            return false;
      return true;
   }
 
   static bool IsValidIdentifier( const IsoString::ustring_base& id )
   {
      return IsValidIdentifier( IsoString( id ) );
   }
 
   bool IsValid() const
   {
      return IsValidIdentifier( m_id ) && m_value.IsValid();
   }
 
   bool operator ==( const Property& other ) const
   {
      return m_id == other.m_id;
   }
 
   bool operator <( const Property& other ) const
   {
      return m_id < other.m_id;
   }
 
protected:
 
   identifier_type m_id;
   value_type      m_value;
};
 
using PropertyArray = Array<Property>;
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_Property_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Property.h - Released 2024-01-13T15:47:58Z