This class is available for the OPUS Blackboard API. The initial OPUS 2.0 release is described here

Constructors:

Path( )
~Path( )

Methods:

clone( )	create copy of object
name( )	get field name

Description

Path objects contain the name of the path in which the element tracked by the OSF is being processed.

Derived from

Field

See Also:

• Field
• Osf
• "OPUS API Blackboard and Support Classes Design Document"

Path::Path - The Path constructor.

Synopsis

Path::Path(
           const string& s) // I - path string

Path::Path(
           const Path& di) // I - initializer

Description

The constructor creates a new Path object, and initializes it with the calling argument (if provided).

Exceptions Thrown

none

Path::~Path - The Path destructor.

Synopsis

Path::~Path()

Description

This method destroys the object.

Exceptions Thrown

none

Path::clone - Create a copy of this object.

Synopsis

Field* Path::clone() const

Description

This method creates a new Path object, initialized by this object, off the heap and returns a pointer to the new object. The client should delete the returned object when it is no longer needed.

Returns

    A pointer to the new Path object initialized by this object.

Exceptions Thrown

none

Path::name - Get the field name

Synopsis

string Path::name() const 

Description

This method returns the name of the field, "PATH".

Returns

    string field name

Exceptions Thrown

none

For more information, contact opushelp@stsci.edu

Last modified: 25 April 2000