Chombo + EB + MF  3.2
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
IFid Class Reference

#include <IFid.H>

Public Member Functions

 IFid ()
 Constructs an empty ID. This is needed for serialization. More...
 
 IFid (const std::string &a_name)
 Constructs an ID from the given string. More...
 
 IFid (const IFid &a_rhs)
 Copy constructor. More...
 
 ~IFid ()
 Destructor (not virtual). More...
 
IFidoperator= (const IFid &a_rhs)
 Assignment operator. More...
 
void setNames (const Vector< std::string > &a_names)
 Sets the names associated with this identifier. More...
 
const Vector< std::string > & names () const
 
bool operator== (const IFid &a_rhs) const
 Returns true if the given IFid is the same as this one, false otherwise. More...
 
bool operator!= (const IFid &a_rhs) const
 Returns true if the given IFid differs from this one, false otherwise. More...
 

Static Public Member Functions

static IFid aggregate (const Vector< IFid > &a_IDs)
 This factory method creates an ID by aggregating the given list of IDs. More...
 

Private Member Functions

void append (const IFid &a_rhs)
 

Private Attributes

Vector< std::string > m_names
 

Detailed Description

This class uniquely identifies a boundary represented by a primitive implicit function. We don't envision this being subclassed.

Constructor & Destructor Documentation

◆ IFid() [1/3]

IFid::IFid ( )
inline

Constructs an empty ID. This is needed for serialization.

◆ IFid() [2/3]

IFid::IFid ( const std::string &  a_name)
inlineexplicit

Constructs an ID from the given string.

◆ IFid() [3/3]

IFid::IFid ( const IFid a_rhs)
inline

Copy constructor.

◆ ~IFid()

IFid::~IFid ( )
inline

Destructor (not virtual).

Member Function Documentation

◆ aggregate()

static IFid IFid::aggregate ( const Vector< IFid > &  a_IDs)
inlinestatic

This factory method creates an ID by aggregating the given list of IDs.

References CH_assert, and Vector< T >::size().

◆ operator=()

IFid& IFid::operator= ( const IFid a_rhs)
inline

Assignment operator.

References m_names.

◆ setNames()

void IFid::setNames ( const Vector< std::string > &  a_names)
inline

Sets the names associated with this identifier.

References m_names.

Referenced by linearIn().

◆ names()

const Vector<std::string>& IFid::names ( ) const
inline

Returns the list of names identifying all functions associated with this IFid.

References m_names.

Referenced by linearIn(), linearOut(), and linearSize().

◆ operator==()

bool IFid::operator== ( const IFid a_rhs) const
inline

Returns true if the given IFid is the same as this one, false otherwise.

References m_names, and Vector< T >::size().

◆ operator!=()

bool IFid::operator!= ( const IFid a_rhs) const
inline

Returns true if the given IFid differs from this one, false otherwise.

◆ append()

void IFid::append ( const IFid a_rhs)
inlineprivate

Member Data Documentation

◆ m_names

Vector<std::string> IFid::m_names
private

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