InstantIO::Node Class Reference

Node class More...

#include <InstantIO/Node.h>

Inheritance diagram for InstantIO::Node:

List of all members.

Public Types
enum	State { NODE_RUNNING, NODE_SLEEPING, NODE_ERROR, NODE_DISABLED }
	Enumeration of the different states of the Node.
typedef std::vector< std::string >	LogVector
	Defines the log vector.
Public Member Functions
	Node ()
	Constructor.
virtual	~Node ()
	Destructor.
virtual std::string	typeName () const
	Returns the type name of the Namespace.
State	getState () const
	Returns the State of the Node object.
std::string	getShortInfo () const
	Returns a short information string.
virtual std::string	getDetailedInfo () const
	Returns a detailed information string.
void	getLog (LogVector &entries) const
	Returns the entries of the log.
virtual void	setFieldValue (const std::string &name, const std::string &value)
	Sets the value of a field.
virtual std::string	getFieldValue (const std::string &name) const
	Returns the value of a field.
virtual void	getFieldNames (std::vector< std::string > &names) const
	Returns the names of all fields.
virtual NodeType *	type () const
	Returns the type of the Node.
Protected Member Functions
void	setState (State state)
	Sets the State of the Node.
void	setState (State state, const std::string &shortInfo)
	Sets the State of the Node.
void	setShortInfo (const std::string &shortInfo)
	Sets the short information string.
void	addLog (const std::string &entry)
	Adds an entry to the log.
virtual void	initialize ()
	Gets called when the Node is enabled.
virtual void	shutdown ()
	Gets called when the Node is disabled.
virtual void	start ()
	Gets called when the first InSlot is connected to the Node.
virtual void	stop ()
	Gets called when the last InSlot is disconnected from the Node.
virtual void	startOutSlot (BasicOutSlot &outSlot)
	Implementation of the BasicOutSlot::Listener::startOutSlot method.
virtual void	stopOutSlot (BasicOutSlot &outSlot)
	Implementation of the BasicOutSlot::Listener::stopOutSlot method.
virtual void	startInSlot (BasicInSlot &inSlot)
	Implementation of the BasicInSlot::Listener::startInSlot method.
virtual void	stopInSlot (BasicInSlot &inSlot)
	Implementation of the BasicInSlot::Listener::stopInSlot method.

---

Detailed Description

Node class

---

Constructor & Destructor Documentation

InstantIO::Node::Node

(

)

Constructor.

Creates a new Node object.

virtual InstantIO::Node::~Node

(

)

[virtual]

Destructor.

Destroys a Node object.

---

Member Function Documentation

virtual std::string InstantIO::Node::typeName

(

)

const [virtual]

Returns the type name of the Namespace.

Returns:

The type name.

Reimplemented from InstantIO::Namespace.

State InstantIO::Node::getState

(

)

const

Returns the State of the Node object.

Returns the State of the Node object.

Returns:

The State

std::string InstantIO::Node::getShortInfo

(

)

const

Returns a short information string.

Returns a short information string.

Returns:

The short information string

virtual std::string InstantIO::Node::getDetailedInfo

(

)

const [virtual]

Returns a detailed information string.

Returns:

A string containing detailed information.

void InstantIO::Node::getLog

(

LogVector &

entries

)

const

Returns the entries of the log.

Parameters:

entries

The vector that gets filled with the entries of the log.

virtual void InstantIO::Node::setFieldValue	(	const std::string &	name,
		const std::string &	value
	)			[virtual]

Sets the value of a field.

Parameters:

	name	The name of the field.
	value	The new value of the field.

Reimplemented from InstantIO::Namespace.

virtual std::string InstantIO::Node::getFieldValue

(

const std::string &

name

)

const [virtual]

Returns the value of a field.

Parameters:

name

The name of the field.

Returns:

The value of the field.

Reimplemented from InstantIO::Namespace.

virtual void InstantIO::Node::getFieldNames

(

std::vector< std::string > &

names

)

const [virtual]

Returns the names of all fields.

Parameters:

names

A vector that gets filled with the names.

Reimplemented from InstantIO::Namespace.

virtual NodeType* InstantIO::Node::type

(

)

const [virtual]

Returns the type of the Node.

Returns the type of the Node.

Returns:

The type of the Node

void InstantIO::Node::addLog

(

const std::string &

entry

)

[protected]

Adds an entry to the log.

Parameters:

entry

The new entry.

---

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

• Node.h