axlDataDynamicReader Class Reference

#include <axlDataDynamicReader.h>

Inheritance diagram for axlDataDynamicReader:

Public Member Functions
	axlDataDynamicReader (void)
	~axlDataDynamicReader (void)
axlAbstractData *	readInputs (axlDataDynamic *data, const QDomNode &node, const QList< axlAbstractData * > &list)
	Construct an axlAbstractData from a node and a list of data. More...
QString	identifier (void) const
QString	description (void) const
QStringList	handled (void) const
axlAbstractData *	dataByReader (axlAbstractDataReader *axl_reader, const QDomNode &node)
bool	accept (const QDomNode &node)
bool	reject (const QDomNode &node)
axlAbstractData *	read (const QDomNode &node)
Public Member Functions inherited from axlAbstractDataReader
	axlAbstractDataReader (void)
virtual	~axlAbstractDataReader (void)
void	setNameOf (axlAbstractData *data, const QDomElement &e)
void	setColorOf (axlAbstractData *data, const QDomElement &e)
void	setSizeOf (axlAbstractData *data, const QDomElement &e)
void	setShaderOf (axlAbstractData *data, const QDomElement &e)

Static Public Member Functions
static bool	registered (void)

Detailed Description

Definition at line 26 of file axlDataDynamicReader.h.

Constructor & Destructor Documentation

axlDataDynamicReader::axlDataDynamicReader

(

void

)

Definition at line 37 of file axlDataDynamicReader.cpp.

axlDataDynamicReader::~axlDataDynamicReader

(

void

)

Definition at line 42 of file axlDataDynamicReader.cpp.

Member Function Documentation

bool axlDataDynamicReader::accept ( const QDomNode &  node )

virtual

Implements axlAbstractDataReader.

Definition at line 67 of file axlDataDynamicReader.cpp.

axlAbstractData * axlDataDynamicReader::dataByReader	(	axlAbstractDataReader *	axl_reader,
		const QDomNode &	node
	)

Definition at line 422 of file axlDataDynamicReader.cpp.

QString axlDataDynamicReader::description

(

void

)

const

Definition at line 52 of file axlDataDynamicReader.cpp.

QStringList axlDataDynamicReader::handled

(

void

)

const

Definition at line 57 of file axlDataDynamicReader.cpp.

QString axlDataDynamicReader::identifier

(

void

)

const

Definition at line 47 of file axlDataDynamicReader.cpp.

axlAbstractData * axlDataDynamicReader::read ( const QDomNode &  node )

virtual

Implements axlAbstractDataReader.

Definition at line 82 of file axlDataDynamicReader.cpp.

axlAbstractData * axlDataDynamicReader::readInputs	(	axlDataDynamic *	data,
		const QDomNode &	node,
		const QList< axlAbstractData * > &	list
	)

Construct an axlAbstractData from a node and a list of data.

Parameters

data	: axlDataDynamic object to be constructed.
node	: node of the xml tree.
list	: list of data already constructed.

Returns

the axlAbstractData constructed from the node and the object list.

The node should be of the form

<process type="process_name" status="process_status">
  <input  .../> ...
  <parameter  .../> ...
  <output .../> ...
</process>

where

• process_name is the identifier of the process to be called.
• process_status is either
  • dynamic for a dynamic data,
  • static for a static data.
• <input ... />... corresponds to the list (possibly empty) of inputs of the process.
• <parameter ... />... corresponds to the list (possibly empty) of parameters of the process.
• <output ... />... corresponds to the list (possibly empty) of outputs of the process.

The process will read its input, will setup its parameters and will compute outputs that will be stored in the objects described in the output list.

The input, parameter, output items have the following tags:

• type="type_of_object" which can be
  • data for an axlAbstractData object specified by the tag name="...",
  • double for a double value specified by the tag value="...",
  • int for a int value specified by the tag value="...".
• name="name_of_an_object" to specify the name of the data to be used or to be computed.
• channel="an_integer" to specify which input or parameter channel is used.

Here is an example of an input assigned to be the axlPoint data named axlPoint1 on channel 2:

<input type="data" name="axlPoint1" channel="2" />

The output items can have color and shader attributes to describe their rendering. Here is an example of an output which will be named "surface0" and will appear in red:

<output name="surface0" color="255 0 0" />

Definition at line 206 of file axlDataDynamicReader.cpp.

bool axlDataDynamicReader::registered ( void  )

static

Definition at line 62 of file axlDataDynamicReader.cpp.

bool axlDataDynamicReader::reject ( const QDomNode &  node )

virtual

Implements axlAbstractDataReader.

Definition at line 77 of file axlDataDynamicReader.cpp.

---

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

• src/axlCore/axlDataDynamicReader.h
• src/axlCore/axlDataDynamicReader.cpp