schema_descriptor.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class schema_descriptor

#ifndef SCHEMA_DESCRIPTOR_H
#define SCHEMA_DESCRIPTOR_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

#ifndef PRIMITIVE_TYPE_H
#include "SheafSystem/primitive_type.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

namespace sheaf
{
  
class SHEAF_DLL_SPEC schema_descriptor : public any
{

public:

  // ===========================================================
  // ANY FACET
  // ===========================================================

  virtual bool is_ancestor_of(const any* other) const;

  virtual schema_descriptor* clone() const;

  // Assignment operator provided by compiler.

  bool operator==(const schema_descriptor& xother) const;

  virtual bool invariant() const;

  // ===========================================================
  // SCHEMA_DESCRIPTOR FACET
  // ===========================================================

  schema_descriptor();

  schema_descriptor(const schema_descriptor& xother);

  schema_descriptor(const std::string& xname,
                    primitive_type xtype = NOT_A_PRIMITIVE_TYPE,
                    bool xis_table_dof = true);

  virtual ~schema_descriptor();

  std::string name;

  primitive_type type;

  bool is_table_dof;

};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================


SHEAF_DLL_SPEC
std::ostream & operator << (std::ostream& os, const schema_descriptor& xsd);


SHEAF_DLL_SPEC
std::istream & operator >> (std::istream& is, schema_descriptor& xsd);

size_t
SHEAF_DLL_SPEC
deep_size(const schema_descriptor& xsd, bool xinclude_shallow = true);

 
} // namespace sheaf

#endif // ifndef SCHEMA_DESCRIPTOR_H