st3.h

Go to the documentation of this file.

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


#ifndef ST3_H
#define ST3_H

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

#ifndef STP_H
#include "SheafSystem/stp.h"
#endif

namespace fiber_bundle
{

//==============================================================================
// CLASS ST3_LITE
//==============================================================================

class SHEAF_DLL_SPEC st3_lite : public stp_lite
{
  //===========================================================================
  //===========================================================================

public:

  st3_lite();

  st3_lite(const st3_lite& xother);

  st3_lite& operator=(const st3_lite& xother);

  virtual ~st3_lite();

  st3_lite(const row_dofs_type& xrow_dofs);

  st3_lite& operator=(const row_dofs_type& xrow_dofs);


  using stp_lite::component;
  using stp_lite::put_component;
  
  virtual value_type component(int xi, int xj, int xk) const;

  virtual void put_component(int xi, int xj, int xk, value_type xvalue);

  virtual int index_for_ijk(int xi, int xj, int xk) const;


protected:
private:



  //===========================================================================
  //===========================================================================

public:
protected:
private:



  //===========================================================================
  //===========================================================================

public:

  enum static_const_int {P = 3};  

  virtual int p() const;

protected:
private:



  //===========================================================================
  //===========================================================================

public:
protected:
private:



  //===========================================================================
  //===========================================================================

public:
protected:
private:



  //============================================================================
  //============================================================================

public:

  virtual const std::string& class_name() const;

  static const std::string& static_class_name();
  
  virtual st3_lite* clone() const;

protected:
private:



  //===========================================================================
  //===========================================================================

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;

  bool invariant() const;


protected:
private:

};

//==============================================================================
// CLASS ST3
//==============================================================================

class SHEAF_DLL_SPEC st3 : public stp
{

  // ===========================================================
  // ===========================================================

public:

  static const poset_path& standard_schema_path();

  static void make_standard_schema(namespace_poset& xns);

  static host_type& new_host(namespace_type& xns, 
                 const poset_path& xhost_path, 
                 const poset_path& xschema_path,
                 const poset_path& xvector_space_path,
                 bool xauto_access);

protected:

private:



  //============================================================================
  //============================================================================

public:

  typedef st3_lite volatile_type;

  st3();

  st3(const poset_state_handle* xhost, pod_index_type xhub_id);

  st3(const poset_state_handle* xhost, const scoped_index& xid);

  st3(const poset_state_handle* xhost, const std::string& xname);

  explicit st3(abstract_poset_member* xother);

  st3(poset_state_handle* xhost, bool xauto_access = true);

  virtual st3& operator=(const abstract_poset_member& xother);

  st3& operator=(const st3& xother);

  ~st3();

  virtual const volatile_type& lite_prototype() const;

  virtual volatile_type* lite_type() const;


protected:
private:



  //============================================================================
  //============================================================================

public:
protected:
private:




  //============================================================================
  //============================================================================

public:

  enum static_const_int {P = 3};  

protected:
private:




  //============================================================================
  //============================================================================

public:

  using stp::component;
  using stp::put_component;

  virtual value_type component(int xi, int xj, int xk) const;

  value_type component(int xi, int xj, int xk, bool xauto_access) const;

  virtual void put_component(int xi, int xj, int xk, value_type xvalue);

  void put_component(int xi, int xj, int xk, value_type xvalue,
                     bool xauto_access);

  virtual int index_for_ijk(int xi, int xj, int xk) const;

protected:
private:



  //============================================================================
  //============================================================================

public:

protected:

private:



  //============================================================================
  //============================================================================

public:

  virtual const std::string& class_name() const;

  static const std::string& static_class_name();
  
  virtual st3* clone() const;

  inline st3* clone(bool xnew_state, bool xauto_access = true) const
  {
    return static_cast<st3*>(stp::clone(xnew_state, xauto_access));
  }

protected:
private:



  //============================================================================
  //============================================================================

public:

  bool is_ancestor_of(const any* xother) const;

  bool invariant() const;

protected:
private:

};

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

} // namespace fiber_bundle

#endif // ifndef ST3_H