.TH "SoTempPath" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoTempPath \- The \fBSoTempPath\fP class is used to store temporary paths\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoFullPath\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBSoTempPath\fP (const int approxlength)" .br .ti -1c .RI "void \fBsimpleAppend\fP (\fBSoNode\fP *const node, const int index)" .br .ti -1c .RI "void \fBreplaceTail\fP (\fBSoNode\fP *const node, const int index)" .br .in -1c Public Member Functions inherited from \fBSoFullPath\fP .in +1c .ti -1c .RI "void \fBpop\fP (void)" .br .ti -1c .RI "\fBSoNode\fP * \fBgetTail\fP (void) const" .br .ti -1c .RI "\fBSoNode\fP * \fBgetNodeFromTail\fP (const int index) const" .br .ti -1c .RI "int \fBgetIndexFromTail\fP (const int index) const" .br .ti -1c .RI "int \fBgetLength\fP (void) const" .br .in -1c Public Member Functions inherited from \fBSoPath\fP .in +1c .ti -1c .RI "\fBSoPath\fP (const int approxlength=4)" .br .ti -1c .RI "\fBSoPath\fP (\fBSoNode\fP *const head)" .br .ti -1c .RI "\fBSoPath\fP (const \fBSoPath\fP &rhs)" .br .ti -1c .RI "\fBSoPath\fP & \fBoperator=\fP (const \fBSoPath\fP &rhs)" .br .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const" .br .RI "Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. " .ti -1c .RI "void \fBsetHead\fP (\fBSoNode\fP *const head)" .br .ti -1c .RI "\fBSoNode\fP * \fBgetHead\fP (void) const" .br .ti -1c .RI "void \fBappend\fP (const int childindex)" .br .ti -1c .RI "void \fBappend\fP (\fBSoNode\fP *const node)" .br .ti -1c .RI "void \fBappend\fP (const \fBSoPath\fP *const frompath)" .br .ti -1c .RI "void \fBpush\fP (const int childindex)" .br .ti -1c .RI "void \fBpop\fP (void)" .br .ti -1c .RI "\fBSoNode\fP * \fBgetTail\fP (void) const" .br .ti -1c .RI "\fBSoNode\fP * \fBgetNode\fP (const int index) const" .br .ti -1c .RI "\fBSoNode\fP * \fBgetNodeFromTail\fP (const int index) const" .br .ti -1c .RI "int \fBgetIndex\fP (const int index) const" .br .ti -1c .RI "int \fBgetIndexFromTail\fP (const int index) const" .br .ti -1c .RI "int \fBgetLength\fP (void) const" .br .ti -1c .RI "void \fBtruncate\fP (const int length)" .br .ti -1c .RI "int \fBfindFork\fP (const \fBSoPath\fP *const path) const" .br .ti -1c .RI "int \fBfindNode\fP (const \fBSoNode\fP *const node) const" .br .ti -1c .RI "SbBool \fBcontainsNode\fP (const \fBSoNode\fP *const node) const" .br .ti -1c .RI "SbBool \fBcontainsPath\fP (const \fBSoPath\fP *const path) const" .br .ti -1c .RI "\fBSoPath\fP * \fBcopy\fP (const int startfromnodeindex=0, int numnodes=0) const" .br .ti -1c .RI "void \fBinsertIndex\fP (\fBSoNode\fP *const parent, const int newindex)" .br .ti -1c .RI "void \fBremoveIndex\fP (\fBSoNode\fP *const parent, const int oldindex)" .br .ti -1c .RI "void \fBreplaceIndex\fP (\fBSoNode\fP *const parent, const int index, \fBSoNode\fP *const newchild)" .br .ti -1c .RI "SbBool \fBisRelevantNotification\fP (\fBSoNotList\fP *const l) const" .br .ti -1c .RI "virtual void \fBwrite\fP (\fBSoWriteAction\fP *action)" .br .in -1c Public Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "void \fBref\fP (void) const" .br .ti -1c .RI "void \fBunref\fP (void) const" .br .ti -1c .RI "void \fBunrefNoDelete\fP (void) const" .br .ti -1c .RI "int32_t \fBgetRefCount\fP (void) const" .br .ti -1c .RI "void \fBtouch\fP (void)" .br .ti -1c .RI "SbBool \fBisOfType\fP (\fBSoType\fP type) const" .br .RI "Returns \fRTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. " .ti -1c .RI "virtual \fBSbName\fP \fBgetName\fP (void) const" .br .ti -1c .RI "virtual void \fBsetName\fP (const \fBSbName\fP &newname)" .br .ti -1c .RI "virtual void \fBstartNotify\fP (void)" .br .ti -1c .RI "virtual void \fBnotify\fP (\fBSoNotList\fP *l)" .br .ti -1c .RI "void \fBaddAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)" .br .ti -1c .RI "void \fBremoveAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)" .br .ti -1c .RI "const \fBSoAuditorList\fP & \fBgetAuditors\fP (void) const" .br .ti -1c .RI "virtual void \fBaddWriteReference\fP (\fBSoOutput\fP *out, SbBool isfromfield=FALSE)" .br .ti -1c .RI "SbBool \fBshouldWrite\fP (void)" .br .ti -1c .RI "void \fBassertAlive\fP (void) const" .br .in -1c .SS "Additional Inherited Members" Static Public Member Functions inherited from \fBSoPath\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. " .ti -1c .RI "static \fBSoPath\fP * \fBgetByName\fP (const \fBSbName\fP name)" .br .ti -1c .RI "static int \fBgetByName\fP (const \fBSbName\fP name, \fBSoPathList\fP &l)" .br .in -1c Static Public Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. " .ti -1c .RI "static void \fBaddName\fP (\fBSoBase\fP *const base, const char *const name)" .br .ti -1c .RI "static void \fBremoveName\fP (\fBSoBase\fP *const base, const char *const name)" .br .ti -1c .RI "static void \fBincrementCurrentWriteCounter\fP (void)" .br .ti -1c .RI "static void \fBdecrementCurrentWriteCounter\fP (void)" .br .ti -1c .RI "static \fBSoBase\fP * \fBgetNamedBase\fP (const \fBSbName\fP &name, \fBSoType\fP type)" .br .ti -1c .RI "static int \fBgetNamedBases\fP (const \fBSbName\fP &name, \fBSoBaseList\fP &baselist, \fBSoType\fP type)" .br .ti -1c .RI "static SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP expectedtype)" .br .ti -1c .RI "static void \fBsetInstancePrefix\fP (const \fBSbString\fP &c)" .br .ti -1c .RI "static void \fBsetTraceRefs\fP (SbBool trace)" .br .ti -1c .RI "static SbBool \fBgetTraceRefs\fP (void)" .br .ti -1c .RI "static SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, const \fBSbName\fP &fromnodename, const \fBSbName\fP &fromfieldname, const \fBSbName\fP &tonodename, const \fBSbName\fP &tofieldname)" .br .ti -1c .RI "static SbBool \fBreadRoute\fP (\fBSoInput\fP *input)" .br .in -1c Public Attributes inherited from \fBSoBase\fP Protected Types inherited from \fBSoBase\fP .in +1c .ti -1c .RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }" .br .in -1c Protected Member Functions inherited from \fBSoPath\fP .in +1c .ti -1c .RI "virtual \fB~SoPath\fP ()" .br .ti -1c .RI "void \fBauditPath\fP (const SbBool flag)" .br .in -1c Protected Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "\fBSoBase\fP (void)" .br .ti -1c .RI "virtual \fB~SoBase\fP ()" .br .ti -1c .RI "virtual void \fBdestroy\fP (void)" .br .ti -1c .RI "SbBool \fBhasMultipleWriteRefs\fP (void) const" .br .ti -1c .RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *out, SbBool isgroup, SbBool isengine) const" .br .ti -1c .RI "void \fBwriteFooter\fP (\fBSoOutput\fP *out) const" .br .ti -1c .RI "virtual const char * \fBgetFileFormatName\fP (void) const" .br .ti -1c .RI "virtual \fBSoNotRec\fP \fBcreateNotRec\fP (void)" .br .in -1c Static Protected Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "static uint32_t \fBgetCurrentWriteCounter\fP (void)" .br .ti -1c .RI "static void \fBstaticDataLock\fP (void)" .br .ti -1c .RI "static void \fBstaticDataUnlock\fP (void)" .br .in -1c .SH "Detailed Description" .PP The \fBSoTempPath\fP class is used to store temporary paths\&. The path simply turns off auditing in the constructor, and leaves the user with the responsibility of keeping the path valid\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoTempPath::SoTempPath (const int approxlength)" Constructor\&. .SH "Member Function Documentation" .PP .SS "void SoTempPath::simpleAppend (\fBSoNode\fP *const node, const int index)" Append a node (specified by \fInode\fP and parent child \fIindex\fP) to the path\&. This method is only available in \fBSoTempPath\fP, since it will not consider auditing or hidden children\&. .SS "void SoTempPath::replaceTail (\fBSoNode\fP *const node, const int index)" Replace the tail of this path\&. The node is specified by \fInode\fP and parent child \fIindex\fP\&. This method is only available in \fBSoTempPath\fP, since it will not consider auditing or hidden children\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.