LifeV
Private Attributes
ExampleClass Class Reference

ExampleClass - Short description of the class. More...

#include <ExampleClass.hpp>

+ Collaboration diagram for ExampleClass:

Private Attributes

first_Type M_variableOne
 
second_Type M_variableTwo
 

Public Types

enum  listOfTemplatesOptions { options1, options2, options3 }
 
typedef int first_Type
 
typedef double second_Type
 

Constructors & Destructor

 ExampleClass ()
 Empty Constructor. More...
 
 ExampleClass (first_Type &VariableOne, second_Type &VariableTwo)
 Short description of the constructor. More...
 
 ExampleClass (const ExampleClass &example)
 Copy constructor. More...
 
 ~ExampleClass ()
 Destructor. More...
 

Operators

ExampleClass & operator= (const ExampleClass &example)
 The equivalence operator. More...
 

Methods

void methodOne (first_Type &inputVariableOne, second_Type &inputVariableTwo)
 Short description of this method. More...
 
void methodTwo ()
 Short description of this method. More...
 
void showMe (std::ostream &output=std::cout) const
 Display general information about the content of the class. More...
 

Set Methods

void setVariableOne (const first_Type &variableOne)
 Short description of this set method. More...
 

Get Methods

const first_Type & variableOne () const
 Short description of this get method. More...
 

Private Methods

void privateMethodOne ()
 Short description of this method. More...
 

Detailed Description

ExampleClass - Short description of the class.

Author
Name Surname
See also
Reference to papers (if available)

Here write a long and detailed description of the class.

For this purpose you can use a lot of standard HTML code. Here there is a list with some useful examples:

For bold text use: BOLD TEXT

For empatyze a word type followed by the word

For verbatim a word type followed by the word

For vertical space (empty lines) use:

For creating list type:

  1. First element of the enumerated list
    • First element of the dotted sublist.
    • Second element of the dotted sublist
  2. Second element of the enumerated list
  3. Third element of the enumerated list

For writing a warning type:

Warning
followed by the description of the warning

It is possible to use a lot of other standard HTML commands. Visit http://www.stack.nl/~dimitri/doxygen/htmlcmds.html for a detailed list.

For any other kind of information visit www.doxygen.org.

Definition at line 86 of file ExampleClass.hpp.

Member Typedef Documentation

◆ first_Type

typedef int first_Type

Definition at line 103 of file ExampleClass.hpp.

◆ second_Type

typedef double second_Type

Definition at line 104 of file ExampleClass.hpp.

Member Enumeration Documentation

◆ listOfTemplatesOptions

enum listOfTemplatesOptions

Description of the purpose of the enumerator list.

Enumerator
options1 

This options means ...

options2 

This options means ...

options3 

This options means ...

Definition at line 96 of file ExampleClass.hpp.

Constructor & Destructor Documentation

◆ ExampleClass() [1/3]

ExampleClass ( )

Empty Constructor.

Definition at line 48 of file ExampleClass.cpp.

◆ ExampleClass() [2/3]

ExampleClass ( first_Type &  VariableOne,
second_Type &  VariableTwo 
)

Short description of the constructor.

Add more details about the constructor. NOTE: short description is automatically added before this part.

Parameters
VariableOneDescription of the first variable
VariableTwoDescription of the second variable

Definition at line 55 of file ExampleClass.cpp.

◆ ExampleClass() [3/3]

ExampleClass ( const ExampleClass &  example)

Copy constructor.

Add more details about the copy constructor. NOTE: short description is automatically added before this part.

Parameters
exampleExampleClass

Definition at line 63 of file ExampleClass.cpp.

◆ ~ExampleClass()

~ExampleClass ( )

Destructor.

Definition at line 70 of file ExampleClass.cpp.

Member Function Documentation

◆ operator=()

ExampleClass & operator= ( const ExampleClass &  example)

The equivalence operator.

Add more details about the method. NOTE: short description is automatically added before this part.

Parameters
exampleExampleClass
Returns
Reference to a new ExampleClass with the same content of ExampleClass example

Definition at line 79 of file ExampleClass.cpp.

◆ methodOne()

void methodOne ( first_Type &  inputVariableOne,
second_Type &  inputVariableTwo 
)

Short description of this method.

Add more details about the method. NOTE: short description is automatically added before this part.

Parameters
inputVariableOneDescription of the first input variable
inputVariableTwoDescription of the second input variable

Definition at line 94 of file ExampleClass.cpp.

◆ methodTwo()

void methodTwo ( )

Short description of this method.

Add more details about the method. NOTE: short description is automatically added before this part.

Definition at line 106 of file ExampleClass.cpp.

◆ showMe()

void showMe ( std::ostream &  output = std::cout) const

Display general information about the content of the class.

List of things displayed in the class

Parameters
outputspecify the output format (std::cout by default)

Definition at line 112 of file ExampleClass.cpp.

◆ setVariableOne()

void setVariableOne ( const first_Type &  variableOne)

Short description of this set method.

Add more details about the method. NOTE: short description is automatically added before this part.

Parameters
variableOneDescription of the input variable

Definition at line 123 of file ExampleClass.cpp.

◆ variableOne()

const ExampleClass::first_Type & variableOne ( ) const

Short description of this get method.

Add more details about the method. NOTE: short description is automatically added before this part.

Returns
Description of the output variable

Definition at line 132 of file ExampleClass.cpp.

◆ privateMethodOne()

void privateMethodOne ( )
private

Short description of this method.

Add more details about the method. NOTE: short description is automatically added before this part.

Definition at line 141 of file ExampleClass.cpp.

Field Documentation

◆ M_variableOne

first_Type M_variableOne
private

Definition at line 224 of file ExampleClass.hpp.

◆ M_variableTwo

second_Type M_variableTwo
private

Definition at line 225 of file ExampleClass.hpp.

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