qugar::impl::funcs::AnnulusBase Class Reference

2D annulus base class. The function is defined by the annulus center and major and inner radii. The function presents a negative sign inside the annulus (between both boundaries), and positive outside. More...

#include <primitive_funcs_lib.hpp>

Inheritance diagram for qugar::impl::funcs::AnnulusBase:

Public Member Functions
	AnnulusBase (real inner_radius, real outer_radius, const Point< 2 > &center)
	Constructor.
const Point< 2 > &	center () const
	Gets the center of the annulus.
real	inner_radius () const
	Gets the inner radius of the annulus.
real	outer_radius () const
	Gets the outer radius of the annulus.

Static Protected Member Functions
static Point< 2 >	get_default_center ()
	Gets the default center of the cylinder. It is set to the center of the Cartesian coordinate system.

Protected Attributes
real	inner_radius_
	Inner radius of the annulus.
real	outer_radius_
	Outer radius of the annulus.
Point< 2 >	center_
	Center of the annulus.

Detailed Description

2D annulus base class. The function is defined by the annulus center and major and inner radii. The function presents a negative sign inside the annulus (between both boundaries), and positive outside.

Constructor & Destructor Documentation

AnnulusBase()

qugar::impl::funcs::AnnulusBase::AnnulusBase	(	real	inner_radius,
		real	outer_radius,
		const Point< 2 > &	center )

Constructor.

Parameters

inner_radius	Inner radius of the annulus.
outer_radius	Outer radius of the annulus.
center	Annulus' center.

Member Function Documentation

center()

const Point< 2 > & qugar::impl::funcs::AnnulusBase::center ( ) const

nodiscard

Gets the center of the annulus.

Returns

real The annulus's center.

get_default_center()

static Point< 2 > qugar::impl::funcs::AnnulusBase::get_default_center ( )

staticnodiscardprotected

Gets the default center of the cylinder. It is set to the center of the Cartesian coordinate system.

inner_radius()

real qugar::impl::funcs::AnnulusBase::inner_radius ( ) const

nodiscard

Gets the inner radius of the annulus.

Returns

real The annulus's inner radius.

outer_radius()

real qugar::impl::funcs::AnnulusBase::outer_radius ( ) const

nodiscard

Gets the outer radius of the annulus.

Returns

real The annulus's outer radius.

Member Data Documentation

center_

Point<2> qugar::impl::funcs::AnnulusBase::center_

protected

Center of the annulus.

inner_radius_

real qugar::impl::funcs::AnnulusBase::inner_radius_

protected

Inner radius of the annulus.

outer_radius_

real qugar::impl::funcs::AnnulusBase::outer_radius_

protected

Outer radius of the annulus.

---

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

• /__w/qugar/qugar/cpp/include/qugar/primitive_funcs_lib.hpp