.TH "ScXMLAssignElt" 3 "Sat Oct 12 2013" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME ScXMLAssignElt \- .PP the SCXML element\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBScXMLExecutableElt\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const " .br .RI "\fIReturns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. \fP" .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 .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 .RI "\fIThis static method returns the \fBSoType\fP object associated with objects of this class\&. \fP" .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 .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" .SH "Detailed Description" .PP the SCXML element\&. The \fC\fP element is only functional under a profile that has an implementation of The Data Module\&. The \fC'minimum'\fP profile does not implement one, but the \fC'x-coin'\fP profile does\&. .PP The following attributes are accepted: .PD 0 .IP "\(bu" 2 \fClocation\fP .IP "\(bu" 2 \fCdataID\fP .IP "\(bu" 2 \fCexpr\fP .PP Only one of \fClocation\fP and \fCdataID\fP can be specified at a time\&. .PP If \fCdataID\fP is specified, then the target of the assignment is the \fC\fP element that has the \fCID\fP attribute set to the same value\&. .PP If \fClocation\fP is specified, a profile-dependent variable addressing is used\&. The \fC'minimum'\fP profile does not define any, and the \fC'x-coin'\fP profile defines the following address schemes for writable variables: .PD 0 .IP "\(bu" 2 \fC_data\fP\&.{id} means targeting an existing \fC\fP variable\&. .IP "\(bu" 2 \fCcoin:temp\fP\&.{id} means targeting a temporary variable, creating one if necessary\&. .PP Temporary variables in the \fC'x-coin'\fP profile have the lifetime of one SCXML event\&. To have persistent data, use \fC\fP variables\&. They stay alive for the same duration the \fBScXMLStateMachine\fP exists\&. .PP Temporary variables are particularly useful for the \fC\fP element, because the \fCnamelist\fP attribute can address them with implicit prefix, which means the event targets can read them out based on logical names instead of SCXML datamodel 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::getClassTypeId (void)\fC [static]\fP" .PP This static method returns the \fBSoType\fP object associated with objects of this class\&. \fBSee Also:\fP .RS 4 \fBSoBase::getClassTypeId\fP .RE .PP .PP Reimplemented from \fBScXMLExecutableElt\fP\&. .SS "\fBSoType\fP ScXMLAssignElt::getTypeId (void) const\fC [virtual]\fP" .PP Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. \fBSee Also:\fP .RS 4 \fBSoBase::getTypeId() const\fP .RE .PP .PP Implements \fBScXMLExecutableElt\fP\&. .SS "void ScXMLAssignElt::initClass (void)\fC [static]\fP" Creates the \fBScXMLAssignElt\fP class type \fBSoType\fP object\&. .PP Reimplemented from \fBScXMLExecutableElt\fP\&. .SS "void ScXMLAssignElt::cleanClass (void)\fC [static]\fP" Cleans out the class type \fBSoType\fP object\&. .PP Reimplemented from \fBScXMLExecutableElt\fP\&. .SS "SbBool ScXMLAssignElt::handleXMLAttributes (void)\fC [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 "const \fBScXMLElt\fP * ScXMLAssignElt::search (const char *attrname, const char *attrvalue) const\fC [virtual]\fP" This method searches the SCXML structure for an element with the given attributevalue 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\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.