regina::NScript Class Reference
[Basic Packet Types]

A packet representing a script that can be run. More...

#include <nscript.h>

Inheritance diagram for regina::NScript:

regina::NPacket regina::NFilePropertyReader regina::ShareableObject regina::boost::noncopyable List of all members.

Public Member Functions

 NScript ()
 Initialises to a script with no lines and no variables.
unsigned long getNumberOfLines () const
 Returns the number of lines in this script.
const std::string & getLine (unsigned long index) const
 Returns the requested line of this script.
void addFirst (const std::string &line)
 Adds the given line to the beginning of this script.
void addLast (const std::string &line)
 Adds the given line to the end of this script.
void insertAtPosition (const std::string &line, unsigned long index)
 Inserts the given line into the given position in this script.
void replaceAtPosition (const std::string &line, unsigned long index)
 Replaces a line of this script with the given line.
void removeLineAt (unsigned long index)
 Removes the requested line from this script.
void removeAllLines ()
 Removes all lines from this script.
unsigned long getNumberOfVariables () const
 Returns the number of variables associated with this script.
const std::string & getVariableName (unsigned long index) const
 Returns the name of the requested variable associated with this script.
const std::string & getVariableValue (unsigned long index) const
 Returns the value of the requested variable associated with this script.
const std::string & getVariableValue (const std::string &name) const
 Returns the value of the variable stored with the given name.
bool addVariable (const std::string &name, const std::string &value)
 Adds a new variable to be associated with this script.
void removeVariable (const std::string &name)
 Removes the variable stored with the given name.
void removeAllVariables ()
 Removes all variables associated with this script.
virtual int getPacketType () const
 Returns the integer ID representing this type of packet.
virtual std::string getPacketTypeName () const
 Returns an English name for this type of packet.
virtual void writeTextShort (std::ostream &out) const
 Writes this object in short text format to the given output stream.
virtual void writeTextLong (std::ostream &out) const
 Writes this object in long text format to the given output stream.
virtual void writePacket (NFile &out) const
 Writes the packet details to the given old-style binary file.
virtual bool dependsOnParent () const
 Determines if this packet depends upon its parent.

Static Public Member Functions

static NXMLPacketReadergetXMLReader (NPacket *parent)
 Returns a newly created XML element reader that will read the contents of a single XML packet element.
static NScriptreadPacket (NFile &in, NPacket *parent)
 Reads a single packet from the specified file and returns a newly created object containing that information.

Static Public Attributes

static const int packetType
 Contains the integer ID for this packet.

Protected Member Functions

virtual NPacketinternalClonePacket (NPacket *parent) const
 Makes a newly allocated copy of this packet.
virtual void writeXMLPacketData (std::ostream &out) const
 Writes a chunk of XML containing the data for this packet only.
virtual void readIndividualProperty (NFile &infile, unsigned propType)
 Reads an individual property from an old-style binary file.

Detailed Description

A packet representing a script that can be run.

Accessor methods for a script work a line at a time.


Constructor & Destructor Documentation

regina::NScript::NScript (  )  [inline]

Initialises to a script with no lines and no variables.


Member Function Documentation

unsigned long regina::NScript::getNumberOfLines (  )  const [inline]

Returns the number of lines in this script.

Returns:
the number of lines.

const std::string & regina::NScript::getLine ( unsigned long  index  )  const [inline]

Returns the requested line of this script.

Parameters:
index the index of the requested line; this must be between 0 and getNumberOfLines()-1 inclusive.
Returns:
the requested line.

void regina::NScript::addFirst ( const std::string &  line  )  [inline]

Adds the given line to the beginning of this script.

Parameters:
line the line to insert.

void regina::NScript::addLast ( const std::string &  line  )  [inline]

Adds the given line to the end of this script.

Parameters:
line the line to add.

void regina::NScript::insertAtPosition ( const std::string &  line,
unsigned long  index 
) [inline]

Inserts the given line into the given position in this script.

All subsequent lines will be shifted down to make room.

Parameters:
line the line to insert.
index the index at which the new line will be placed; this must be between 0 and getNumberOfLines() inclusive.

void regina::NScript::replaceAtPosition ( const std::string &  line,
unsigned long  index 
) [inline]

