SheafSystem  0.0.0.0
Friends | List of all members
sheaf::primitives_index_space_iterator Class Reference

An iterator over the id space for the primitives row dof id space. More...

#include <primitives_index_space_iterator.h>

Inheritance diagram for sheaf::primitives_index_space_iterator:
sheaf::explicit_index_space_iterator sheaf::index_space_iterator sheaf::any

Friends

class primitives_index_space_state
 

PRIMITIVES_INDEX_SPACE_ITERATOR FACET

 primitives_index_space_iterator ()
 Default constructor. More...
 
 primitives_index_space_iterator (const primitives_index_space_iterator &xother)
 Copy constructor. More...
 
 primitives_index_space_iterator (const index_space_family &xid_spaces, pod_type xindex)
 Constructor: Attach to state with index xindex in the family xid_spaces. More...
 
 primitives_index_space_iterator (const index_space_family &xid_spaces, const std::string &xname)
 Constructor: Attach to state with name xname in the family xid_spaces. More...
 
primitives_index_space_iterator & operator= (const primitives_index_space_iterator &xother)
 Assignment operator. More...
 
virtual ~primitives_index_space_iterator ()
 Destructor. More...
 

INDEX_SPACE_ITERATOR FACET

virtual primitives_index_space_iterator & operator= (const index_space_iterator &xother)
 Assignment operator. More...
 
virtual primitives_index_space_iterator * clone () const
 Virtual constructor, makes a new instance of the same type as this. If the iterator is attached, attach to the same state. More...
 

ITERATOR FACET

virtual void next ()
 Makes item() the next id in the iteration. More...
 
virtual void reset ()
 Restarts the iteration. More...
 

HANDLE FACET

virtual void attach_to (explicit_index_space_state *xstate)
 Attach to the explicit id space state xstate. More...
 
virtual bool conforms_to_state (explicit_index_space_state *xstate) const
 True if this conforms to the iterator type required by the explicit id space state xstate. More...
 

ANY FACET

virtual bool is_ancestor_of (const any *other) const
 Conformance test; true if other conforms to this. More...
 
virtual bool invariant () const
 Class invariant. More...
 

Additional Inherited Members

- Public Types inherited from sheaf::index_space_iterator
typedef pod_index_type pod_type
 The "plain old data" index type for this. More...
 
- Public Member Functions inherited from sheaf::explicit_index_space_iterator
virtual ~explicit_index_space_iterator ()
 Destructor. More...
 
virtual bool operator== (const index_space_iterator &xother) const
 True if this is equivalent to xother. More...
 
virtual const index_space_collection & host () const
 The host collection. More...
 
virtual pod_type index () const
 Index of this space. More...
 
virtual bool is_attached () const
 True if this iterator is attached to a state. More...
 
virtual void attach_to (pod_type xindex)
 Attach to the state with index xindex in the id space family id_spaces(). More...
 
virtual void attach_to (const index_space_collection &xhost, pod_type xlocal_id)
 Attach to the state with local scope id, xlocal_id in the host id space collection xhost. More...
 
virtual void detach ()
 Detach this iterator form its state, if any. More...
 
virtual bool conforms_to_state (const index_space_collection &xhost, pod_type xlocal_id) const
 True if this conforms to the handle type required by the state with local scope id xlocal_id in the host id space collection xhost. More...
 
- Public Member Functions inherited from sheaf::index_space_iterator
virtual ~index_space_iterator ()
 Destructor. More...
 
bool is_done () const
 True if iteration is finished. More...
 
void force_is_done ()
 Makes is_done() true. More...
 
pod_type pod () const
 The current id in the iteration. More...
 
pod_type hub_pod () const
 The current unglued hub id in the iteration. synonym for unglued_hub_pod(). More...
 
pod_type unglued_hub_pod () const
 The current unglued hub id in the iteration. More...
 
pod_type glued_hub_pod () const
 The current glued hub id in the iteration. More...
 
const index_space_family & id_spaces () const
 The id space family for this (const version). More...
 
const hub_index_space_handle & hub_id_space () const
 The hub id space. More...
 
std::string name () const
 Name of this space. More...
 
void attach_to (const index_space_family &xid_spaces, pod_type xindex)
 Attach to the state with index xindex in the id space family xid_spaces. More...
 
void attach_to (const index_space_family &xid_spaces, const std::string &xname)
 Attach to the state with name xname in the id space family xid_spaces. More...
 
void attach_to (const std::string &xname)
 Attach to the state with name xname in the id space family id_spaces(). More...
 
void attach_to (const index_space_handle &xid_space)
 Attach to the state of the id space xid_space. More...
 
bool conforms_to_state (const index_space_family &xid_spaces, pod_type xindex) const
 True if this conforms to the handle type required by the state with index xindex in the id space family, xid_spaces. More...
 
