CBaseClass Class Reference

#include <BaseClass.h>

Inheritance diagram for CBaseClass:

Public Member Functions
CBaseClass	CBASECLASS_PROTO_ARGS ((const char *pDerivedType="Unknown", int callLineNum=0))
virtual	~CBaseClass (void)
virtual bool	Initialize (void)
bool	IsInitialized (void)
void	setAutomatic (bool)
virtual unsigned long AddRef	ADD_RELEASE_PROTO_ARGS ((int callLineNum))
virtual unsigned long Release	ADD_RELEASE_PROTO_ARGS ((int callLineNum))

Static Public Member Functions
static bool	AllowDeletes (void)
static void	s_SetAllowDeletes (int v)

Public Attributes
bool	m_bInitialized
bool	m_bAutomatic
int	m_ulReferences

Static Public Attributes
static bool	s_bAllowDeletes = true

Detailed Description

Class Name: CBaseClass

Inheritance: CBaseClass - Base Class Implementation

Interfaces: None

Description: The CBaseClass Class contains functions common to all class within the Pingtel programming environment.

Notes: The CBaseClass is inherited by all RTCP Report objects.

Constructor & Destructor Documentation

~CBaseClass ( void  )

virtual

Method Name: ~CBaseClass() - Destructor

Inputs: None

Outputs: None

Returns: None

Description: Shall deallocate and/or release all resources which were acquired over the course of runtime.

Usage Notes:

Member Function Documentation

CBaseClass CBASECLASS_PROTO_ARGS

(

(const char *pDerivedType="Unknown", int callLineNum=0)

)

Method Name: CBaseClass() - Constructor

Inputs: None

Outputs: None

Returns: None

Description: The CBaseClass is an abstract class that is initialized by a derived object at construction time.

Usage Notes:

bool Initialize ( void  )

inlinevirtual

Method Name: Initialize

Inputs: None

Outputs: None

Returns: bool

Description: Performs runtime initialization that may be failure prone and therefore inappropriate for execution within a constructor.

Usage Notes:

Reimplemented in CRTCManager, CRTCPConnection, CRTCPRender, and CNetworkChannel.

bool IsInitialized ( void  )

inline

Method Name: IsInitialized

Inputs: None

Outputs: None

Returns: Boolean True/False

Description: Returns a boolean specifying whether an object has already been created and initialized.

Usage Notes:

Method Name: IsInitialized

Inputs: None

Outputs: None

Returns: Boolean True/False

Description: Returns a boolean specifying whether an object instance has already been created and initialized.

Usage Notes:

void setAutomatic ( bool  yesNo )

inline

virtual unsigned long AddRef ADD_RELEASE_PROTO_ARGS ( (int callLineNum)  )

virtual

Method Name: AddRef

Inputs: None

Outputs: None

Returns: unsigned long

Description: Increments the number of references to this object.

Usage Notes:

virtual unsigned long Release ADD_RELEASE_PROTO_ARGS ( (int callLineNum)  )

virtual

Method Name: Release

Inputs: None

Outputs: None

Returns: unsigned long

Description: Decrements the number of references to this object.

Usage Notes:

bool AllowDeletes ( void  )

inlinestatic

void s_SetAllowDeletes ( int  v )

static

Member Data Documentation

bool m_bInitialized

Attribute Name: m_bInitialized

Type: bool

Description: This member shall store an indicator of whether construction time initialization completed successfully.

bool m_bAutomatic

int m_ulReferences

Attribute Name: m_ulReferences

Type: int

Description: This member shall keep track of the number of references to an object.

bool s_bAllowDeletes = true

static