XAO::Xao Class Reference

The Xao class describes the XAO format. More...

Public Member Functions
	Xao ()
	Default constructor. More...
	Xao (const std::string &author, const std::string &version)
	Constructor with author and version. More...
virtual	~Xao ()
	Destructor. More...
const std::string	getAuthor () const
	Gets the author of the file. More...
void	setAuthor (const std::string &author)
	Sets the author of the file. More...
const std::string	getVersion () const
	Gets the version of the file. More...
void	setVersion (const std::string &version)
	Sets the version of the file. More...
Geometry *	getGeometry () const
	Gets the geometry. More...
void	setGeometry (Geometry *geometry)
	Sets the geometry. More...
int	countGroups () const
	Gets the number of groups. More...
Group *	getGroup (int index)
	Gets a group. More...
Group *	addGroup (XAO::Dimension dim, const std::string &name=std::string(""))
	Adds a group. More...
bool	removeGroup (Group *group)
	Removes a group. More...
int	countFields () const
	Gets the number of fields. More...
XAO::Type	getFieldType (int index)
	Gets the type of a field. More...
Field *	getField (int index)
	Gets a field. More...
BooleanField *	getBooleanField (int index)
DoubleField *	getDoubleField (int index)
IntegerField *	getIntegerField (int index)
StringField *	getStringField (int index)
Field *	addField (XAO::Type type, XAO::Dimension dim, int nbComponents, const std::string &name=std::string(""))
	Adds a field. More...
BooleanField *	addBooleanField (XAO::Dimension dim, int nbComponents, const std::string &name=std::string(""))
IntegerField *	addIntegerField (XAO::Dimension dim, int nbComponents, const std::string &name=std::string(""))
DoubleField *	addDoubleField (XAO::Dimension dim, int nbComponents, const std::string &name=std::string(""))
StringField *	addStringField (XAO::Dimension dim, int nbComponents, const std::string &name=std::string(""))
bool	removeField (Field *field)
	Removes a field. More...
bool	exportXAO (const std::string &fileName, const std::string &shapeFileName)
	Exports this XAO object to a file. More...
const std::string	getXML ()
	Gets the XML corresponding to this XAO. More...
bool	importXAO (const std::string &fileName)
	Imports an XAO file into this object. More...
bool	setXML (const std::string &xml)
	Sets an XML describing an XAO format to this object. More...

Detailed Description

The Xao class describes the XAO format.

Constructor & Destructor Documentation

Xao() [1/2]

Xao::Xao

(

)

Default constructor.

Xao() [2/2]

Xao::Xao	(	const std::string &	author,
		const std::string &	version
	)

Constructor with author and version.

Parameters

author	the author of the file.
version	the version of the XAO format.

~Xao()

Xao::~Xao ( )

virtual

Destructor.

Member Function Documentation

getAuthor()

const std::string XAO::Xao::getAuthor ( ) const

inline

Gets the author of the file.

Returns

the author of the file.

setAuthor()

void XAO::Xao::setAuthor ( const std::string &  author )

inline

Sets the author of the file.

Parameters

author

the author to set.

getVersion()

const std::string XAO::Xao::getVersion ( ) const

inline

Gets the version of the file.

Returns

the version of the file.

setVersion()

void XAO::Xao::setVersion ( const std::string &  version )

inline

Sets the version of the file.

Parameters

version

the version to set.

getGeometry()

Geometry* XAO::Xao::getGeometry ( ) const

inline

Gets the geometry.

Returns

the geometry.

setGeometry()

void XAO::Xao::setGeometry ( Geometry *  geometry )

inline

Sets the geometry.

Parameters

geometry

the geometry to set.

countGroups()

int Xao::countGroups

(

)

const

Gets the number of groups.

Returns

the number of groups.

getGroup()

Group * Xao::getGroup

(

int

index

)

Gets a group.

Parameters

index

the index of the wanted group.

Returns

the group.

addGroup()

Group * Xao::addGroup	(	XAO::Dimension	dim,
		const std::string &	name = std::string("")
	)

Adds a group.

Parameters

dim	the dimension of the group.
name	the name of the group.

Returns

the created group.

removeGroup()

bool Xao::removeGroup

(

Group *

group

)

Removes a group.

Parameters

group

the group to remove.

Returns

true if the group has been removed, false otherwise.

countFields()

int Xao::countFields

(

)

const

Gets the number of fields.

Returns

the number of fields.

getFieldType()

XAO::Type Xao::getFieldType

(

int

index

)

Gets the type of a field.

Parameters

index

the index of the wanted field.

Returns

the type of the field.

getField()

Field * Xao::getField

(

int

index

)

Gets a field.

Parameters

index

the index of the wanted field.

Returns

the field.

addField()

Field * Xao::addField	(	XAO::Type	type,
		XAO::Dimension	dim,
		int	nbComponents,
		const std::string &	name = std::string("")
	)

Adds a field.

Parameters

type	the type of the field.
dim	the dimension of the field.
nbComponents	the number of components in the field.
name	the name of the field.

Returns

the created field.

removeField()

bool Xao::removeField

(

Field *

field

)

Removes a field.

Parameters

field

the field to remove.

Returns

true if the field has been removed, false otherwise.

exportXAO()

bool Xao::exportXAO	(	const std::string &	fileName,
		const std::string &	shapeFileName
	)

Exports this XAO object to a file.

Parameters

fileName	the name of the file to create.
shapeFileName	if not empty, export the shape to this external file.

Returns

true is the export is successful.

getXML()

const std::string Xao::getXML

(

)

Gets the XML corresponding to this XAO.

Returns

the XML as a string.

importXAO()

bool Xao::importXAO

(

const std::string &

fileName

)

Imports an XAO file into this object.

Parameters

fileName

the name of the file to import.

Returns

true if the import is successful.

setXML()

bool Xao::setXML

(

const std::string &

xml

)

Sets an XML describing an XAO format to this object.

Parameters

xml	the XML to set.

Returns

true if the import is successful.