'\"! tbl | mmdoc
'\"macro stdmacro
.ie n \{\
.   ds Cr \fB
.   ds Cb \fB
.\}
.el \{\
.   ds Cr \f7
.   ds Cb \f8
.\}
.TH SoTranSender(3IV)
.SH NAME
SoTranSender \(em sends database changes for transcription 
.SH INHERITS FROM
SoTranSender
.SH SYNOPSIS
.ps -1
\*(Cr#include <Inventor/misc/SoTranscribe.h>
.sp
.in 1i
\f1Methods from class SoTranSender:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoTranSender\*(Cr(SoOutput *output)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cb~SoTranSender\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSoOutput *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetOutput\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbinsert\*(Cr(SoNode *node)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbinsert\*(Cr(SoNode *node, SoNode *parent, int n)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbremove\*(Cr(SoNode *parent, int n)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbreplace\*(Cr(SoNode *parent, int n, SoNode *newNode)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbmodify\*(Cr(SoNode *node)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbprepareToSend\*(Cr()
.sp
.SH 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. 
.sp
The \*(CbSoTranSender\f1 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 \*(CbSoOutput\f1 instance. It supports a limited set of changes to a database; each change is stored as a
\&command in the transcription area. The \*(CbSoTranReceiver\f1 class can be used at the other end to interpret the transcribed commands. 
.SH METHODS
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoTranSender\*(Cr(SoOutput *output)
.br
.in 1i
\f1The constructor takes a pointer to an \*(CbSoOutput\f1 instance that determines what the transcription area is (file or memory). 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cb~SoTranSender\*(Cr()
.br
.in 1i
\f1Destructor. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSoOutput *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetOutput\*(Cr() const
.br
.in 1i
\f1Returns pointer to current \*(CbSoOutput\f1 instance. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbinsert\*(Cr(SoNode *node)
.br
.in 1i
\f1Adds 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. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbinsert\*(Cr(SoNode *node, SoNode *parent, int n)
.br
.in 1i
\f1Adds an INSERT command to the transcription area. The given node will be added as the \*(Crn\f1th 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. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbremove\*(Cr(SoNode *parent, int n)
.br
.in 1i
\f1Adds a REMOVE command to the transcription area. The \*(Crn\f1th child of the given (non-NULL) parent node on the receiving end will be removed. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbreplace\*(Cr(SoNode *parent, int n, SoNode *newNode)
.br
.in 1i
\f1Adds a REPLACE command to the transcription area. The \*(Crn\f1th child of the given (non-NULL) parent node on the receiving end will be replaced with \*(CrnewNode\f1. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbmodify\*(Cr(SoNode *node)
.br
.in 1i
\f1Adds 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. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbprepareToSend\*(Cr()
.br
.in 1i
\f1Prepares a \*(CbSoTranSender\f1 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. 
.sp
.in 0.5i
.SH SEE ALSO
\*(CbSoOutput, SoTranReceiver