oathCore

Section: OATH Reference Manual (3O)
Updated: 1 Aug 1991
Index Return to Main Contents
 

NAME

oathCore (oathCoreA, oathCoreG) - the core functionality of OATH objs  

SYNOPSIS

#include <oath/oathCore.h>  

DESCRIPTION

The oathCore is the base type of all OATH objs. The type management and the memory management and garbage collection functionality is provided by this base type. Users of OATH classes should never see or deal with the members of this class. Writers of OATH classes will, on the other hand, need to understand the behavior of this class.  

DERIVATION

oathCore is the base type  

INTERNAL OPERATIONS

virtual int oathCoreG:: isType (void*) const
This function is automatically generated by the CLASS_G macro.
virtual int oathCoreG:: isImplementedAs (void*) const
This function must be overridden by implementation types to return TRUE if the passed TypeID is the same as that type's static variable Type.
virtual void oathCoreG:: export (exportP&) const
This function must be overridden by implementation types to provide appropriate export capabilities. It should first call writeType(TypeName) on its exportP parameter.
static objA oathCoreG:: import (importP&) const
This function must be overridden by implementation types to retrieve the data written out by the export function above (minus the TypeName which is read in by OATH mechanism) and produce the appropriate obj.
virtual void oathCoreG:: clearReferences ()
This function should clearMark(); and then deref() each obj that this obj references. This function need only be overridden by classes that can maintain circular references.
virtual void oathCoreG:: setReferences ()
If not isMarked(), this function should setMark(); and then for each obj that this obj references, call ref() and setReferences(). This function should work with clearReferences above to maintain a consistent state.
int oathCoreG:: isConst () const
int oathCoreG:: isNil () const
int oathCoreG:: is (const oathCoreG*) const
int oathCoreG:: isRefd () const
void oathCoreG:: ref () const
This is abstract-const -- not bit-const!
void oathCoreG:: deref () const
This is abstract-const -- not bit-const!
void oathCoreG:: forceConst () const
This is abstract-const -- not bit-const!
int oathCoreG:: isMarked () const
void oathCoreG:: clearMark ()
void oathCoreG:: setMark ()
 

SEE ALSO

OATH(3O), obj(3O), ensure(3O)  

AUTHOR

Brian M. Kennedy (Computer Science Center, Texas Instruments Incorporated)  

COPYRIGHT

Copyright (C) 1991 Texas Instruments Incorporated

Permission is granted to any individual or institution to use, copy, modify, and distribute this software, provided that this complete copyright and permission notice is maintained, intact, in all copies and supporting documentation. Texas Instruments Incorporated provides this software "as is" without express or implied warranty.  

BUGS


 

Index

NAME
SYNOPSIS
DESCRIPTION
DERIVATION
INTERNAL OPERATIONS
SEE ALSO
AUTHOR
COPYRIGHT
BUGS

This document was created by man2html, using the manual pages.
Time: 20:37:47 GMT, July 24, 2024