Contains the things that are inside of a saveframe

Inheritance:

Public Methods

StarFileNode::Status	AddDataItem (const string & name, const string & value, DataValueNode::ValType type) DEPRECIATED - use the STL vector operations instead
void	AddItemToSaveFrame (DataNode* S) DEPRECIATED - use the STL vector operations instead
StarFileNode::Status	AddLoop (const string &tflag) DEPRECIATED - use the STL vector operations instead
StarFileNode::Status	AddLoopDataName (const string & name) DEPRECIATED - use the STL vector operations instead
StarFileNode::Status	AddLoopDataValue ( const string & value, DataValueNode::ValType type ) DEPRECIATED - use the STL vector operations instead
ASTlist<DataNode*> *	GiveMyDataList () Returns the list (STL vector) of the insides of the save frame.
DataNode*	ReturnSaveFrameDataNode (string dataItemName) Given a name of a DataItemNode or the first tag of a DataLoopNode, returns the matching DataNode
DataNode*	ReturnSaveFrameDeepLook ( string dataItemName, int* nest, int* col ) DEPRECIATED - use searchByTag instead @see searchByTag
virtual void	Unparse (int indent)
virtual bool	isOfType ( ASTtype T )
virtual int	myLongestStr ( void ) Returns the length of the longest string in this object.
virtual ASTnode::ASTtype	myType (void)
virtual List<ASTnode*> *	searchByTag ( string &searchFor ) Given a tag name, find the AST object it resides in.
virtual List<ASTnode*> *	searchByTagValue ( string &tag, string &value ) Given a tag name and a value, find the AST object that that particular tag and value pair resides in.
virtual List<ASTnode*> *	searchForType ( ASTtype type, int delim = -1 ) This method returns a list of all the nodes of the given type that are inside this node, or children of this node, or children of children of this node, etc all the way down to the leaf nodes.
virtual bool	unlinkChild ( ASTnode* child ) unlinks the given ASTnode from this ASTnode, assuming that the given ASTnode is a child of this ASTnode.
virtual	~SaveFrameListNode ()

Public Members

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 void setParent( ASTnode* p )

virtual bool unlinkMe( void )

Public Members

enum ASTtype

Protected Methods

void printIndent(int indent)

Documentation

Contains the things that are inside of a saveframe

SaveFrameListNode(ASTlist<DataNode* >* L)

SaveFrameListNode()

Make an empty list:

SaveFrameListNode(SaveFrameListNode &L)

Copy Constructor

SaveFrameListNode( bool link, SaveFrameListNode &L)

for more details on parallel copies

virtual ~SaveFrameListNode()

DataNode* ReturnSaveFrameDataNode(string dataItemName)

Given a name of a DataItemNode or the first tag of a DataLoopNode, returns the matching DataNode

ASTlist<DataNode*> * GiveMyDataList()

Returns the list (STL vector) of the insides of the save frame. This list is directly manipulatable such that if you add or erase from it it changes the insides of the save frame.

virtual void Unparse(int indent)

virtual ASTnode::ASTtype myType(void)

virtual bool isOfType( ASTtype T )

StarFileNode::Status AddDataItem(const string & name, const string & value, DataValueNode::ValType type)

DEPRECIATED - use the STL vector operations instead

StarFileNode::Status AddLoop(const string &tflag)

DEPRECIATED - use the STL vector operations instead

StarFileNode::Status AddLoopDataName(const string & name)

DEPRECIATED - use the STL vector operations instead

StarFileNode::Status AddLoopDataValue( const string & value, DataValueNode::ValType type )

DEPRECIATED - use the STL vector operations instead

void AddItemToSaveFrame(DataNode* S)

DEPRECIATED - use the STL vector operations instead

DataNode* ReturnSaveFrameDeepLook( string dataItemName, int* nest, int* col )

DEPRECIATED - use searchByTag instead @see searchByTag

virtual List<ASTnode*> * searchByTag( string &searchFor )

Given a tag name, find the AST object it resides in. It returns a pointer to the lowest level AST object that the tag resides in. The caller of this function needs to use the isOfType() and/or myType() methods to determine what type to cst the object. Returns a NULL if nothing was found.

This search is case-insensitive. The names of things, according to the STAR specification, are supposed to be case-insensitive. This is being applied not only to tag names but also to saveframe names and datablock names.

WARNING: The list returned is allocated in heap space. It is the caller's responsibility to delete the list after it is no longer needed.

Parameters:

searchFor - Look for this string as the tag name.

virtual List<ASTnode*> * searchForType( ASTtype type, int delim = -1 )

This method returns a list of all the nodes of the given type that are inside this node, or children of this node, or children of children of this node, etc all the way down to the leaf nodes.

Parameters:

type - the type to search for
delim - the delimiter to search for if searching for DataValueNodes. The default is "dont-care".

virtual List<ASTnode*> * searchByTagValue( string &tag, string &value )

Given a tag name and a value, find the AST object that that particular tag and value pair resides in. This is like performing an SQL search: WHERE tag = value.

This search is case-insensitive. The names of things, according to the STAR specification, are supposed to be case-insensitive. This is being applied not only to tag names but also to saveframe names and datablock names.

(However, the values are case-sensitive. A search for a tag of _t1 is identical to a search for a tag of _T1, but a search for a value of "V1" is different from a search for a value of "v1".)

WARNING: The list returned is allocated in heap space. It is the caller's responsibility to delete the list after it is no longer needed.

Parameters:

- tag Look for this tag...
value - ...where it has this value.

virtual bool unlinkChild( ASTnode* child )

unlinks the given ASTnode from this ASTnode, assuming that the given ASTnode is a child of this ASTnode. Does NOT call the destructor of the child node!! Use this function to remove the child from this ASTnode but not free it's space. RETURNS: true if the child was unlinked. false if the given ASTnode was not even in this class anywhere, and therefore nothing was done. This function MUST be overridden for each subclass of ASTnode.

virtual int myLongestStr( void )

Returns the length of the longest string in this object. Used by Unparse() at various levels of the AST tree. (In this case it is the longest tagname of a DataItem (not loop): )

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java