SheafSystem  0.0.0.0
List of all members
fiber_bundle::any_lite Class Referenceabstract

Abstract base class with useful features for all volatile objects. More...

#include <any_lite.h>

Inheritance diagram for fiber_bundle::any_lite:
fiber_bundle::group_lite fiber_bundle::tuple_lite fiber_bundle::gln_lite fiber_bundle::vd_lite fiber_bundle::gl2_lite fiber_bundle::gl3_lite fiber_bundle::jcb_lite fiber_bundle::tp_lite fiber_bundle::jcb_ed_lite fiber_bundle::atp_lite fiber_bundle::stp_lite fiber_bundle::t2_lite fiber_bundle::t3_lite fiber_bundle::t4_lite fiber_bundle::jcb_e13_lite fiber_bundle::jcb_e23_lite fiber_bundle::jcb_e33_lite fiber_bundle::at0_lite fiber_bundle::at1_lite fiber_bundle::at2_lite fiber_bundle::at3_lite fiber_bundle::st2_lite fiber_bundle::st3_lite fiber_bundle::st4_lite fiber_bundle::t2_e2_lite fiber_bundle::t2_e3_lite fiber_bundle::t3_e3_lite fiber_bundle::t4_e2_lite fiber_bundle::t4_e3_lite

ANY FACET

typedef any_lite volatile_type
 The associated volatile type. More...
 
virtual const std::string & class_name () const =0
 The name of this class. More...
 
virtual any_lite * clone () const
 Virtual constructor, makes a new instance of the same type as this. More...
 
virtual ~any_lite ()
 Destructor. More...
 
virtual bool is_ancestor_of (const any_lite &xother) const
 True if other conforms to this. More...
 
bool is_same_type (const any_lite &xother) const
 True if other is the same type as this. More...
 
static const std::string & static_class_name ()
 The name of this class. More...
 
 any_lite ()
 Default constructor. More...
 

CONTROLLABLE INVARIANT INTERFACE

bool invariant () const
 Class invariant, intended to be redefined in each descendant. More...
 
bool invariant_check () const
 True if invariant checking is enabled. More...
 
void enable_invariant_check () const
 Enable invariant checking. More...
 
void disable_invariant_check () const
 Disable invariant check. Intended for preventing recursive calls to invariant and for suppressing invariant checking during multi-phase initialization. More...
 
int disable_invariance_check_request_depth () const
 Number of times disable_invariant_check has been called without matching call to enable_invariant_check. More...
 

DOF ACCESS FACET

virtual void * row_dofs ()
 The row dofs for this instance (mutable version). More...
 
virtual const void * row_dofs () const
 The row dofs for this instance (const version). More...
 

Detailed Description

Abstract base class with useful features for all volatile objects.

Definition at line 48 of file any_lite.h.

Member Typedef Documentation

◆ volatile_type

typedef any_lite fiber_bundle::any_lite::volatile_type

The associated volatile type.

Definition at line 61 of file any_lite.h.

Constructor & Destructor Documentation

◆ ~any_lite()

fiber_bundle::any_lite::~any_lite ( )
virtual

Destructor.

Definition at line 38 of file any_lite.cc.

References class_name().

◆ any_lite()

fiber_bundle::any_lite::any_lite ( )
protected

Default constructor.

Postcondition

Definition at line 167 of file any_lite.cc.

References invariant().

Referenced by is_same_type().

Member Function Documentation

◆ class_name()

const std::string & fiber_bundle::any_lite::class_name ( ) const
pure virtual

The name of this class.

Postcondition
  • !result.empty()

Implemented in fiber_bundle::gl3_lite, fiber_bundle::e3_lite, fiber_bundle::met_e3_lite, fiber_bundle::t2_e3_lite, fiber_bundle::gl2_lite, fiber_bundle::met_e2_lite, fiber_bundle::t2_e2_lite, fiber_bundle::t4_e3_lite, fiber_bundle::st2_e3_lite, fiber_bundle::jcb_e33_lite, fiber_bundle::st2_e2_lite, fiber_bundle::jcb_e13_lite, fiber_bundle::at2_e3_lite, fiber_bundle::at0_lite, fiber_bundle::jcb_e23_lite, fiber_bundle::at2_e2_lite, fiber_bundle::e4_lite, fiber_bundle::e2_lite, fiber_bundle::t3_e3_lite, fiber_bundle::e1_lite, fiber_bundle::met_e1_lite, fiber_bundle::st4_e3_lite, fiber_bundle::t4_e2_lite, fiber_bundle::st4_e2_lite, fiber_bundle::at3_e3_lite, fiber_bundle::st3_e3_lite, fiber_bundle::vd_lite, fiber_bundle::gln_lite, fiber_bundle::st2_lite, fiber_bundle::at2_lite, fiber_bundle::tp_lite, fiber_bundle::at3_lite, fiber_bundle::st3_lite, fiber_bundle::st4_lite, fiber_bundle::jcb_lite, fiber_bundle::t2_lite, fiber_bundle::t4_lite, fiber_bundle::t3_lite, fiber_bundle::met_ed_lite, fiber_bundle::at1_lite, fiber_bundle::ed_lite, fiber_bundle::met_lite, fiber_bundle::atp_lite, fiber_bundle::stp_lite, fiber_bundle::tuple_lite, fiber_bundle::jcb_ed_lite, and fiber_bundle::group_lite.

