class UIDocument

 GUI-independent memory representation for an XML Overflow document More...
Definition#include <data-flow/include/UIDocument.h>
InheritsObject
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Static Methods

Protected Methods

Protected Members

Detailed Description

GUI-independent memory representation for an XML Overflow document

vector<UINetwork *> networks

[protected]

Pointers to all networks included (defined) in the document

bool modified

[protected]

Flag is set to true anytime there's a change that hasn't been saved

UINodeRepository subnetInfo

[protected]

Info about all internal networks that can be included as nodes - I think (should be cleaned up)

vector<DocParameterDataText *> textParams

[protected]

Document parameters (should be re-written)

vector<ParameterText *> docInputs

[protected]

Input for the document if used as an external node

vector<ParameterText *> docOutputs

[protected]

Output for the document if used as an external node

vector<ParameterText *> docParams

[protected]

Parameters for the document if used as an external node

string docName

[protected]

File name (no path)

string path

[protected]

Document path

bool untitled

[protected]

True if document has no real name yet

 UIDocument (string _name)

Document constructor with name, DOES NOT load the document (document created as untitled)

~ UIDocument ()

[virtual]

Virtual destructor

void  load ()

[virtual]

Explicitly loads a document using the name specified at construction

void  loadXML (xmlNodePtr root)

[virtual]

Loads the document from a parsed XML tree

void  loadFromMemory (const char *mem, int size)

[virtual]

Loads the document from memory

void  setModified ()

Sets the 'modified' flag

void  resetModified ()

Resets the 'modified' flag

bool  isModified ()

Has the document been modified since last saved?

UINetwork * addNetwork (string name, UINetwork::Type type)

Add a network to the document

UINetwork * addNetwork (xmlNodePtr xmlNet)

Add a network to the document from an XML node (used in load())

void  removeNetwork (UINetwork *toRemove)

Remove and destroy network from the document

bool  isUntitled ()

Is the document untitled?

const string & getName ()

[virtual]

Document name (no path

const string & getPath ()

Document path

void  save ()

[virtual]

Save the document to file specified in internal variables 'path' and 'docName'

char * saveToMemory (int &size)

Convert document to an XML string in memory

void  addParameterText (string name, string value, string type)

UINetwork * getNetworkNamed (const string &n)

vector<ItemInfo *>  getNetInputs (const string &netName)

vector<ItemInfo *>  getNetOutputs (const string &netName)

vector<ItemInfo *>  getNetParams (const string &netName)

string  getDescription (const string &type)

void  printOn (ostream &out=cout)

[const]

A UIDocument can print itself

Reimplemented from Object.

vector<UINetwork *>  get_networks ()

vector<DocParameterDataText *>  get_textParams ()

UINetwork * newNetwork (const string &_name, UINetwork::Type type)

[virtual]

UINetwork * newNetwork (xmlNodePtr _net)

[virtual]

Network * build (const string &_name, const ParameterSet &params)

set<string>  genCode (ostream &out, const string &functName, bool localIncludes=false)

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

Network * buildExternal (const string &type, const string &_name, const ParameterSet &params)

[static]

void  run ()

[virtual]

void  run (ParameterSet &p)

[virtual]

void  setFullPath (const string &fullpath)

[virtual]

void  updateNetInfo (UINetwork *net)

void  updateAllNetworks ()

string  findExternal (const string &filename, char *searchPath="VFLOW_PATH", bool include_home=true, bool fullPathOutput=true)

[static]

void  genCodeExternal (const string &type, ostream &out, int &id, set<string> &nodeList)

[static]

void  updateAllSubnetTerminals (const string _nettype, const string _terminalname, UINetTerminal::NetTermType _terminaltype, bool _remove)

[virtual]

void  error (char *err)

[protected virtual]