PKFmanip Class Reference
[libbiarc]

The PKFmanip class for storing and manipulating biarc curves. More...

#include <include/PKFmanip.h>

Inheritance diagram for PKFmanip:

List of all members.

Public Member Functions
	PKFmanip ()
	PKFmanip (const PKFmanip &h)
PKFmanip &	operator= (const PKFmanip &h)
	~PKFmanip ()
void	header (const char *name="No name", const char *etic="", const char *cite="", const char *history="")
void	setName (const char *name)
void	setEtic (const char *etic)
void	setCite (const char *cite)
void	setHistory (const char *history)
const char *	getName () const
const char *	getEtic () const
const char *	getCite () const
const char *	getHistory () const
int	readHeader (istream &in)
int	writeHeader (ostream &out)
Friends
ostream &	operator<< (ostream &out, PKFmanip &c)

---

Detailed Description

The PKFmanip class for storing and manipulating biarc curves.

---

Constructor & Destructor Documentation

PKFmanip::PKFmanip

(

)

Constructs an empty curve and sets the header to "No name","","",""

References header().

PKFmanip::PKFmanip

(

const PKFmanip &

h

)

Copy constructor.

See also:

operator=

PKFmanip::~PKFmanip

(

)

Delete the header string and destroy the PKFmanip instance.

---

Member Function Documentation

PKFmanip & PKFmanip::operator=

(

const PKFmanip &

h

)

Assign operator. Copies the header strings from h.

References getCite(), getEtic(), getHistory(), getName(), and header().

void PKFmanip::header	(	const char *	name = "No name",
		const char *	etic = "",
		const char *	cite = "",
		const char *	history = ""
	)

Change the current header. name is the name of the curve. etic is citation of people at the origin of this particular curve. cite is the people to cite if this curve is used further. history, comments or other infos about the curve.

Default values : "No name","","",""

See also:

setName(),setEtic(),setCite(),setHistory()

References setCite(), setEtic(), setHistory(), and setName().

Referenced by Curve< Vector >::operator+(), Curve< Vector >::operator-(), operator=(), and PKFmanip().

void PKFmanip::setName

(

const char *

name

)

Set the name of the curve.

See also:

setEtic(),setCite(),setHistory()

Referenced by header().

void PKFmanip::setEtic

(

const char *

etic

)

Set the etic string of the curve.

See also:

setName(),setCite(),setHistory()

Referenced by header().

void PKFmanip::setCite

(

const char *

cite

)

Set the cite string of the curve.

See also:

setName(),setEtic(),setHistory()

Referenced by header().

void PKFmanip::setHistory

(

const char *

history

)

Set the history string of the curve.

See also:

setName(),setEtic(),setCite()

Referenced by header().

const char * PKFmanip::getName

(

)

const

Returns a pointer to the name of the curve.

See also:

getEtic(),getCite(),getHistory()

Referenced by Curve< Vector >::operator+(), Curve< Vector >::operator-(), and operator=().

const char * PKFmanip::getEtic

(

)

const

Returns a pointer to the etic string.

See also:

getName(),getCite(),getHistory()

Referenced by Curve< Vector >::operator+(), Curve< Vector >::operator-(), and operator=().

const char * PKFmanip::getCite

(

)

const

Returns a pointer to the cite string.

See also:

getName(),getEtic(),getHistory()

Referenced by Curve< Vector >::operator+(), Curve< Vector >::operator-(), and operator=().

const char * PKFmanip::getHistory

(

)

const

Returns a pointer to the history string.

See also:

getName(),getEtic(),getCite()

Referenced by Curve< Vector >::operator+(), Curve< Vector >::operator-(), and operator=().

int PKFmanip::readHeader

(

istream &

in

)

Read the PKF header from a stream object in. Returns 1 if all is ok, 0 otherwise. More details about the PKF format are given in classes that inherit the PKFmanip class. I.e. Curve, CurveBundle ...

See also:

writeHeader()

Referenced by TubeBundle< Vector >::readPKF(), CurveBundle< Vector >::readPKF(), and Curve< Vector >::readPKF().

int PKFmanip::writeHeader

(

ostream &

out

)

Writes the PKF header to an ostream object out. Returns 1 if all went well, zero otherwise.

See also:

readPKF()

Referenced by CurveBundle< Vector >::writePKF(), and Curve< Vector >::writePKF().

---

Friends And Related Function Documentation

ostream & PKFmanip::operator<<	(	ostream &	out,
		PKFmanip &	c
	)			[friend]

Overloaded left shift operator. Writes the current PKFmanip object c to the ostream object out. If there is an interpolated curve, this function prints point/tangent,matching point/tangent of all the biarcs of the curve. For non valid biarcs only the point/tangent data is written to the stream.

---

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

• include/PKFmanip.h
• lib/PKFmanip.cpp