Definition at line 56 of file any_lite.cc.

References static_class_name().

Referenced by ~any_lite().

◆ clone()

fiber_bundle::any_lite * fiber_bundle::any_lite::clone ( ) const
virtual

Virtual constructor, makes a new instance of the same type as this.

Is Abstract.

Postcondition
  • result != 0
  • is_same_type(*result)

Reimplemented in fiber_bundle::gl3_lite, fiber_bundle::e3_lite, fiber_bundle::met_e3_lite, fiber_bundle::t2_e3_lite, fiber_bundle::gl2_lite, fiber_bundle::met_e2_lite, fiber_bundle::t2_e2_lite, fiber_bundle::t4_e3_lite, fiber_bundle::st2_e3_lite, fiber_bundle::jcb_e33_lite, fiber_bundle::st2_e2_lite, fiber_bundle::jcb_e13_lite, fiber_bundle::at2_e3_lite, fiber_bundle::at0_lite, fiber_bundle::jcb_e23_lite, fiber_bundle::at2_e2_lite, fiber_bundle::e4_lite, fiber_bundle::e2_lite, fiber_bundle::t3_e3_lite, fiber_bundle::e1_lite, fiber_bundle::met_e1_lite, fiber_bundle::st4_e3_lite, fiber_bundle::t4_e2_lite, fiber_bundle::st4_e2_lite, fiber_bundle::at3_e3_lite, fiber_bundle::st3_e3_lite, fiber_bundle::vd_lite, fiber_bundle::gln_lite, fiber_bundle::st2_lite, fiber_bundle::at2_lite, fiber_bundle::tp_lite, fiber_bundle::at3_lite, fiber_bundle::st3_lite, fiber_bundle::st4_lite, fiber_bundle::jcb_lite, fiber_bundle::t2_lite, fiber_bundle::t4_lite, fiber_bundle::t3_lite, fiber_bundle::met_ed_lite, fiber_bundle::at1_lite, fiber_bundle::ed_lite, fiber_bundle::met_lite, fiber_bundle::atp_lite, fiber_bundle::stp_lite, fiber_bundle::tuple_lite, fiber_bundle::jcb_ed_lite, and fiber_bundle::group_lite.

Definition at line 94 of file any_lite.cc.

References is_ancestor_of().

Referenced by static_class_name().

◆ disable_invariance_check_request_depth()

int fiber_bundle::any_lite::disable_invariance_check_request_depth ( ) const
inline

Number of times disable_invariant_check has been called without matching call to enable_invariant_check.

Definition at line 149 of file any_lite.h.

References sheaf::row_dofs().

◆ disable_invariant_check()

void fiber_bundle::any_lite::disable_invariant_check ( ) const
inline

Disable invariant check. Intended for preventing recursive calls to invariant and for suppressing invariant checking during multi-phase initialization.

Definition at line 140 of file any_lite.h.

◆ enable_invariant_check()

void fiber_bundle::any_lite::enable_invariant_check ( ) const
inline

Enable invariant checking.

Definition at line 130 of file any_lite.h.

◆ invariant()

bool fiber_bundle::any_lite::invariant ( ) const

Class invariant, intended to be redefined in each descendant.

Invariant

Definition at line 197 of file any_lite.cc.

References row_dofs().

Referenced by any_lite().

◆ invariant_check()

bool fiber_bundle::any_lite::invariant_check ( ) const
inline

True if invariant checking is enabled.

Definition at line 122 of file any_lite.h.

◆ is_ancestor_of()

bool fiber_bundle::any_lite::is_ancestor_of ( const any_lite &  xother) const
virtual

True if other conforms to this.

Precondition
  • &xother != 0