bool conforms_to_state (const index_space_family &xid_spaces, const std::string &xname) const
 True if this conforms to the handle type required by the state with name xname in the id space family, xid_spaces. More...
 
bool conforms_to_state (pod_type xid) const
 True if this conforms to the handle type required by the state with id xid. More...
 
bool conforms_to_state (const std::string &xname) const
 True if this conforms to the handle type required by the state with name xname. More...
 
- Public Member Functions inherited from sheaf::any
bool is_same_type (const any *other) const
 True if other is the same type as this. More...
 
virtual ~any ()
 Destructor. 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...
 
- Protected Member Functions inherited from sheaf::explicit_index_space_iterator
 explicit_index_space_iterator ()
 Default constructor. More...
 
 explicit_index_space_iterator (const explicit_index_space_iterator &xother)
 Copy constructor. More...
 
explicit_index_space_iterator & operator= (const explicit_index_space_iterator &xother)
 Assignment operator. More...
 
explicit_index_space_state & state ()
 The explicit state (mutable version). More...
 
const explicit_index_space_state & state () const
 The explicit state (const version). More...
 
explicit_index_space_state * state (pod_type xindex) const
 The explicit id space state at id xindex in id space family id_spaces(). Returns null if no id space stae is available at index xindex. More...
 
explicit_index_space_state * state (const index_space_collection &xhost, pod_type xlocal_id) const
 The explicit id space state with local scope id xlocal_id in the host id space collection xhost. More...
 
- Protected Member Functions inherited from sheaf::index_space_iterator
 index_space_iterator ()
 Creates an iterator for the id space. More...
 
 index_space_iterator (const index_space_iterator &xother)
 Copy constructor. More...
 
void invalidate_ids ()
 Set is_done() and invalidate pod() and hub_pod(). More...
 
- Protected Member Functions inherited from sheaf::any
 any ()
 default constructor More...
 
- Protected Attributes inherited from sheaf::explicit_index_space_iterator
explicit_index_space_state * _state
 The explicit state. More...
 
- Protected Attributes inherited from sheaf::index_space_iterator
bool _is_done
 True if the iteration is finished. More...
 
pod_type _pod
 The current id in the iteration. More...
 
pod_type _hub_pod
 The current hub id in the iteration. More...
 

Detailed Description

An iterator over the id space for the primitives row dof id space.

Definition at line 38 of file primitives_index_space_iterator.h.

Constructor & Destructor Documentation

◆ primitives_index_space_iterator() [1/4]

sheaf::primitives_index_space_iterator::primitives_index_space_iterator ( )

Default constructor.

Postcondition
  • !is_attached()

Definition at line 50 of file primitives_index_space_iterator.cc.

References invariant(), and sheaf::explicit_index_space_iterator::is_attached().

Referenced by clone(), and primitives_index_space_iterator().

◆ primitives_index_space_iterator() [2/4]

sheaf::primitives_index_space_iterator::primitives_index_space_iterator ( const primitives_index_space_iterator &  xother)

Copy constructor.

Postcondition
  • (*this) == xother

Definition at line 67 of file primitives_index_space_iterator.cc.

References invariant(), and primitives_index_space_iterator().

◆ primitives_index_space_iterator() [3/4]

sheaf::primitives_index_space_iterator::primitives_index_space_iterator ( const index_space_family &  xid_spaces,
pod_type  xindex 
)

Constructor: Attach to state with index xindex in the family xid_spaces.

Precondition
  • conforms_to_state(xid_spaces, xindex)
Postcondition

Definition at line 85 of file primitives_index_space_iterator.cc.

References attach_to(), conforms_to_state(), sheaf::index_space_iterator::id_spaces(), sheaf::explicit_index_space_iterator::index(), invariant(), sheaf::explicit_index_space_iterator::is_attached(), and primitives_index_space_iterator().

◆ primitives_index_space_iterator() [4/4]

sheaf::primitives_index_space_iterator::primitives_index_space_iterator ( const index_space_family &  xid_spaces,
const std::string &  xname 
)

Constructor: Attach to state with name xname in the family xid_spaces.

Precondition
  • conforms_to_state(xid_spaces, xname)
Postcondition

Definition at line 109 of file primitives_index_space_iterator.cc.

References attach_to(), conforms_to_state(), sheaf::index_space_iterator::id_spaces(), invariant(), sheaf::explicit_index_space_iterator::is_attached(), sheaf::index_space_iterator::name(), and operator=().

◆ ~primitives_index_space_iterator()

sheaf::primitives_index_space_iterator::~primitives_index_space_iterator ( )
virtual

Destructor.

Definition at line 160 of file primitives_index_space_iterator.cc.

References operator=().

Referenced by operator=().

Member Function Documentation

