bil::Element Class Reference

An element of a primitive. More...

#include <xdlrc/model/Element.hpp>

List of all members.

Public Member Functions
	Element ()
	Constructs a new Element instance.
std::string &	name ()
	Gets element name.
const std::string &	name () const
	Gets element name read only.
ConfigurationOptions &	options ()
	Gets configuration options.
const ConfigurationOptions &	options () const
	Gets configuration options read only.
void	clear ()
	Resets all properties to default values.

Friends
void	writeBinary (const Element &data, std::ostream &outputStream)
	Writes data from a Element into a binary stream.
void	readBinary (Element &data, std::istream &inputStream)
	Reads data into a Element from a binary stream.

---

Detailed Description

An element of a primitive.

Elements are configurable subunits of primitives. Each element has got an unique name inside its primitive and a list of configuration options. Each single option denotes a distinct configuration of the whole element.

Definition at line 28 of file Element.hpp.

---

Constructor & Destructor Documentation

Element::Element

(

)

Constructs a new Element instance.

Definition at line 11 of file Element.cpp.

---

Member Function Documentation

std::string & Element::name

(

)

Gets element name.

Returns:

The name.

Definition at line 19 of file Element.cpp.

const std::string & Element::name

(

)

const

Gets element name read only.

Returns:

The name.

Definition at line 25 of file Element.cpp.

ConfigurationOptions & Element::options

(

)

Gets configuration options.

Returns:

The configuration options.

Definition at line 31 of file Element.cpp.

const ConfigurationOptions & Element::options

(

)

const

Gets configuration options read only.

Returns:

The configuration options.

Definition at line 37 of file Element.cpp.

void Element::clear

(

)

Resets all properties to default values.

Definition at line 43 of file Element.cpp.

---

Friends And Related Function Documentation

void writeBinary ( const Element &  data, std::ostream &  outputStream  )

friend

Writes data from a Element into a binary stream.

Parameters:

data	The Element to write.
outputStream	The stream to write into.

Exceptions:

.

void readBinary ( Element &  data, std::istream &  inputStream  )

friend

Reads data into a Element from a binary stream.

Parameters:

data	The Element to read into.
inputStream	The stream to read from.

Exceptions:

.

---

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

• xdlrc/model/Element.hpp
• xdlrc/model/Element.cpp