The Original CHomP Software
Public Member Functions | List of all members
chomp::homengin::cubfile_traits< cubfileT > Class Template Reference

This class defines some common properties of the corresponding classes which define various types of sets of cubes. More...

#include <cubfiles.h>

Inheritance diagram for chomp::homengin::cubfile_traits< cubfileT >:
chomp::homengin::cubtype

Public Member Functions

 cubfile_traits ()
 The default constructor. More...
 
 ~cubfile_traits ()
 The destructor. More...
 
const char * name () const
 The name of the corresponding cubical set. More...
 
std::ostream & describe (std::ostream &out) const
 Describe the given type of cubical sets. More...
 
bool compatible (const char *filename) const
 Verifies if the file format is compatible with this cubfile type. More...
 
cubfilenewcubfile (const char *filename) const
 Creates a new cubfile object of the desired type. More...
 
virtual const char * name () const =0
 The name of the set of cubes. More...
 
virtual std::ostream & describe (std::ostream &out) const =0
 Describe the given type of cubical sets. More...
 
virtual bool compatible (const char *filename) const =0
 Verifies if the file format is compatible with this cubfile type. More...
 
virtual cubfilenewcubfile (const char *filename) const =0
 Creates a new cubfile object of the desired type. More...
 

Additional Inherited Members

- Public Types inherited from chomp::homengin::cubtype
typedef std::vector< const cubtype * > cubtypelist
 The type of a list of engines. More...
 
- Static Public Member Functions inherited from chomp::homengin::cubtype
static std::ostream & showlist (std::ostream &out, const cubtype::cubtypelist &types=cubtype::cubtypes)
 Shows a list of available cubical set types with descriptions. More...
 
static cubfilenewfile (const char *filename, const cubtype::cubtypelist &types=cubtype::cubtypes)
 Creates an appropriate cubical set corresponding to the given file. More...
 
- Static Public Attributes inherited from chomp::homengin::cubtype
static cubtypelist cubtypes
 A list of all the engines that have been defined so far. More...
 
- Protected Member Functions inherited from chomp::homengin::cubtype
 cubtype ()
 The constructor: Add the cubical file traits to the list. More...
 
virtual ~cubtype ()
 The destructor: Remove the cubical file traits from the list. More...
 

Detailed Description

template<class cubfileT>
class chomp::homengin::cubfile_traits< cubfileT >

This class defines some common properties of the corresponding classes which define various types of sets of cubes.

Definition at line 302 of file cubfiles.h.

Constructor & Destructor Documentation

◆ cubfile_traits()

template<class cubfileT >
chomp::homengin::cubfile_traits< cubfileT >::cubfile_traits ( )
inline

The default constructor.

Definition at line 306 of file cubfiles.h.

307 {
308 return;
309 }

◆ ~cubfile_traits()

template<class cubfileT >
chomp::homengin::cubfile_traits< cubfileT >::~cubfile_traits ( )
inline

The destructor.

Definition at line 312 of file cubfiles.h.

313 {
314 return;
315 }

Member Function Documentation

◆ compatible()

template<class cubfileT >
bool chomp::homengin::cubfile_traits< cubfileT >::compatible ( const char *  filename) const
inlinevirtual

Verifies if the file format is compatible with this cubfile type.

Implements chomp::homengin::cubtype.

Definition at line 330 of file cubfiles.h.

331 {
332 return cubfileT::compatible (filename);
333 }

◆ describe()

template<class cubfileT >
std::ostream & chomp::homengin::cubfile_traits< cubfileT >::describe ( std::ostream &  out) const
inlinevirtual

Describe the given type of cubical sets.

Implements chomp::homengin::cubtype.

Definition at line 324 of file cubfiles.h.

325 {
326 return cubfileT::describe (out);
327 }

◆ name()

template<class cubfileT >
const char * chomp::homengin::cubfile_traits< cubfileT >::name ( ) const
inlinevirtual

The name of the corresponding cubical set.

Implements chomp::homengin::cubtype.

Definition at line 318 of file cubfiles.h.

319 {
320 return cubfileT::name ();
321 }

◆ newcubfile()

template<class cubfileT >
cubfile * chomp::homengin::cubfile_traits< cubfileT >::newcubfile ( const char *  filename) const
inlinevirtual

Creates a new cubfile object of the desired type.

Implements chomp::homengin::cubtype.

Definition at line 336 of file cubfiles.h.

337 {
338 return new cubfileT (filename);
339 }

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