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

#ifndef RECORD_H
#define RECORD_H

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

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

#ifndef POSET_SCAFFOLD_H
#include "SheafSystem/poset_scaffold.h"
#endif

#include "SheafSystem/record_index.h"

namespace sheaf 
{

class data_type_map;
class poset_data_type_map;
  
class SHEAF_DLL_SPEC record : public any
{
public:

  // CANONICAL MEMBERS

  record(const record& xother);

  virtual record* clone() const;

  virtual ~record();

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

  // RECORD INTERFACE

  record(const poset_scaffold& xscaffold);

  

  inline record_index external_index() const
  {
    return _index;
  };

  inline void put_external_index(const record_index& xindex)
  {
    _index = xindex;
  };

  

  inline poset_scaffold& scaffold()
  {
    return _scaffold;
  };

  inline const poset_scaffold& scaffold() const
  {
    return _scaffold;
  };

  

  inline poset_data_type_map& type_map()
  {
    return scaffold().type_map();
  };

  inline const poset_data_type_map& type_map() const
  {
    return scaffold().type_map();
  };

protected:

  // Default constructor.
  // Default construction prohibited because scaffold must be initialized
  //  inline record() {} ;


private:

  // The external index of this record.

  record_index _index;

  // The scaffold for the poset associated with this record.

  poset_scaffold& _scaffold;

};

} // namespace sheaf

#endif // ifndef RECORD_H