.TH "ScXMLAssignElt" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME ScXMLAssignElt \- the SCXML element\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBScXMLExecutableElt\fP\&. .SS "Public Member Functions" .in +1c .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 "\fBScXMLAssignElt\fP (void)" .br .ti -1c .RI "virtual void \fBsetLocationAttribute\fP (const char *location)" .br .ti -1c .RI "virtual const char * \fBgetLocationAttribute\fP (void) const" .br .ti -1c .RI "virtual void \fBsetDataIDAttribute\fP (const char *dataID)" .br .ti -1c .RI "virtual const char * \fBgetDataIDAttribute\fP (void) const" .br .ti -1c .RI "virtual void \fBsetExprAttribute\fP (const char *expr)" .br .ti -1c .RI "virtual const char * \fBgetExprAttribute\fP (void) const" .br .ti -1c .RI "virtual SbBool \fBhandleXMLAttributes\fP (void)" .br .ti -1c .RI "virtual void \fBcopyContents\fP (const \fBScXMLElt\fP *rhs)" .br .ti -1c .RI "virtual const \fBScXMLElt\fP * \fBsearch\fP (const char *attrname, const char *attrvalue) const" .br .ti -1c .RI "virtual void \fBexecute\fP (\fBScXMLStateMachine\fP *statemachine) const" .br .in -1c Public Member Functions inherited from \fBScXMLExecutableElt\fP Public Member Functions inherited from \fBScXMLElt\fP .in +1c .ti -1c .RI "void \fBsetXMLAttribute\fP (const char *attribute, const char *value)" .br .ti -1c .RI "const char * \fBgetXMLAttribute\fP (const char *attribute) const" .br .ti -1c .RI "\fBScXMLElt\fP * \fBclone\fP (void) const" .br .ti -1c .RI "virtual void \fBsetContainer\fP (\fBScXMLElt\fP *container)" .br .ti -1c .RI "\fBScXMLElt\fP * \fBgetContainer\fP (void) const" .br .ti -1c .RI "SbBool \fBisContainedIn\fP (const \fBScXMLElt\fP *object) const" .br .in -1c Public Member Functions inherited from \fBScXMLObject\fP .in +1c .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\&. " .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBScXMLEltReader\fP * \fBgetElementReader\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void * \fBcreateInstance\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBcleanClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBScXMLExecutableElt\fP .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBcleanClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBScXMLElt\fP .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBcleanClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBScXMLObject\fP .in +1c .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 \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 void \fBcleanClass\fP (void)" .br .RI "Does the opposite of initClass, deallocates any class specific resources and resets the class to an uninitialized state with respect to the Coin type system\&. " .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "char * \fBlocation\fP" .br .ti -1c .RI "char * \fBdataID\fP" .br .ti -1c .RI "char * \fBexpr\fP" .br .in -1c .SS "Additional Inherited Members" Static Protected Member Functions inherited from \fBScXMLElt\fP .in +1c .ti -1c .RI "static void \fBregisterClassType\fP (const char *xmlns, const char *classname, \fBSoType\fP type)" .br .ti -1c .RI "static void \fBregisterInvokeClassType\fP (const char *xmlns, const char *targettype, const char *source, \fBSoType\fP type)" .br .in -1c Static Protected Member Functions inherited from \fBScXMLObject\fP .in +1c .ti -1c .RI "static void \fBregisterClassType\fP (const char *xmlns, const char *classname, \fBSoType\fP type)" .br .ti -1c .RI "static void \fBregisterInvokeClassType\fP (const char *xmlns, const char *targettype, const char *source, \fBSoType\fP type)" .br .in -1c .SH "Detailed Description" .PP the SCXML element\&. The \fR\fP element is only functional under a profile that has an implementation of the Data Module\&. The \fR'minimum'\fP profile does not implement one, but the \fR'x-coin'\fP profile does\&. .PP The following attributes are accepted: .PD 0 .IP "\(bu" 1 \fRlocation\fP .IP "\(bu" 1 \fRdataID\fP .IP "\(bu" 1 \fRexpr\fP .PP Either \fRlocation\fP or \fRdataID\fP can be specified at a time\&. .PP If \fRdataID\fP is specified, then the target of the assignment is the \fR\fP element that has the \fRID\fP attribute set to the same value\&. .PP If \fRlocation\fP is specified, a profile-dependent variable addressing is used\&. The \fR'minimum'\fP profile does not define any, and the \fR'x-coin'\fP profile defines the following address schemes for writable variables: .PD 0 .IP "\(bu" 1 \fR_data\fP\&.{id} means targeting an existing \fR\fP variable\&. .IP "\(bu" 1 \fRcoin:temp\fP\&.{id} means targeting a temporary variable, creating one if necessary\&. .PP Temporary variables in the \fR'x-coin'\fP profile have the lifetime of one SCXML event\&. To have persistent data, use \fR\fP variables\&. They stay alive for the same duration the \fBScXMLStateMachine\fP exists\&. .PP Temporary variables are particularly useful for the \fR\fP element, because the \fRnamelist\fP attribute can address them with implicit prefix, which means the event targets can read them out based on logical names instead of SCXML data model addresses\&. .PP \fBSee also\fP .RS 4 \fBScXMLDataModelElt\fP, \fBScXMLDataElt\fP, \fBScXMLSendElt\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "ScXMLAssignElt::ScXMLAssignElt (void )" Constructor that sets up an empty \fBScXMLAssignElt\fP object\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP ScXMLAssignElt::getTypeId (void ) const\fR [virtual]\fP" .PP Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. .PP \fBSee also\fP .RS 4 \fBSoBase::getTypeId() const\fP .RE .PP .PP Implements \fBScXMLExecutableElt\fP\&. .SS "void ScXMLAssignElt::initClass (void )\fR [static]\fP" Creates the \fBScXMLAssignElt\fP class type \fBSoType\fP object\&. .SS "void ScXMLAssignElt::cleanClass (void )\fR [static]\fP" Cleans out the class type \fBSoType\fP object\&. .SS "SbBool ScXMLAssignElt::handleXMLAttributes (void )\fR [virtual]\fP" This method is called when the file reader has set all the XML attributes on the object, and wants the object to handle them and report if the values were OK or if a read error should be produced\&. .PP \fBReturns\fP .RS 4 TRUE if the attributes are OK, and FALSE on error\&. .RE .PP This base class implementation does nothing and just returns TRUE\&. .PP Reimplemented from \fBScXMLElt\fP\&. .SS "void ScXMLAssignElt::copyContents (const \fBScXMLElt\fP * rhs)\fR [virtual]\fP" .PP Reimplemented from \fBScXMLExecutableElt\fP\&. .SS "const \fBScXMLElt\fP * ScXMLAssignElt::search (const char * attrname, const char * attrvalue) const\fR [virtual]\fP" This method searches the SCXML structure for an element with the given attribute value for the given attribute\&. .PP Returns NULL if nothing was found\&. .PP This function needs to be reimplemented to traverse child elements\&. .PP Reimplemented from \fBScXMLElt\fP\&. .SS "void ScXMLAssignElt::execute (\fBScXMLStateMachine\fP * statemachine) const\fR [virtual]\fP" .PP Reimplemented from \fBScXMLExecutableElt\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.