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

Constructors:

Com_label( )
~Com_label( )

Methods:

clone( )

returns a copy of this object

Description

Command entries are identified on the command blackboard by a string label which is stored in objects of this type. Each Command object contains a Com_label field, and that label must be unique on a given command blackboard.

Derived from

Field

See Also:

• Field
• Com_arg
• Command
• Command_bb
• "OPUS API Blackboard and Support Classes Design Document"

Com_label::Com_label - The Com_arg constructor.

Synopsis

Com_label::Com_label(
                     const string& s) // I - Command label string

Com_label::Com_label(
                     const Com_label& ca) // I - object to initialize from

Description

This method constructs the object and stores the string label in the field. Null strings are permitted, and the maximum label length is 256 characters.

Exceptions Thrown

none

Com_label::~Com_label - The Com_label destructor.

Synopsis

Com_label::~Com_label()

Description

This method destroys the object.

Exceptions Thrown

none

Com_label::clone - Create a copy of the Com_label object.

Synopsis

Field* Com_label::clone() const

Description

A new Com_label object is constructed off the heap and initialized by this object. The client should delete the new object when it is no longer needed.

Returns

    A pointer to the new Com_label object initialized with this object.

Exceptions Thrown

none

For more information, contact opushelp@stsci.edu

Last modified: 25 April 2000