Taxonomy Categories:
Member Functions:
Interface Category:
API.
Purpose:
A templatized class which provides access to an object of the parameter type. Can be used wherever scrap items are appropriate.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Do not derive from this class; derive from TScrapItem.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
- TScrapItemOn (AType * adoptedObject)
- TScrapItemOn (const TScrapItemOn < AType > & copy)
Interface Category:
API.
Purpose:
- Constructor.
- Copy constructor.
Calling Context:
- Called to construct a valid object.
- Called to copy an object.
Parameters:
- AType * adoptedObject -A pointer to the object to adopt.
- const TScrapItemOn < AType > & copy -The object to copy.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TScrapItemOn::operator=
TScrapItemOn < AType > & operator =(const TScrapItemOn < AType > & copy)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
Return Value:
A non-const reference to the left-hand side object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TScrapItemOn::OrphanObject
virtual AType * OrphanObject ()
Interface Category:
API.
Purpose:
Orphans the scrap item's object.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to the scrap item's object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TScrapItemOn::GetObject
virtual const AType * GetObject () const
Interface Category:
API.
Purpose:
Returns a pointer to the scrap item's object.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to the scrap item's object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TScrapItemOn::GetScrapItemType
- static void GetScrapItemType (TTypeDescription & type)
- static TTypeDescription GetScrapItemType ()
Interface Category:
API.
Purpose:
- Sets type to the type of the data to which this scrap item provides access.
- Returns the type of data to which this scrap item provides access.
Calling Context:
- Called from InternalGetScrapItemType and GetScrapItemType #2. Call this function directly.
- Call this function directly.
Parameters:
- TTypeDescription & type -The object which receives the type of the scrap item's object.
- Takes no parameters.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TScrapItemOn::InternalCopyAvailableTypes
virtual void InternalCopyAvailableTypes (TSequenceOf<TTypeDescription>& types, TMemoryHeap& whichHeap ) const
Interface Category:
API.
Purpose:
Implements the abstract member function declared in TScrapItem. Provides a list of available type descriptions for this object. This list will contain one entry which is a TTypeDescription of the class this object is templatized on.
Calling Context:
Called by TScrapItem's CopyAvailableTypes.
Parameters:
- TSequenceOf < TTypeDescription > & result -The list of type descriptions for this object.
- TMemoryHeap * whichHeap =NIL -The heap on which to create the list. If this parameter is NIL, the default heap is used.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TScrapItemOn ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.