Contents
|
In file ../../src/Pegasus/Common/OperationContext.h:
An OperationContext object holds information about the context of an operation, using various Container classes.
Documentation
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.
Inheritance:
Public Methods
| OperationContext ()
Constructs an empty OperationContext object
|
| OperationContext (const OperationContext& context)
Constructs a copy of an OperationContext object.
|
virtual | ~OperationContext ()
Destructs the OperationContext
|
OperationContext& | operator= (const OperationContext& context)
Assigns the value of the specified OperationContext object to this OperationContext.
|
void | clear ()
Removes all the Containers from the OperationContext
|
const Container& | get (const String& containerName) const
Retrieves the specified Container object from the OperationContext.
|
Boolean | contains (const String& containerName) const
Tests if the specified Container object is in the OperationContext.
|
void | set (const Container& container)
Replaces an OperationContext Container with the specified Container object of the same type.
|
void | insert (const Container& container)
Inserts a Container into the OperationContext.
|
void | remove (const String& containerName)
Removes a Container from the OperationContext.
|
Protected Fields
OperationContextRep* | _rep
An internal representation of the OperationContext attributes
|
- OperationContext()
-
Constructs an empty OperationContext object
- 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()
-
Destructs the 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 clear()
-
Removes all the Containers from the OperationContext
- const Container& get(const String& containerName) const
-
Retrieves the specified Container object from the OperationContext.
- Throws:
- Exception if the OperationContext does not contain the
specified Container type.
- Parameters:
- containerName - The name of the Container type to retrieve.
- Returns:
- A reference to the specified Container object.
- Boolean 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.
- void set(const Container& container)
-
Replaces an OperationContext Container with the specified Container
object of the same type.
- Throws:
- Exception if the OperationContext does not contain the
specified Container type.
- Parameters:
- container - The Container to set in the OperationContext.
- void insert(const Container& container)
-
Inserts a Container into the OperationContext.
- Throws:
- Exception if the OperationContext already contains a
Container of this type.
- Parameters:
- container - The Container to insert into the OperationContext.
- void remove(const String& containerName)
-
Removes a Container from the OperationContext.
- Throws:
- Exception if the OperationContext does not contain the
specified Container type.
- Parameters:
- containerName - The name of the Container type to remove from
the OperationContext.
- OperationContextRep* _rep
-
An internal representation of the OperationContext attributes
- This class has no child classes.
Alphabetic index HTML hierarchy of classes or Java
|