[OPUS]

Opus_null_lock - A lock on a resource not requiring one


Availability:

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

Constructors:
Opus_null_lock( )
~Opus_null_lock( )

Methods:
lock( ) a no-op
release( ) a no-op
operator==( ) compare ID's

Description

Opus_null_lock objects are created for items that require no lock mechanism, but could be used with code requiring a lock on the object to be returned from a lock method. The time-related blackboards return objects of this type upon calls to their lock_entry methods.

Derived from

virtual Opus_lock

Example

  
    none
  

See Also:


Opus_null_lock::Opus_null_lock - The Opus_null_lock object constructor.

Synopsis


Opus_null_lock::Opus_null_lock(const int i) : id(i)

Description

Sets the lock ID.

Exceptions Thrown

none

Example

  
    none
  


Opus_null_lock::~Opus_null_lock - The Opus_null_lock object destructor.

Synopsis


Opus_null_lock::~Opus_null_lock()

Description

Destroys the object

Exceptions Thrown

none

Example

  
    none
  


Opus_null_lock::lock - Lock the resource.

Synopsis


void Opus_null_lock::lock()

Description

For these objects, this is a no-op

Exceptions Thrown

none

Example

  
    none
  


Opus_null_lock::release - Release the resource.

Synopsis


void Opus_null_lock::release()

Description

For these objects, this is a no-op.

Exceptions Thrown

none

Example

  
    none
  


Opus_null_lock::operator== - Test objects for equality.

Synopsis


bool Opus_null_lock::operator==(
                                const Opus_lock* ol) // I - Opus_null_lock
                                const

Description

The ID's of the two Opus_null_lock objects are compared for equality.

Returns

true - if ID's match
false - if ID's do not match

Exceptions Thrown

none

Example

  
    none
  

OPUS API index · STScI Home Page · Search · Topics · Index

Copyright © 1997 The Association of Universities for Research in Astronomy, Inc. All Rights Reserved.


For more information, contact opushelp@stsci.edu

Last modified: 07 May 1999