GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOTRANSENDER (3)

NAME

SoTranSender — sends database changes for transcription

CONTENTS

Inherits From
Synopsis
Description
Methods
See Also

INHERITS FROM

SoTranSender

SYNOPSIS

#include <Inventor/misc/SoTranscribe.h>

Methods from class SoTranSender:

       
                    
                     SoTranSender(SoOutput *output)    
   
                    
                     ~SoTranSender()    
SoOutput *    
                    
SoOutput *           getOutput() const    
void    
                    
void                 insert(SoNode *node)    
void    
                    
void                 insert(SoNode *node, SoNode *parent, int n)    
void    
                    
void                 remove(SoNode *parent, int n)    
void    
                    
void                 replace(SoNode *parent, int n, SoNode *newNode)    
void    
                    
void                 modify(SoNode *node)    
void    
                    
void                 prepareToSend()

DESCRIPTION

This class is used for transcribing Inventor data. Transcription is the process of packaging changes to a database and sending them over a "wire" to another database.

The SoTranSender class is used on the sending side of transcription. It packages up changes to a Inventor database into a file or memory area defined by an SoOutput instance. It supports a limited set of changes to a database; each change is stored as a command in the transcription area. The SoTranReceiver class can be used at the other end to interpret the transcribed commands.

METHODS

       
                    
                     SoTranSender(SoOutput *output)
The constructor takes a pointer to an SoOutput instance that determines what the transcription area is (file or memory).

       
                    
                     ~SoTranSender()
Destructor.

    SoOutput *    
                    
SoOutput *           getOutput() const
Returns pointer to current SoOutput instance.

    void    
                    
void                 insert(SoNode *node)
Adds an INSERT command to the transcription area. The given node will be added as the last child of the root node on the receiving end.

    void    
                    
void                 insert(SoNode *node, SoNode *parent, int n)
Adds an INSERT command to the transcription area. The given node will be added as the nth child of the given parent node on the receiving end. A NULL parent node causes the node to be added to the receiving end’s root node.

    void    
                    
void                 remove(SoNode *parent, int n)
Adds a REMOVE command to the transcription area. The nth child of the given (non-NULL) parent node on the receiving end will be removed.

    void    
                    
void                 replace(SoNode *parent, int n, SoNode *newNode)
Adds a REPLACE command to the transcription area. The nth child of the given (non-NULL) parent node on the receiving end will be replaced with newNode.

    void    
                    
void                 modify(SoNode *node)
Adds a MODIFY command to the transcription area. Updates the field data for the given node to the new contents. Note that this changes only field data; children of groups are not affected, nor is any non-field instance data.

    void    
                    
void                 prepareToSend()
Prepares a SoTranSender instance for transcription, making sure the transcription area is complete and all packaged to go. This must be called before the transcription can be performed.

SEE ALSO

SoOutput, SoTranReceiver

Search for    or go to Top of page |  Section 3 |  Main Index


SOTRANSENDER(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.