ALMA Computing Group

acsexmplErrorComponent::ErrorComponent Interface Reference

Interface ErrorComponent is used to demonstrate examples of the ACS error system. More...

import "acsexmplErrorComponent.idl";

List of all members.

Public Member Functions

void displayMessage ()
 Prints "ErrorComponent" to the console (where the container that activated this component is running).
void badMethod (in short depth) raises (ACSErrTypeCommon::GenericErrorEx, ACSErrTypeCommon::UnexpectedExceptionEx)
 Simple method that throws an ACSException with an error trace of a given depth.
void exceptionFromCompletion (in short depth) raises (ACSErrTypeCommon::GenericErrorEx)
 Method that throws an ACSException (ACSErrTypeCommon::GenericErrorEx).
void typeException (in short depth) raises (ACSErrTypeCommon::GenericErrorEx, ACSErrTypeCommon::ACSErrTypeCommonEx)
 Method that throws an ACSException on the type level (ACSErrTypeCommon::ACSErrTypeCommonEx).
void corbaSystemException ()
 Method that throws a CORBA::BAD_PARAM system exception to show how to handle CORBA System Exceptions.
ACSErr::Completion completionFromException (in short depth)
 Simple method that returns an ACSErr::Completion.
ACSErr::Completion completionFromCompletion (in short depth)
 Simple method that returns an ACSErr::Completion.
ACSErr::Completion completionOnStack (in short depth)
 Simple method that returns an ACSErr::Completion.
void outCompletion (out ACSErr::Completion comp)
 a Simple method that returns an ACSErr::Completion as an out parameter


Detailed Description

Interface ErrorComponent is used to demonstrate examples of the ACS error system.

The methods are thought to produce errors and completions of various types. Implementation and clients demonstrate how to deal with them.

Definition at line 47 of file acsexmplErrorComponent.idl.


Member Function Documentation

void acsexmplErrorComponent::ErrorComponent::badMethod in short  depth  )  raises (ACSErrTypeCommon::GenericErrorEx, ACSErrTypeCommon::UnexpectedExceptionEx)
 

Simple method that throws an ACSException with an error trace of a given depth.

Parameters:
depth depth of the error trace (will be interpreted as 1 if it is < 1). In Java this corresponds to the total number of exception and causing exceptions.
Returns:
void *

*

ACSErr::Completion acsexmplErrorComponent::ErrorComponent::completionFromCompletion in short  depth  ) 
 

Simple method that returns an ACSErr::Completion.

The Error Trace in the completion is added from a completion.

Parameters:
depth depth of the error trace, if <= 0, returns OK completion
Returns:
ACSErr::Completion *

*

ACSErr::Completion acsexmplErrorComponent::ErrorComponent::completionFromException in short  depth  ) 
 

Simple method that returns an ACSErr::Completion.

The Error Trace in the completion is added from an exception.

Parameters:
depth depth of the error trace, if <= 0, returns OK completion
Returns:
ACSErr::Completion *

*

ACSErr::Completion acsexmplErrorComponent::ErrorComponent::completionOnStack in short  depth  ) 
 

Simple method that returns an ACSErr::Completion.

Completion is located on the stack instead on the heap.

Parameters:
depth depth of the error trace, if <= 0, returns OK completion
Returns:
ACSErr::Completion *

*

void acsexmplErrorComponent::ErrorComponent::corbaSystemException  ) 
 

Method that throws a CORBA::BAD_PARAM system exception to show how to handle CORBA System Exceptions.

void acsexmplErrorComponent::ErrorComponent::displayMessage  ) 
 

Prints "ErrorComponent" to the console (where the container that activated this component is running).

Returns:
void *

*

void acsexmplErrorComponent::ErrorComponent::exceptionFromCompletion in short  depth  )  raises (ACSErrTypeCommon::GenericErrorEx)
 

Method that throws an ACSException (ACSErrTypeCommon::GenericErrorEx).

The error trace inside the exception is added from a completion.

Parameters:
depth depth of the error trace
Returns:
void *

*

void acsexmplErrorComponent::ErrorComponent::outCompletion out ACSErr::Completion  comp  ) 
 

a Simple method that returns an ACSErr::Completion as an out parameter

Parameters:
comp Completion as out parameter *

*

void acsexmplErrorComponent::ErrorComponent::typeException in short  depth  )  raises (ACSErrTypeCommon::GenericErrorEx, ACSErrTypeCommon::ACSErrTypeCommonEx)
 

Method that throws an ACSException on the type level (ACSErrTypeCommon::ACSErrTypeCommonEx).

Since we do not have hierarchy in IDL, we have to specify here code and type exception. This means that this method can throw GenericErrorEx but also any exception in the ACSErrTypeCommonEx type.

Parameters:
depth depth of the error trace
Returns:
void *

*


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