Rhino C++ API
8.10
|
#include <IRhRdk_XMLSection.h>
Classes | |
class | IExtraRequirements |
class | Iterator |
Public Member Functions | |
virtual | ~IRhRdk_XMLSection () |
virtual ON_wString | AsString (void) const =0 |
virtual void | DebugDump (void) const =0 |
virtual void * | EVF (const wchar_t *, void *)=0 |
virtual bool | GetParam (const wchar_t *wszParamName, CRhRdkVariant &vParamValueOut, const IExtraRequirements **ppExtraOut=NULL) const =0 |
virtual bool | IsEqual (const IRhRdk_XMLSection &s) const =0 |
virtual Iterator * | NewIterator (void) const =0 |
virtual bool | NextParam (Iterator *pIterator, ON_wString &sParamNameOut, CRhRdkVariant &vParamValueOut, const IExtraRequirements **ppExtraOut=NULL) const =0 |
virtual void | SetAsString (const wchar_t *wsz)=0 |
virtual void | SetParam (const wchar_t *wszParamName, const CRhRdkVariant &vParamValue, const IExtraRequirements *pExtra=NULL, const wchar_t *wszBeacon=NULL)=0 |
This interface represents one section of an XML stream. For example:
<section> <color type="color">0.5,0.8,0.9</color> <depth type="float">1.0</depth> <radius type="double" special="true" >5.0</radius> </section>
the interface can be used to access the color, depth and radius values. 'special' is a marker-string ('beacon') which can be used for searching.
|
inlinevirtual |
|
pure virtual |
Get the section data as an XML string.
|
pure virtual |
Dump the parameters to the debugger output pane.
|
pure virtual |
Emergency virtual function for future expansion.
|
pure virtual |
Get a parameter by its internal name.
wszParamName | is the name of the parameter to get. |
vParamValueOut | receives the value of the parameter if it exists. |
ppExtraOut | is an optional pointer that, if not NULL, will receive a pointer to an object containing the data of the parameter's extra requirements. |
|
pure virtual |
|
pure virtual |
Get an iterator to use when calling NextParam(). The caller shall delete the iterator.
|
pure virtual |
Get the next parameter name and value from the section.
|
pure virtual |
Set the section data from an XML string.
|
pure virtual |
Set a parameter. The parameter is created if it doesn't exist.
wszParamName | is the name that will appear in the XML output. |
vParamValue | is the value to assign to the name. |
pExtra | is an optional pointer to an object containing data for extra requirements. |
wszBeacon | is an optional marker string which will appear in the XML output and can be used for special purpose searching. |