pandore::Dimension1d

pandore::Dimension1d Class Reference

#include <dimension.h>

Inheritance diagram for pandore::Dimension1d:

pandore::Dimension List of all members.

Detailed Description

A 1D dimension.

The Dimension1d class encapsulates the width of a component (in Long precision) in a single object.
Use of Dimension1d: 

 Dimension1d d1(10);
 Dimension1d * d2 = new Dimension1d(10);
 Dimension1d d3; d3.w=10;
 Dimension1d d4 = d3 * 2;
 if (d4==d3) { ... }

For the use of Dimension1d see The Dimensions.


Public Member Functions

Typobj Type () const
std::string Name () const
 Dimension1d ()
 Dimension1d (Long width)
 Dimension1d (const Dimension1d &d)
const Dimension1d & operator= (const Dimension1d &d)
bool operator== (const Dimension1d &d) const
bool operator!= (const Dimension1d &d) const
Dimension1d operator+ (int x) const
Dimension1d operator- (int x) const
Dimension1d operator * (int x) const
Dimension1d operator/ (int x) const
Pobject * Clone () const
Errc LoadData (FILE *df)
Errc SaveData (FILE *df) const

Public Attributes

Long w

Constructor & Destructor Documentation

pandore::Dimension1d::Dimension1d (   )  [inline]
 

Creates a 1D dimension with a width of zero.

pandore::Dimension1d::Dimension1d (  Long  width  )  [inline]
 

Creates a 1D dimension with the specified width value.

Parameters:
width the specified width value.

pandore::Dimension1d::Dimension1d (  const Dimension1d &  d  )  [inline]
 

Creates a 1D dimension with the specified dimension.

Parameters:
d the specified dimension.

Member Function Documentation

Pobject* pandore::Dimension1d::Clone (   )  const [inline]
 

Creates and returns a distinct copy of this object.

Errc pandore::Dimension1d::LoadData (  FILE *  df  )  [inline]
 

Loads data from the given file.

Parameters:
df the file where to read data.
Returns:
SUCCESS or FAILURE in case of IO errors.

std::string pandore::Dimension1d::Name (   )  const [inline]
 

Returns the type name (for instance "Dimension1d").

Returns:
the name in a string.

Dimension1d pandore::Dimension1d::operator * (  int  x  )  const [inline]
 

Creates a new 1D dimension from the multiplication of the dimension value by the specified value.

Parameters:
x the specified value.
Returns:
a new dimension.

bool pandore::Dimension1d::operator!= (  const Dimension1d &  d  )  const [inline]
 

Checks if the dimension is different from a reference dimension.

Parameters:
d the reference dimension.
Returns:
true if dimensions are different.

Dimension1d pandore::Dimension1d::operator+ (  int  x  )  const [inline]
 

Creates a new 1D dimension from the addition of the dimension value by the specified value.

Parameters:
x the specified value.
Returns:
a new dimension.

Dimension1d pandore::Dimension1d::operator- (  int  x  )  const [inline]
 

Creates a new 1D dimension from the subtraction of the dimension value by the specified value.

Parameters:
x the specified value.
Returns:
a new dimension.

Dimension1d pandore::Dimension1d::operator/ (  int  x  )  const [inline]
 

Creates a new 1D dimension from the division of the dimension value by the specified value.

Parameters:
x the specified value.
Returns:
a new dimension.

const Dimension1d& pandore::Dimension1d::operator= (  const Dimension1d &  d  )  [inline]
 

Sets the new dimension value with the specified dimension value.

Parameters:
d the specified dimension.
Returns:
the specified dimension.

bool pandore::Dimension1d::operator== (  const Dimension1d &  d  )  const [inline]
 

Checks if the dimension is equal to a reference dimension.

Parameters:
d the reference dimension.
Returns:
true if dimensions are equal.

Errc pandore::Dimension1d::SaveData (  FILE *  df  )  const [inline]
 

Saves data in the given file.

Parameters:
df the file where to save data.
Returns:
SUCCESS or FAILURE in case of IO errors.

Typobj pandore::Dimension1d::Type (   )  const [inline]
 

Returns the magic number of the object (for instance Po_Dimension1d).

Returns:
the magic number.

Member Data Documentation

Long pandore::Dimension1d::w
 

The width dimension; negative values can be used.

The documentation for this class was generated from the following file:
The Pantheon project
Image Team GREYC Laboratory
UMR CNRS 6072 - ENSICAEN - University of Caen, France
This page was last modified on 19 June 2015