◆ attach_to()

void sheaf::primitives_index_space_iterator::attach_to ( explicit_index_space_state *  xstate)
protectedvirtual

Attach to the explicit id space state xstate.

Precondition
  • xstate != 0
  • conforms_to_state(xstate)
Postcondition

Implements sheaf::explicit_index_space_iterator.

Definition at line 332 of file primitives_index_space_iterator.cc.

References sheaf::explicit_index_space_iterator::_state, conforms_to_state(), invariant(), sheaf::explicit_index_space_iterator::is_attached(), reset(), and sheaf::explicit_index_space_iterator::state().

Referenced by primitives_index_space_iterator(), and reset().

◆ clone()

sheaf::primitives_index_space_iterator * sheaf::primitives_index_space_iterator::clone ( ) const
virtual

Virtual constructor, makes a new instance of the same type as this. If the iterator is attached, attach to the same state.

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

Implements sheaf::explicit_index_space_iterator.

Definition at line 224 of file primitives_index_space_iterator.cc.

References sheaf::any::is_same_type(), next(), and primitives_index_space_iterator().

Referenced by operator=().

◆ conforms_to_state()

bool sheaf::primitives_index_space_iterator::conforms_to_state ( explicit_index_space_state *  xstate) const
protectedvirtual

True if this conforms to the iterator type required by the explicit id space state xstate.

Postcondition
  • is_basic_query

Implements sheaf::explicit_index_space_iterator.

Definition at line 362 of file primitives_index_space_iterator.cc.

References is_ancestor_of().

Referenced by attach_to(), and primitives_index_space_iterator().

◆ invariant()

bool sheaf::primitives_index_space_iterator::invariant ( ) const
virtual

Class invariant.

Invariant

Reimplemented from sheaf::explicit_index_space_iterator.

Definition at line 413 of file primitives_index_space_iterator.cc.

References sheaf::any::disable_invariant_check(), sheaf::any::enable_invariant_check(), sheaf::explicit_index_space_iterator::invariant(), and sheaf::any::invariant_check().

Referenced by attach_to(), is_ancestor_of(), next(), operator=(), primitives_index_space_iterator(), and reset().

◆ is_ancestor_of()

bool sheaf::primitives_index_space_iterator::is_ancestor_of ( const any *  other) const
virtual

Conformance test; true if other conforms to this.

Precondition
  • other != 0

Reimplemented from sheaf::explicit_index_space_iterator.

Definition at line 392 of file primitives_index_space_iterator.cc.

References invariant().

Referenced by conforms_to_state(), and operator=().

◆ next()

void sheaf::primitives_index_space_iterator::next ( )
virtual

Makes item() the next id in the iteration.

Precondition
  • !is_done()
Postcondition

Implements sheaf::index_space_iterator.

Definition at line 258 of file primitives_index_space_iterator.cc.

References sheaf::index_space_iterator::_hub_pod, sheaf::index_space_iterator::_pod, sheaf::index_space_iterator::hub_pod(), sheaf::index_space_iterator::invalidate_ids(), invariant(), sheaf::explicit_index_space_iterator::is_attached(), sheaf::index_space_iterator::is_done(), sheaf::index_space_iterator::pod(), and reset().

Referenced by clone().

◆ operator=() [1/2]

sheaf::primitives_index_space_iterator & sheaf::primitives_index_space_iterator::operator= ( const primitives_index_space_iterator &  xother)

Assignment operator.

Postcondition
  • (*this) == xother

Definition at line 134 of file primitives_index_space_iterator.cc.

References sheaf::explicit_index_space_iterator::detach(), invariant(), sheaf::explicit_index_space_iterator::is_attached(), and ~primitives_index_space_iterator().

Referenced by primitives_index_space_iterator(), and ~primitives_index_space_iterator().

◆ operator=() [2/2]

sheaf::primitives_index_space_iterator & sheaf::primitives_index_space_iterator::operator= ( const index_space_iterator &  xother)
virtual

Assignment operator.

Precondition
  • is_ancestor_of(&xother)
Postcondition
  • (*this) == xother

Reimplemented from sheaf::explicit_index_space_iterator.

Definition at line 199 of file primitives_index_space_iterator.cc.

References clone(), invariant(), and is_ancestor_of().

◆ reset()

void sheaf::primitives_index_space_iterator::reset ( )
virtual

Restarts the iteration.

Precondition
Postcondition

Implements sheaf::index_space_iterator.

Definition at line 297 of file primitives_index_space_iterator.cc.

References sheaf::index_space_iterator::_hub_pod, sheaf::index_space_iterator::_is_done, sheaf::index_space_iterator::_pod, attach_to(), invariant(), and sheaf::explicit_index_space_iterator::is_attached().

Referenced by attach_to(), and next().

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