Replaces a line of this script with the given line.

Parameters:
line the line to replace the currently stored line.
index the index of the line to replace; this must be between 0 and getNumberOfLines()-1 inclusive.

void regina::NScript::removeLineAt ( unsigned long  index  )  [inline]

Removes the requested line from this script.

Parameters:
index the index of the requested line; this must be between 0 and getNumberOfLines()-1 inclusive.

void regina::NScript::removeAllLines (  )  [inline]

Removes all lines from this script.

unsigned long regina::NScript::getNumberOfVariables (  )  const [inline]

Returns the number of variables associated with this script.

Returns:
the number of variables.

const std::string& regina::NScript::getVariableName ( unsigned long  index  )  const

Returns the name of the requested variable associated with this script.

Parameters:
index the index of the requested variable; this must be between 0 and getNumberOfVariables()-1 inclusive.
Returns:
the name of the requested variable.

const std::string& regina::NScript::getVariableValue ( unsigned long  index  )  const

Returns the value of the requested variable associated with this script.

If the value is a packet, the packet label will be returned. If the value is null, the empty string will be returned.

Parameters:
index the index of the requested variable; this must be between 0 and getNumberOfVariables()-1 inclusive.
Returns:
the value of the requested variable.

const std::string& regina::NScript::getVariableValue ( const std::string &  name  )  const

Returns the value of the variable stored with the given name.

The return strings are as described in getVariableValue(unsigned long).

If no variable is stored with the given name, the empty string will be returned.

Parameters:
name the name of the requested variable; note that names are case sensitive.
Returns:
the value of the requested variable.

bool regina::NScript::addVariable ( const std::string &  name,
const std::string &  value 
) [inline]

Adds a new variable to be associated with this script.

If a variable with the given name is already stored, this routine will do nothing.

Parameters:
name the name of the new variable.
value the value of the new variable, as described in the notes for getVariableValue().
Returns:
true if the variable was successfully added, or false if a variable with the given name was already stored.

void regina::NScript::removeVariable ( const std::string &  name  )  [inline]

Removes the variable stored with the given name.

Note that the indices of other variables may change as a result of this action.

If no variable is stored with the given name, this routine will do nothing (but waste time!).

Parameters:
name the name of the variable to remove; note that names are case sensitive.

void regina::NScript::removeAllVariables (  )  [inline]

Removes all variables associated with this script.

virtual int regina::NScript::getPacketType (  )  const [virtual]

Returns the integer ID representing this type of packet.

This is the same for all packets of this class.

Returns:
the packet type ID.

Implements regina::NPacket.

virtual std::string regina::NScript::getPacketTypeName (  )  const [virtual]

Returns an English name for this type of packet.

An example is NTriangulation. This is the same for all packets of this class.

Returns:
the packet type name.

Implements regina::NPacket.

void regina::NScript::writeTextShort ( std::ostream &  out  )  const [inline, virtual]

Writes this object in short text format to the given output stream.

The output should fit on a single line and no newline should be written.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.

Implements regina::ShareableObject.

virtual void regina::NScript::writeTextLong ( std::ostream &  out  )  const [virtual]

Writes this object in long text format to the given output stream.

The output should provided the user with all the information they could want. The output should end with a newline.

The default implementation of this routine merely calls writeTextShort() and adds a newline.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
out the output stream to which to write.

Reimplemented from regina::ShareableObject.

static NXMLPacketReader* regina::NScript::getXMLReader ( NPacket parent  )  [static]

Returns a newly created XML element reader that will read the contents of a single XML packet element.

You may assume that the packet to be read is of the same type as the class in which you are implementing this routine.

The XML element reader should read exactly what writeXMLPacketData() writes, and vice versa.

parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. The XML element reader can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.

This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated.

Python:
Not present.
Parameters:
parent the packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch.
Returns:
the newly created XML element reader.

Reimplemented from regina::NPacket.

virtual void regina::NScript::writePacket ( NFile out  )  const [virtual]

Writes the packet details to the given old-style binary file.

You may assume that the packet type and label have already been written. Only the actual data stored in the packet need be written.

The default implementation for this routine does nothing; new packet types should not implement this routine since this file format is now obsolete, and older calculation engines will simply skip unknown packet types when reading from binary files.

