Protected Member Functions | Friends

SCH::LIB_SINK Class Reference

Class LIB_SINK is an abstract class from which implementation specific LIB_SINKs may be derived, one for each kind of library type in the library table that supports writing. More...

#include <sch_lib.h>

List of all members.

Protected Member Functions

const STRINGGetSinkType ()
 < derived classes must implement
const STRINGGetSinkURI ()
 Function GetSinkURI returns absolute location of the library sink.
virtual STRING WritePart (const STRING &aPartName, const STRING &aSExpression)=0 throw ( IO_ERROR )
 Function WritePart saves the part to non-volatile storage.

Friends

class LIB
 only the LIB uses these functions.

Detailed Description

Class LIB_SINK is an abstract class from which implementation specific LIB_SINKs may be derived, one for each kind of library type in the library table that supports writing.

The class name stems from the fact that this interface only provides WRITE functions.

Author:
Dick Hollenbeck

Definition at line 156 of file sch_lib.h.


Member Function Documentation

const STRING& SCH::LIB_SINK::GetSinkType (  )  [inline, protected]

< derived classes must implement

Function GetSinkType returns the library table entry's type for this library sink.

Definition at line 166 of file sch_lib.h.

{ return sinkType; }

virtual STRING SCH::LIB_SINK::WritePart ( const STRING aPartName,
const STRING aSExpression 
) throw ( IO_ERROR ) [protected, pure virtual]

Function WritePart saves the part to non-volatile storage.

aPartName may have the revision portion present. If it is not present, and a overwrite of an existhing part is done, then LIB::ReloadPart() must be called on this same part and all parts that inherit it must be reparsed.

Returns:
STRING - if the LIB_SINK support revision numbering, then return a revision name that was next in the sequence, e.g. "rev22", else "".

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