---

LOSR::Surface Class Reference

LOSR::Surface describe a sperical contact between two optical materials. More...

#include <Surface.hpp>

List of all members.

Public Methods
	Surface (double inCurvature=0, double inIndex=0, double inAperture=0, double inThickness=0)
	Construct a Surface object with the values given. By default, values are set to 0. More...
	~Surface ()
	Destructor (do nothing).
double	getAperture () const
	Return aperture radius.
double	getCurvature () const
	Return curvature.
double	getIndex () const
	Return glass refraction index to the right.
double	getThickness () const
	Return distance to the next surface.
void	read (std::istream &ioIs=std::cin)
	Read a LOSR::Surface from a C++ input stream. More...
void	setAperture (double inAperture)
	Set aperture radius.
void	setCurvature (double inCurvature)
	Set curvature.
void	setIndex (double inIndex)
	Set glass refraction index.
void	setThickness (double inThickness)
	Set distance to next surface.
void	write (std::ostream &ioOs=std::cout) const
	Write a LOSR::Surface into a C++ output stream. More...
Protected Attributes
double	mCurvature
	Curvature of the spherical contact.
double	mIndex
	Glass refraction index of the material at the right of the surface.
double	mAperture
	Radius of the aperture of the surface.
double	mThickness
	Distance to the next surface at the right, on the optical axis.

---

Detailed Description

LOSR::Surface describe a sperical contact between two optical materials.

LOSR::Surface describe a sperical contact between two optical materials. It haves as attributes, the aperture radius of the surface, the glass refraction index of the material at the right of the surface, the curvature (1/radius) of the surface and the distance to the next surface on the axis.

Author:

Christian Gagné and Julie Beaulieu

Version:

0.2

Date:

8/23/2001

---

Constructor & Destructor Documentation

Surface::Surface ( double inCurvature = 0, double inIndex = 0, double inAperture = 0, double inThickness = 0 )

Construct a Surface object with the values given. By default, values are set to 0. Parameters: inCurvature   Curvature value of the sperical surface. inIndex   Glass refraction index value at the right of the surface. inAperture   Aperture radius value. inThickness   Distance value to the next right surface. : mCurvature(inCurvature), mIndex(inIndex), mAperture(inAperture), mThickness(inThickness) { }

---

Member Function Documentation

void Surface::read ( std::istream & ioIs = std::cin )

Read a LOSR::Surface from a C++ input stream. Parameters: ioIs   Input stream to extract the LOSR::Surface from. { char c1 ='\0', c2='\0'; char buf[2048]; // Extract and ignore the rest of lines starting with a # for(ioIs >> c1; c1=='#'; ioIs >> c1) ioIs.getline(buf,2048,'\n'); if(!ioIs) throw LOSR_RuntimeErrorM("Premature end of stream!"); // Looking for chars 'c:' ioIs >> c2; if((c1!='c') || (c2!=':')) throw LOSR_RuntimeErrorM("Invalide format!"); if(!ioIs) throw LOSR_RuntimeErrorM("Premature end of stream!"); // Found what was needed, read curvature ioIs >> mCurvature; // Extract and ignore the rest of lines starting with a # for(ioIs >> c1; c1=='#'; ioIs >> c1) ioIs.getline(buf,2048,'\n'); if(!ioIs) throw LOSR_RuntimeErrorM("Premature end of stream!"); // Looking for chars 'i:' ioIs >> c2; if((c1!='i') || (c2!=':')) throw LOSR_RuntimeErrorM("Invalide format!"); if(!ioIs) throw LOSR_RuntimeErrorM("Premature end of stream!"); // Found what was needed, read glass refraction index ioIs >> mIndex; // Extract and ignore the rest of lines starting with a # for(ioIs >> c1; c1=='#'; ioIs >> c1) ioIs.getline(buf,2048,'\n'); if(!ioIs) throw LOSR_RuntimeErrorM("Premature end of stream!"); // Looking for chars 'a:' ioIs >> c2; if((c1!='a') || (c2!=':')) throw LOSR_RuntimeErrorM("Invalide format!"); if(!ioIs) throw LOSR_RuntimeErrorM("Premature end of stream!"); // Found what was needed, read aperture of the surface ioIs >> mAperture; // Extract and ignore the rest of lines starting with a # for(ioIs >> c1; c1=='#'; ioIs >> c1) ioIs.getline(buf,2048,'\n'); if(!ioIs) throw LOSR_RuntimeErrorM("Premature end of stream!"); // Looking for chars 't:' ioIs >> c2; if((c1!='t') || (c2!=':')) throw LOSR_RuntimeErrorM("Invalide format!"); if(!ioIs) throw LOSR_RuntimeErrorM("Premature end of stream!"); // Found what was needed, read distance to next surface ioIs >> mThickness; }

void Surface::write ( std::ostream & ioOs = std::cout ) const

Write a LOSR::Surface into a C++ output stream. Parameters: ioOs   Output stream to write the LOSR::Surface into. { ioOs << "c:" << mCurvature << " \ti:" << mIndex << " \ta:" << mAperture << " \tt:" << mThickness << std::endl; }

---

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

• Surface.hpp
• Surface.cpp

---