Reimplemented in fiber_bundle::gl3_lite, fiber_bundle::e3_lite, fiber_bundle::met_e3_lite, fiber_bundle::t2_e3_lite, fiber_bundle::gl2_lite, fiber_bundle::met_e2_lite, fiber_bundle::t2_e2_lite, fiber_bundle::t4_e3_lite, fiber_bundle::st2_e3_lite, fiber_bundle::jcb_e33_lite, fiber_bundle::st2_e2_lite, fiber_bundle::jcb_e13_lite, fiber_bundle::at2_e3_lite, fiber_bundle::at0_lite, fiber_bundle::jcb_e23_lite, fiber_bundle::at2_e2_lite, fiber_bundle::e4_lite, fiber_bundle::e2_lite, fiber_bundle::t3_e3_lite, fiber_bundle::e1_lite, fiber_bundle::met_e1_lite, fiber_bundle::st4_e3_lite, fiber_bundle::t4_e2_lite, fiber_bundle::st4_e2_lite, fiber_bundle::at3_e3_lite, fiber_bundle::st3_e3_lite, fiber_bundle::vd_lite, fiber_bundle::gln_lite, fiber_bundle::st2_lite, fiber_bundle::at2_lite, fiber_bundle::tp_lite, fiber_bundle::at3_lite, fiber_bundle::st3_lite, fiber_bundle::st4_lite, fiber_bundle::jcb_lite, fiber_bundle::t2_lite, fiber_bundle::t4_lite, fiber_bundle::t3_lite, fiber_bundle::met_ed_lite, fiber_bundle::at1_lite, fiber_bundle::ed_lite, fiber_bundle::met_lite, fiber_bundle::atp_lite, fiber_bundle::stp_lite, fiber_bundle::tuple_lite, fiber_bundle::jcb_ed_lite, and fiber_bundle::group_lite.

Definition at line 122 of file any_lite.cc.

References is_same_type().

Referenced by clone(), and is_same_type().

◆ is_same_type()

bool fiber_bundle::any_lite::is_same_type ( const any_lite &  xother) const

True if other is the same type as this.

Precondition
  • &xother != 0

Definition at line 142 of file any_lite.cc.

References any_lite(), and is_ancestor_of().

Referenced by fiber_bundle::vd_algebra::contract(), is_ancestor_of(), fiber_bundle::ed_algebra::normalize(), and fiber_bundle::atp_algebra::wedge().

◆ row_dofs() [1/2]

void * fiber_bundle::any_lite::row_dofs ( )
virtual

The row dofs for this instance (mutable version).

Is Abstract.

Postcondition
  • result != 0

Reimplemented in fiber_bundle::gl3_lite, fiber_bundle::e3_lite, fiber_bundle::met_e3_lite, fiber_bundle::t2_e3_lite, fiber_bundle::gl2_lite, fiber_bundle::met_e2_lite, fiber_bundle::t2_e2_lite, fiber_bundle::t4_e3_lite, fiber_bundle::st2_e3_lite, fiber_bundle::jcb_e33_lite, fiber_bundle::st2_e2_lite, fiber_bundle::jcb_e13_lite, fiber_bundle::at2_e3_lite, fiber_bundle::at0_lite, fiber_bundle::jcb_e23_lite, fiber_bundle::at2_e2_lite, fiber_bundle::e4_lite, fiber_bundle::e2_lite, fiber_bundle::t3_e3_lite, fiber_bundle::e1_lite, fiber_bundle::met_e1_lite, fiber_bundle::st4_e3_lite, fiber_bundle::t4_e2_lite, fiber_bundle::st4_e2_lite, fiber_bundle::at3_e3_lite, and fiber_bundle::st3_e3_lite.

Definition at line 225 of file any_lite.cc.

Referenced by fiber_bundle::sec_vd::force_fiber(), fiber_bundle::sec_vd::get_fiber(), invariant(), and fiber_bundle::sec_vd::put_fiber().

◆ row_dofs() [2/2]

const void * fiber_bundle::any_lite::row_dofs ( ) const
virtual

The row dofs for this instance (const version).

Is Abstract.

Postcondition
  • result != 0

Reimplemented in fiber_bundle::gl3_lite, fiber_bundle::e3_lite, fiber_bundle::met_e3_lite, fiber_bundle::t2_e3_lite, fiber_bundle::gl2_lite, fiber_bundle::met_e2_lite, fiber_bundle::t2_e2_lite, fiber_bundle::t4_e3_lite, fiber_bundle::st2_e3_lite, fiber_bundle::jcb_e33_lite, fiber_bundle::st2_e2_lite, fiber_bundle::jcb_e13_lite, fiber_bundle::at2_e3_lite, fiber_bundle::at0_lite, fiber_bundle::jcb_e23_lite, fiber_bundle::at2_e2_lite, fiber_bundle::e4_lite, fiber_bundle::e2_lite, fiber_bundle::t3_e3_lite, fiber_bundle::e1_lite, fiber_bundle::met_e1_lite, fiber_bundle::st4_e3_lite, fiber_bundle::t4_e2_lite, fiber_bundle::st4_e2_lite, fiber_bundle::at3_e3_lite, and fiber_bundle::st3_e3_lite.

Definition at line 246 of file any_lite.cc.

◆ static_class_name()

const std::string & fiber_bundle::any_lite::static_class_name ( )
static

The name of this class.

Postcondition
  • !result.empty()

Definition at line 75 of file any_lite.cc.

References clone().

Referenced by class_name().

The documentation for this class was generated from the following files: