Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members

FD::UINode Class Reference

#include <UINode.h>

Inheritance diagram for FD::UINode:

Inheritance graph
[legend]
Collaboration diagram for FD::UINode:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 UINode (UINetwork *_net, std::string _name, std::string _type, double x, double y, bool doInit=1)
 UINode (UINetwork *_net, xmlNodePtr def, bool doInit=1)
virtual ~UINode ()
const std::string & getName ()
const std::string & getType ()
UINetworkgetNetwork ()
virtual void rename (const std::string &newName)
virtual void addTerminal (const std::string &_name, UINetTerminal::NetTermType _type, const std::string &_objType="any", const std::string &_description="No description available")
virtual void removeTerminal (const std::string &_name, UINetTerminal::NetTermType _type)
void saveXML (xmlNode *root)
UITerminal * getInputNamed (std::string n)
UITerminal * getOutputNamed (std::string n)
void getPos (double &xx, double &yy)
void setPos (double new_x, double new_y)
void setNodeParameters (UINodeParameters *params)
void insertNetParams (std::vector< ItemInfo * > &params)
void updateNetParams (std::vector< ItemInfo * > &params)
virtual void notifyError (const std::string &message)
virtual UILink * newLink (UITerminal *_from, UITerminal *_to)
virtual UINetTerminal * newNetTerminal (UITerminal *_terminal, UINetTerminal::NetTermType _type, const std::string &_name, const std::string &_objType="any", const std::string &_description="No description available")
virtual UINodeParameters * newNodeParameters (UINode *_node, std::string type)
virtual void redraw ()
Nodebuild (const ParameterSet &params)
void genCode (std::ostream &out, int &id, std::set< std::string > &nodeList)
std::vector< UITerminal * > getInputs ()
std::vector< UITerminal * > getOutputs ()
UINodeParameters * getParameters ()
std::string getDescription ()
std::string getComments () const

Protected Attributes

bool destroyed
std::string name
UINetworknet
std::string type
std::string description
double x
double y
double xtmp
double ytmp
std::vector< UITerminal * > inputs
std::vector< UITerminal * > outputs
UINodeParameters * parameters

Friends

class UINetwork

Detailed Description

UINode is the represantation used to store data for any node, either in the GUI or in batch mode. A UINode cannot perform any operation but can be used to build a real Node.
Author:
Jean-Marc Valin


Constructor & Destructor Documentation

FD::UINode::UINode UINetwork _net,
std::string  _name,
std::string  _type,
double  x,
double  y,
bool  doInit = 1
 

"Normal" constructor

FD::UINode::UINode UINetwork _net,
xmlNodePtr  def,
bool  doInit = 1
 

Constructor from XML parse tree

virtual FD::UINode::~UINode  )  [virtual]
 

Destructor


Member Function Documentation

virtual void FD::UINode::addTerminal const std::string &  _name,
UINetTerminal::NetTermType  _type,
const std::string &  _objType = "any",
const std::string &  _description = "No description available"
[virtual]
 

Adds a new terminal to a node

void FD::UINode::genCode std::ostream &  out,
int &  id,
std::set< std::string > &  nodeList
 

Generate C++ code for building the document, instead of using XML

UITerminal* FD::UINode::getInputNamed std::string  n  ) 
 

Returns the input (terminal) corresponding to a certain name

const std::string& FD::UINode::getName  )  [inline]
 

Returns the node name

UINetwork* FD::UINode::getNetwork  )  [inline]
 

Returns the corresponding network

UITerminal* FD::UINode::getOutputNamed std::string  n  ) 
 

Returns the output (terminal) corresponding to a certain name

void FD::UINode::getPos double &  xx,
double &  yy
[inline]
 

Returns the node position

const std::string& FD::UINode::getType  )  [inline]
 

Returns the node type

virtual void FD::UINode::removeTerminal const std::string &  _name,
UINetTerminal::NetTermType  _type
[virtual]
 

Removes a terminal from a node

virtual void FD::UINode::rename const std::string &  newName  )  [virtual]
 

Rename a node (when network included as a subnet)

void FD::UINode::saveXML xmlNode *  root  ) 
 

Save to an XML parse tree

void FD::UINode::setPos double  new_x,
double  new_y
[inline]
 

Changes the position (not too sure it should be used


Member Data Documentation

std::string FD::UINode::description [protected]
 

Node description (unused?)

bool FD::UINode::destroyed [protected]
 

Not too sure what I was thinking when I wrote that

std::vector<UITerminal *> FD::UINode::inputs [protected]
 

Pointers to all the inputs

std::string FD::UINode::name [protected]
 

Node name

UINetwork* FD::UINode::net [protected]
 

The network in which the node is included

std::vector<UITerminal *> FD::UINode::outputs [protected]
 

Pointers to all the outputs

UINodeParameters* FD::UINode::parameters [protected]
 

All the node parameters

std::string FD::UINode::type [protected]
 

Node type (either the name of the .n or the builtin Node subclass)

double FD::UINode::x [protected]
 

Position on the canvas

double FD::UINode::xtmp [protected]
 

Temporary position used in move operations


The documentation for this class was generated from the following file:
Generated on Wed Oct 5 14:30:08 2005 for FlowDesigner by  doxygen 1.4.4