Deprecated:
For the preferred way to write packets to file, see writeXMLFile() and writeXMLPacketData() instead.
Precondition:
The given file is open for writing and satisfies the assumptions listed above.
Python:
Not present.
Parameters:
out the file to be written to.

Reimplemented from regina::NPacket.

static NScript* regina::NScript::readPacket ( NFile in,
NPacket parent 
) [static]

Reads a single packet from the specified file and returns a newly created object containing that information.

You may assume that the packet to be read is of the same type as the class in which you are implementing this routine. The newly created object must also be of this type.

For instance, NTriangulation::readPacket() may assume that the packet is of type NTriangulation, and must return a pointer to a newly created NTriangulation. Deallocation of the newly created packet is the responsibility of whoever calls this routine.

The packet type and label may be assumed to have already been read from the file, and should not be reread. The readPacket() routine should read exactly what writePacket() writes, and vice versa.

parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. This routine can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.

This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated. Within each such subclass the function must be declared to return a pointer to an object of that subclass. For instance, NTriangulation::readPacket() must be declared to return an NTriangulation*, not simply an NPacket*.

New packet types should make this routine simply return 0 since this file format is now obsolete, and older calculation engines will not understand newer packet types anyway.

Deprecated:
For the preferred way to read packets from file, see getXMLReader() and class NXMLPacketReader instead.
Precondition:
The given file is open for reading and all above conditions have been satisfied.
Python:
Not present.
Parameters:
in the file from which to read the packet.
parent the packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch.
Returns:
the packet read from file, or 0 if an error occurred.

Reimplemented from regina::NPacket.

bool regina::NScript::dependsOnParent (  )  const [inline, virtual]

Determines if this packet depends upon its parent.

This is true if the parent cannot be altered without invalidating or otherwise upsetting this packet.

Returns:
true if and only if this packet depends on its parent.

Implements regina::NPacket.

virtual NPacket* regina::NScript::internalClonePacket ( NPacket parent  )  const [protected, virtual]

Makes a newly allocated copy of this packet.

This routine should not insert the new packet into the tree structure, clone the packet's associated tags or give the packet a label. It should also not clone any descendants of this packet.

You may assume that the new packet will eventually be inserted into the tree beneath either the same parent as this packet or a clone of that parent.

Parameters:
parent the parent beneath which the new packet will eventually be inserted.
Returns:
the newly allocated packet.

Implements regina::NPacket.

virtual void regina::NScript::writeXMLPacketData ( std::ostream &  out  )  const [protected, virtual]

Writes a chunk of XML containing the data for this packet only.

You may assume that the packet opening tag (including the packet type and label) has already been written, and that all child packets followed by the corresponding packet closing tag will be written immediately after this routine is called. This routine need only write the internal data stored in this specific packet.

Parameters:
out the output stream to which the XML should be written.

Implements regina::NPacket.

virtual void regina::NScript::readIndividualProperty ( NFile infile,
unsigned  propType 
) [protected, virtual]

Reads an individual property from an old-style binary file.

The property type and bookmarking details should not read; merely the contents of the property that are written to file between NFile::writePropertyHeader() and NFile::writePropertyFooter(). See the NFile::writePropertyHeader() notes for details.

The property type of the property to be read will be passed in propType. If the property type is unrecognised, this routine should simply do nothing and return. If the property type is recognised, this routine should read the property and process it accordingly (e.g., store it in whatever data object is currently being read).

Parameters:
infile the file from which to read the property. This should be open for reading and at the position immediately after writePropertyHeader() would have been called during the corresponding write operation.
propType the property type of the property about to be read.

Implements regina::NFilePropertyReader.


Member Data Documentation

const int regina::NScript::packetType [static]

Contains the integer ID for this packet.

Each distinct packet type must have a unique ID, and this should be a positive integer. See packetregistry.h for further requirements regarding ID selection.

This member is not actually provided for NPacket itself, but must be declared for every packet subclass that will be instantiated. A value need not be assigned; packetregistry.h will take care of this task when you register the packet.

Reimplemented from regina::NPacket.


The documentation for this class was generated from the following file:
Copyright © 1999-2006, Ben Burton
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).