Teamcenter C++ API Reference  2312
Public Member Functions | Static Public Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
status_t Class Reference

Instances of status_t can be used to describe the return status of a function or method.
The returned value can later be leveraged through the class ResultStatus. More...

#include <StatusT.hxx>

Public Member Functions

bool operator!= (const status_t &other) const
 
status_toperator= (const status_t &other)
 
bool operator== (const status_t &other) const
 
 status_t ()
 
 status_t (const status_t &other)
 
 ~status_t ()
 

Static Public Attributes

static const status_t NOT_OK
 
static const status_t OK
 

Private Types

enum  value_type { UNSET_VALUE, NOT_OK_VALUE, OK_VALUE }
 

Private Member Functions

void checkMe ()
 
void setValue (value_type theValue)
 
 status_t (value_type v)
 

Static Private Member Functions

static void validate (value_type theValue)
 

Private Attributes

char * traceback
 
value_type value
 

Detailed Description

Instances of status_t can be used to describe the return status of a function or method.
The returned value can later be leveraged through the class ResultStatus.

Definition at line 23 of file StatusT.hxx.

Member Enumeration Documentation

enum status_t::value_type
private
Enumerator
UNSET_VALUE 
NOT_OK_VALUE 
OK_VALUE 

Definition at line 68 of file StatusT.hxx.

Constructor & Destructor Documentation

status_t::status_t ( )

Constructor

status_t::status_t ( const status_t other)

Copy constructor

status_t::~status_t ( )

Destructor

status_t::status_t ( value_type  v)
explicitprivate

Member Function Documentation

void status_t::checkMe ( )
private
bool status_t::operator!= ( const status_t other) const

Operator !=

status_t& status_t::operator= ( const status_t other)

Operator =

bool status_t::operator== ( const status_t other) const

Operator ==

void status_t::setValue ( value_type  theValue)
private
static void status_t::validate ( value_type  theValue)
staticprivate

Member Data Documentation

const status_t status_t::NOT_OK
static

The status_t instance that refers to an error status

Definition at line 34 of file StatusT.hxx.

const status_t status_t::OK
static

The status_t instance that refers to an OK status

Definition at line 29 of file StatusT.hxx.

char* status_t::traceback
private

Definition at line 75 of file StatusT.hxx.

value_type status_t::value
private

Definition at line 74 of file StatusT.hxx.


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