This is a save frame from the STAR file
![]() | AddDataItem (const string & name, const string & value, DataValueNode::ValType type ) DEPRECIATED - use the STL vector operations instead. |
![]() | AddItemToSaveFrame (DataNode* S) DEPRECIATED - use the STL vector operations instead. |
![]() | AddLoop (const string &tflag = string("tabulate")) DEPRECIATED - use the STL vector operations instead. |
![]() | AddLoopDataName (const string & name) DEPRECIATED - use the STL vector operations instead. |
![]() | AddLoopDataValue ( const string & value, DataValueNode::ValType type ) DEPRECIATED - use the STL vector operations instead. |
![]() | changeName (const string &name) Set the name of this saveframe |
![]() | GiveMyDataList () Return the list (STL vector) of the DataItemNodes and DataLoopNodes in this saveframe |
![]() | isOfType ( ASTtype T ) |
![]() | myLongestStr ( void ) const Returns the length of the longest string in this object |
![]() | myName () const Return the name of this saveframe. (includes the "save_" prefix |
![]() | myType (void) |
![]() | returnLoopValues (const string & tagName) DEPRECIATED - use the STL vector operations instead. |
![]() | ReturnSaveFrameDataNode (string dataItemName) Given a name of a DataItem, return it (or NULL if it can't be found). |
![]() | ReturnSaveFrameDeepLook ( string dataItemName, int *nest, int *col ) DEPRECIATED - use searchByTag instead @see searchByTag |
![]() | searchByTag ( const string &searchFor ) Given a tag name, find the AST object it resides in |
![]() | searchByTagValue ( const string &tag, const string &value ) Given a tag name and a value, find the AST object that that particular tag and value pair resides in |
![]() | 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 |
![]() | unlinkChild ( ASTnode *child ) remove the child from this ASTnode but not free it's space. |
![]() | Unparse (int indent) |
![]() | Unparse (int indent, int padsize ) |
![]() | ~SaveFrameNode () Destructor. |
![]() | | ||||||||
![]() |
|
This is a save frame from the STAR file
SaveFrameNode::SaveFrameNode( SaveFrameNode &S )
SaveFrameNode::SaveFrameNode( bool link, SaveFrameNode &S )
In the interest of saving memory, the preComment ability
only exists at the level of saveframenodes and blocknodes.
If you attempt to use these functions at other levels,
nothing will happen (the comment will always be empty).
The string must contain the comment characters embedded
inside, like so: "# this is a\n# multiline comment.",
not like this: "this is a\nmultiline comment." This is
so that the caller is allowed to have the comment contain
blank lines like this:
Note that the comment lines are not syntax-checked in any way, so
using these functions it is entirely possible to create invalid
STAR files, since these "comments" can really be strings with
anything at all in them - so be careful.
To get rid of the preComment if you change your mind, set it to
a zero-length string with setPreComment().
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.
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.
string myName() const
void changeName(const string &name)
virtual const string& getPreComment( void )
virtual void setPreComment( const string &cmt )
# This is an example comment.
# The comment has some blank
# lines in it.
If the Unparse() function were designed to insert the comment
characters (#) itself, then such a comment block would be impossible
to create.
DataNode* ReturnSaveFrameDataNode(string dataItemName)
ASTlist <DataNode*> * GiveMyDataList()
virtual void Unparse(int indent)
virtual void Unparse(int indent, int padsize )
virtual ASTnode::ASTtype myType(void)
virtual bool isOfType( ASTtype T )
virtual ASTlist <DataValueNode *> * returnLoopValues(const string & tagName)
void AddItemToSaveFrame(DataNode* S)
StarFileNode::Status AddDataItem(const string & name, const string & value, DataValueNode::ValType type )
StarFileNode::Status AddLoop(const string &tflag = string("tabulate"))
StarFileNode::Status AddLoopDataName(const string & name)
StarFileNode::Status AddLoopDataValue( const string & value, DataValueNode::ValType type )
DataNode* ReturnSaveFrameDeepLook( string dataItemName, int *nest, int *col )
virtual List <ASTnode*> * searchByTag( const string &searchFor )
virtual List <ASTnode*> * searchForType( ASTtype type, int delim = -1 )
delim - the delimiter to search for if searching for
DataValueNodes. The default is "dont-care". virtual List <ASTnode*> * searchByTagValue( const string &tag, const string &value )
value - ...where it has this value. virtual bool unlinkChild( ASTnode *child )
virtual int myLongestStr( void ) const
alphabetic index hierarchy of classes
generated by doc++