#include <OperationContext.h>

Classes

class  Container
 

Public Member Functions

 OperationContext ()
 
 OperationContext (const OperationContext &context)
 
virtual ~OperationContext ()
 
OperationContextoperator= (const OperationContext &context)
 
void clear ()
 
const Containerget (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
 

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() [1/2]

OperationContext::OperationContext ( )

Constructs an empty OperationContext object.

◆ OperationContext() [2/2]

OperationContext::OperationContext ( const OperationContext context)

Constructs a copy of an OperationContext object. The newly constructed OperationContext object is independent from the source object.

Parameters
contextThe OperationContext object to copy.

◆ ~OperationContext()

virtual OperationContext::~OperationContext ( )
virtual

Destructs the OperationContext.

Member Function Documentation

◆ clear()

void OperationContext::clear ( )

Removes all the Containers from the OperationContext.

◆ contains()

Boolean OperationContext::contains ( const String containerName) const

Tests if the specified Container object is in the OperationContext.

Parameters
containerNameThe name of the Container type to retrieve.
Returns
"true" if the container is present in the OperationContext, "false" if it is not present.

◆ get()

const Container& OperationContext::get ( const String containerName) const

Retrieves the specified Container object from the OperationContext.

Parameters
containerNameThe name of the Container type to retrieve.
Returns
A reference to the specified Container object.
Exceptions
Exceptionif the OperationContext does not contain the specified Container type.

◆ insert()

void OperationContext::insert ( const Container container)

Inserts a Container into the OperationContext.

Parameters
containerThe Container to insert into the OperationContext.
Exceptions
Exceptionif the OperationContext already contains a Container of this type.

◆ operator=()

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
contextThe OperationContext object to copy.

◆ remove()

void OperationContext::remove ( const String containerName)

Removes a Container from the OperationContext.

Parameters
containerNameThe name of the Container type to remove from the OperationContext.
Exceptions
Exceptionif the OperationContext does not contain the specified Container type.

◆ set()

void OperationContext::set ( const Container container)

Replaces an OperationContext Container with the specified Container object of the same type.

Parameters
containerThe Container to set in the OperationContext.
Exceptions
Exceptionif the OperationContext does not contain the specified Container type.

Member Data Documentation

◆ _rep

OperationContextRep* OperationContext::_rep
protected

An internal representation of the OperationContext attributes.


The documentation for this class was generated from the following file: