RixRIB Class Reference

#include <RixRIB.h>

Inheritance diagram for RixRIB:
RixInterface

Public Member Functions

virtual Ri * CreateRIBGenerator (Ri *parent=0L)=0
 
virtual void DestroyRIBGenerator (Ri *)=0
 Destructs a RIB generator created by CreateRIBGenerator()
 
- Public Member Functions inherited from RixInterface
virtual int GetVersion () const
 

Protected Member Functions

 RixRIB ()
 Constructor is for internal use only.
 
- Protected Member Functions inherited from RixInterface
 RixInterface (int version)
 Interfaces should not be constructed by users.
 
virtual ~RixInterface ()
 Interfaces should not be deleted by users.
 

Additional Inherited Members

- Protected Attributes inherited from RixInterface
int m_version
 Version number of this interface.
 

Detailed Description

The RixRIB interface provides a factory class to manufacture RIB generation contexts. A typical use of this factory is:

Ri *rib = ribRixInterface->CreateRIBGenerator();
rib->Begin("hello.rib");
rib->ArchiveRecord(RI_COMMENT, "Hello World, from %s", argv[0]);
rib->End();
ribif->DestroyRIBGenerator(rib);

NOTE: RIB generation contexts can be produced relative to others to share the binary encoding contexts and symbol table state.

Member Function Documentation

virtual Ri* RixRIB::CreateRIBGenerator ( Ri *  parent = 0L)
pure virtual

Return a pointer to RIB generator, or NULL of there is an error. If parent is non-NULL the RIB generator created will share the binary encoding and symbol table of the parent generator.


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