Visit Platform at http://www.platform.com

Main Page   Class Hierarchy   Compound List   Compound Members  

SoamExceptionPtr Class Reference

Smart pointer for the SoamException class or any of its derivatives. More...

Inheritance diagram for SoamExceptionPtr:

FailureExceptionPtr FatalExceptionPtr List of all members.

Public Methods

SoamExceptionoperator-> () const
 This operator makes it possible for the developer to access the smart pointer as if it were the actual API object.

bool isNull () const
 test for null.

void setNull ()
 sets the internal reference of the smart pointer to null.

SoamExceptionPtr & operator= (SoamExceptionPtr rhs)
 Assigns a reference to the object being pointed to by the smart pointer presented.

SoamExceptionPtr & operator= (SoamException *rhs)
 Assigns a reference to the object being pointed to by the raw pointer presented.

bool operator== (const SoamExceptionPtr &rhs) const
 This operator allows the developer to compare references from two different smart pointers.

bool operator== (const SoamException *rhs) const
 This operator allows the developer to compare references between a smart pointers and a rawpointer.

bool operator!= (const SoamExceptionPtr &rhs) const
 This operator allows the developer to compare references from two different smart pointers.

bool operator!= (const SoamException *rhs) const
 This operator allows the developer to compare references between a smart pointers and a rawpointer.

 operator SoamException * () const
 This operator returns a direct raw pointer to the internal object.


Detailed Description

Smart pointer for the SoamException class or any of its derivatives.

If a pointer to a SoamException object is thrown within the service, the memory it is pointing to will be freed automatically using the delete operator.

If your exception must be created on the heap then it is recommended that a smart pointer be thrown instead of a raw pointer to prevent any ambiguity.

eg.

SoamExceptionPtr ex = new SoamException();
...
throw ex;


NOTE:


Member Function Documentation

SoamException* operator->   const
 

This operator makes it possible for the developer to access the smart pointer as if it were the actual API object.

Returns:
a reference to the API object.

Reimplemented in FailureExceptionPtr, and FatalExceptionPtr.

bool isNull   const
 

test for null.

Tests if the internal reference of the smart pointer is null.

Returns:
true if the internal reference is null and false otherwise.

void setNull  
 

sets the internal reference of the smart pointer to null.

SoamExceptionPtr& operator= SoamExceptionPtr    rhs
 

Assigns a reference to the object being pointed to by the smart pointer presented.

The current reference will be cleaned up automatically during the assignment.

SoamExceptionPtr& operator= SoamException   rhs
 

Assigns a reference to the object being pointed to by the raw pointer presented.

The current reference will be cleaned up automatically during the assignment.

bool operator== const SoamExceptionPtr &    rhs const
 

This operator allows the developer to compare references from two different smart pointers.

This test is for equality.

Returns:
true if both smart pointers point to the same API object, false otherwise.

bool operator== const SoamException   rhs const
 

This operator allows the developer to compare references between a smart pointers and a rawpointer.

This test is for equality.

Returns:
true if both smart pointers point to the same API object, false otherwise.

bool operator!= const SoamExceptionPtr &    rhs const
 

This operator allows the developer to compare references from two different smart pointers.

This test is for in-equality.

Returns:
true if both smart pointers point to different API object, false otherwise.

bool operator!= const SoamException   rhs const
 

This operator allows the developer to compare references between a smart pointers and a rawpointer.

This test is for equality.

Returns:
true if both smart pointers point to the same API object, false otherwise.

operator SoamException *   const
 

This operator returns a direct raw pointer to the internal object.

two different smart pointers. This test is for in-equality.

Returns:
true if both smart pointers point to different API object, false otherwise.


     
Date Modified: 28 Apr 2011
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.