Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
bitpit::PatchInfo Class Referenceabstract

The PatchInfo class provides an interface for defining patch info. More...

Inheritance diagram for bitpit::PatchInfo:
Inheritance graph
[legend]
Collaboration diagram for bitpit::PatchInfo:
Collaboration graph
[legend]

Public Member Functions

void extract ()
 
PatchKernel const & getPatch () const
 
void reset ()
 
void setPatch (PatchKernel const *patch)
 
void update ()
 

Protected Member Functions

 PatchInfo (PatchKernel const *patch)
 
virtual void _extract ()=0
 
virtual void _init ()=0
 
virtual void _reset ()=0
 
void setPatch (PatchKernel const *patch, bool initialize)
 

Protected Attributes

PatchKernel const * m_patch
 

Detailed Description

The PatchInfo class provides an interface for defining patch info.

Definition at line 35 of file patch_info.hpp.

Constructor & Destructor Documentation

◆ PatchInfo()

bitpit::PatchInfo::PatchInfo ( PatchKernel const * patch)
protected

Default constructor

Parameters
patchis patch from which the informations will be extracted

Definition at line 46 of file patch_info.cpp.

Member Function Documentation

◆ _extract()

virtual void bitpit::PatchInfo::_extract ( )
protectedpure virtual

Implemented in bitpit::PatchNumberingInfo.

◆ _init()

virtual void bitpit::PatchInfo::_init ( )
protectedpure virtual

Implemented in bitpit::PatchNumberingInfo.

◆ _reset()

virtual void bitpit::PatchInfo::_reset ( )
protectedpure virtual

Implemented in bitpit::PatchNumberingInfo.

◆ extract()

void bitpit::PatchInfo::extract ( )

Extracts the information.

Definition at line 105 of file patch_info.cpp.

◆ getPatch()

PatchKernel const & bitpit::PatchInfo::getPatch ( ) const

Gets the patch associated with the info.

Returns
Returns the patch associated with the info.

Definition at line 57 of file patch_info.cpp.

◆ reset()

void bitpit::PatchInfo::reset ( )

Resets the information.

Definition at line 97 of file patch_info.cpp.

◆ setPatch() [1/2]

void bitpit::PatchInfo::setPatch ( PatchKernel const * patch)

Sets the patch associated to the info.

Parameters
patchis patch from which the informations will be extracted

Definition at line 67 of file patch_info.cpp.

◆ setPatch() [2/2]

void bitpit::PatchInfo::setPatch ( PatchKernel const * patch,
bool initialize )
protected

Sets the patch associated to the info.

Parameters
patchis patch from which the informations will be extracted
initializeif set to true the initializatino function will be called

Definition at line 78 of file patch_info.cpp.

◆ update()

void bitpit::PatchInfo::update ( )

Updates the information.

Definition at line 121 of file patch_info.cpp.

Member Data Documentation

◆ m_patch

PatchKernel const* bitpit::PatchInfo::m_patch
protected

Definition at line 48 of file patch_info.hpp.


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