class LoopTableNode

A LoopTableNode is a table of rows in a DataLoopNode.

Inheritance:

Public Methods
Public Members
class const_iterator: This iterator class is meant to behave just like the iterator class inside an STL vector.
class iterator: This iterator class is meant to behave just like the iterator class inside an STL vector.
Protected Methods

Inherited from ASTnode:

Public Methods
bool NotVirtualIsOfType( ASTtype T )
virtual void copyFrom( const ASTnode &copyFromMe )
virtual ASTnode* myParent(void)
virtual bool removeChild( ASTnode* child )
virtual bool removeMe( void )
virtual List<ASTnode*> * searchByTag( char* searchFor)
virtual List<ASTnode*> * searchByTag( string &searchFor)
virtual void setParent( ASTnode* p )
virtual bool unlinkMe( void )

Public Members
enum ASTtype

Protected Methods
void printIndent(int indent)

Inherited from ASTnodeWithPosBits:

Documentation

A LoopTableNode is a table of rows in a DataLoopNode.
You can think of a loop in a STAR file as being a table of values, with each iteration of the loop being a row on the table. This is the view taken by the starlib. Things are further complicated by the fact that each row of the table can have another table under it (another nesting level), but even then, those tables are the same structure as the outermost one.
Thus, this class, LoopTableNode, stores a table at some arbitrary nesting level in the loop. A simple singly nested loop will have only one loop table node, but a multiply nested loop will have a whole tree of loop tables.

iterator begin()

iterator end()

const_iterator begin() const

const_iterator end() const

size_type size() const

bool empty() const

reference operator[]( size_type n )

const_reference operator[]( size_type n) const

reference front()

const_reference back() const

const_reference front() const

reference back()

void reserve( size_type n )

int getNumCols( void )

Gets the number of columns in this LoopTableNode, by looking up at the list of names for this loop. If this LoopTableNode is not inside a DataLoopNode yet, then a zero is returned.

virtual ~LoopTableNode()

virtual void Unparse(int indent)

virtual ASTnode::ASTtype myType(void)

virtual bool isOfType( ASTtype T )

void setTabFlag( bool setTo ) bool getTabFlag( void ) Sets (or gets) the tabulation flag for this loop, and all nested loops inside it. Sets (or gets) the tabulation flag for this loop, and all nested loops inside it. true = tab, false = linear. void setRowsPerLine( int setTo ) bool getRowsPerLine( void ) const Sets (or gets) the number of loop iterations to print on one line of text when unparsing. Sets (or gets) the number of loop iterations to print on one line of text when unparsing. This only has meaning when the loop is tabulated, and is ignored when the loop is linearly printed. The default is 1. void setIndentFlag( bool setTo ) bool getIndentFlag( void ) const Sets (or gets) the boolean flag for whether or not to indent the values in this loop. Sets (or gets) the boolean flag for whether or not to indent the values in this loop. When a loop is first constructed, the default is "true". LoopTableNode(const string &tflag, bool indentFl = true, int rowsPerLn = 1 ) LoopTableNode( bool tflag ) call with tflag = true for "tabulate" or false for "linear" LoopTableNode( LoopIter& I) Copy Constructor LoopTableNode( bool link, LoopIter& I) Copy with parallel link. Set "link" to true to create a copy with a parallel link, or set it to false to create a copy without a parallel link. See the external documentation for more details on parallel copies. Insertions/Deletions. Insertions/Deletions. These cannot be done in exactly the same syntax as vector<> because we need to check for things that are illegal in STAR and disallow them. However, it should look quite familiar to someone who is fluent in the STL vector class. bool insert( iterator pos, LoopRowNode &v ) * Insert - Insert before 'pos', the LoopRowNode given. If the * LoopRowNode given has the wrong number of values, it * will fail and return false, else it returns true. * * (This function makes a copy of the passed LoopRowNode, it does not use * the passed LoopRowNode itself (in other words, you can delete * it after calling (The LoopRowNode and the DataValueNodes IN the * LoopRowNode).) * * This version makes a deep copy of the node given: bool insert( iterator pos, LoopRowNode* v ) This version makes a link to the node given, so don't delete it afterword: (You are "giving" the new node to the class after having allocated it yourself) bool insert( iterator pos, LoopTableNode &t ) * Insert - Insert before 'pos', the table of data given * by the LoopTableNode. If the layout of values is not * consistent with the layout defined by the names * in the DataLoopNode, it will fail and return false, * else it returns true. * (This function performs a DEEP COPY of the given loop node, so everything in the passed argument can be deleted after calling, if it is appropriate.) bool insert( iterator pos, LoopTableNode* t ) This version makes a shallow link instead of a deep copy, so do not delete the node after passing it. (You are "giving" the node to the library, after having allocated it yourself.) void erase( iterator pos ) erase - Remove the row (LoopRowNode) given. If there is any nested table under it, it gets removed as well. void erase( iterator from, iterator to ) erase - Remove the range of rows given, using typical STL range conventions: The range is inclusive of the start, but exclusive of the end: [from,to) These types are used with the STL vector look-alike functions: These types are used with the STL vector look-alike functions: typedef value_type* pointer typedef const value_type* const_pointer typedef value_type& reference typedef const value_type& const_reference typedef size_t size_type typedef size_t difference_type

List<int> * checkValueAlignment(void)

Test the Loop Table to see if there are any lines where the values on the line don't "align" with the names in the taglist. For a loop row to be "aligned", it must match the following criteria:
- If the loop is linear, then all rows are aligned no matter what.
- If the loop is tabular, then each LoopRowNode must have had all its values on the same text line in the original file for the loop to be aligned. (Exception: If any of the values in the LoopRowNode is a semicolon string, then give up on trying to check for alignment and assume the row is aligned.)

Notes:
- You need to delete the List returned when done with it. - The List returned will be of zero size if no misalignments were found. It never returns as NULL.

void addValue(const DataLoopNameListNode::Status dstat, const int row, const int currRow, DVNWithPos* value)