OperationContext Class Reference
#include <OperationContext.h>
Public Member Functions
OperationContext () OperationContext (const OperationContext &context) virtual ~OperationContext () OperationContext & operator= (const OperationContext &context) void clear () const Container & get (const String &containerName) const Boolean contains (const String &containerName) const void set (const Container &container) void insert (const Container &container) void remove (const String &containerName) Protected Attributes
OperationContextRep * _rep Classes
class Container Detailed Description
An OperationContext object holds information about the context of an operation, using various Container classes. The Container subclasses define the set of information that may be available in the OperationContext.
Constructor & Destructor Documentation
OperationContext::OperationContext ( ) Constructs an empty OperationContext object.
OperationContext::OperationContext ( const OperationContext & context ) Constructs a copy of an OperationContext object. The newly constructed OperationContext object is independent from the source object.
- Parameters:
context The OperationContext object to copy.
virtual OperationContext::~OperationContext ( ) [virtual]
Destructs the OperationContext.
Member Function Documentation
void OperationContext::clear ( ) Removes all the Containers from the OperationContext.
Boolean OperationContext::contains ( const String & containerName ) const Tests if the specified Container object is in the OperationContext.
- Parameters:
containerName The name of the Container type to retrieve.
- Returns:
- "true" if the container is present in the OperationContext, "false" if it is not present.
Retrieves the specified Container object from the OperationContext.
- Parameters:
containerName The name of the Container type to retrieve.
- Returns:
- A reference to the specified Container object.
- Exceptions:
Exception if the OperationContext does not contain the specified Container type.
void OperationContext::insert ( const Container & container ) Inserts a Container into the OperationContext.
- Parameters:
container The Container to insert into the OperationContext.
- Exceptions:
Exception if the OperationContext already contains a Container of this type.
OperationContext& OperationContext::operator= ( const OperationContext & context ) Assigns the value of the specified OperationContext object to this OperationContext. As a result, this OperationContext object will contain the same set of Containers as in the specified object.
- Parameters:
context The OperationContext object to copy.
void OperationContext::remove ( const String & containerName ) Removes a Container from the OperationContext.
- Parameters:
containerName The name of the Container type to remove from the OperationContext.
- Exceptions:
Exception if the OperationContext does not contain the specified Container type.
void OperationContext::set ( const Container & container ) Replaces an OperationContext Container with the specified Container object of the same type.
- Parameters:
container The Container to set in the OperationContext.
- Exceptions:
Exception if the OperationContext does not contain the specified Container type.
Member Data Documentation
OperationContextRep* OperationContext::_rep [protected]
An internal representation of the OperationContext attributes.
The documentation for this class was generated from the following file:
- /scratch/rpmbuild.17644.V17674/pegasus/src/Pegasus/Common/OperationContext.h