tecplot::toolbox::StyleValue

tecplot::toolbox::StyleValue Class Reference

StyleValue sets and gets Tecplot styles. More...

#include <StyleValue.h>


Public Member Functions

 StyleValue (const char *P1=NULL, const char *P2=NULL, const char *P3=NULL, const char *P4=NULL, const char *P5=NULL, const char *P6=NULL, const char *P7=NULL)
 Create a StyleValue object, which may be used to set and get style values from Tecplot.
 StyleValue (const StringList &paramList)
 Alternate constructor.
 StyleValue (const StyleValue &other)
virtual ~StyleValue ()
const StringList & getParamList () const
 Return StringList of parameters used during the construction of the object.
template<typename T>
SetValueReturnCode_e set (T value, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Sets a style value within Tecplot.
template<typename T>
SetValueReturnCode_e set (T value, LgIndex_t offset1, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Sets a style value within Tecplot.
template<typename T>
SetValueReturnCode_e set (T value, AssignOp_e assignOp, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Sets a style value within Tecplot.
template<typename T>
SetValueReturnCode_e set (T value, LgIndex_t offset1, AssignOp_e assignOp, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Sets a style value within Tecplot.
template<typename T>
SetValueReturnCode_e set (T value, LgIndex_t offset1, LgIndex_t offset2, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Sets a style value within Tecplot.
template<typename T>
SetValueReturnCode_e set (T value, LgIndex_t offset1, LgIndex_t offset2, AssignOp_e assignOp, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Sets a style value within Tecplot.
template<typename T>
SetValueReturnCode_e set (T value, const Set &objectSet, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Sets a style value within Tecplot.
template<typename T>
SetValueReturnCode_e set (T value, const Set &objectSet, AssignOp_e assignOp, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Sets a style value within Tecplot.
template<typename T>
GetValueReturnCode_e get (T *value, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Gets a style value from Tecplot.
template<typename T>
GetValueReturnCode_e get (T *value, LgIndex_t offset1, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Gets a style value from Tecplot.
template<typename T>
GetValueReturnCode_e get (T *value, LgIndex_t offset1, LgIndex_t offset2, const char *aP1=NULL, const char *aP2=NULL, const char *aP3=NULL, const char *aP4=NULL, const char *aP5=NULL, const char *aP6=NULL, const char *aP7=NULL) const
 Gets a style value from Tecplot.

Static Public Member Functions

static bool returnCodeOk (SetValueReturnCode_e SVRC)
 Check to see if the return code is considered ok.
static bool returnCodeOk (GetValueReturnCode_e GVRC)
 Check to see if the return code is considered ok.

Protected Member Functions

virtual SetValueReturnCode_e styleSetLowLevel (const ArgList &argList) const
 Set the value in Tecplot.
template<typename T>
SetValueReturnCode_e setFinalValue (T value, ArgList &argList) const
SetValueReturnCode_e setFinalValue (bool value, ArgList &argList) const
SetValueReturnCode_e setFinalValue (int value, ArgList &argList) const
SetValueReturnCode_e setFinalValue (double value, ArgList &argList) const
SetValueReturnCode_e setFinalValue (const Set_pa value, ArgList &argList) const
SetValueReturnCode_e setFinalValue (const Set &value, ArgList &argList) const
SetValueReturnCode_e setFinalValue (const char *value, ArgList &argList) const
SetValueReturnCode_e setFinalValue (const std::string &value, ArgList &argList) const
template<typename T>
SetValueReturnCode_e setValue (const T &value, const StringList &extraParams, const Set *objectSet, LgIndex_t offset1, LgIndex_t offset2, AssignOp_e assignOp) const
virtual GetValueReturnCode_e styleGetLowLevel (const ArgList &argList) const
 Get the value from Tecplot.
template<typename T>
GetValueReturnCode_e getFinalValue (T *value, ArgList &argList) const
GetValueReturnCode_e getFinalValue (bool *value, ArgList &argList) const
GetValueReturnCode_e getFinalValue (double *value, ArgList &argList) const
GetValueReturnCode_e getFinalValue (std::string *value, ArgList &argList) const
GetValueReturnCode_e getFinalValue (char **value, ArgList &argList) const
GetValueReturnCode_e getFinalValue (Set *value, ArgList &argList) const
GetValueReturnCode_e getFinalValue (Set_pa *value, ArgList &argList) const
template<typename T>
GetValueReturnCode_e getValue (T *value, LgIndex_t offset1, LgIndex_t offset2, const StringList &extraParams) const
const char * getPValueString (int depth) const
void validateParamList (StringList &stringList) const
void setupPValueArgList (const StringList &parameters, ArgList &argList) const
void setupSetValueArgList (const StringList &parameters, const Set *objectSet, LgIndex_t offset1, LgIndex_t offset2, AssignOp_e assignOp, ArgList &argList) const
void setupGetValueArgList (const StringList &parameters, LgIndex_t offset1, LgIndex_t offset2, ArgList &argList) const

Detailed Description

StyleValue sets and gets Tecplot styles.

This class may be used in place of TecUtilStyleSetLowLevelX and TecUtilStyleGetLowLevelX functions.

Constructor & Destructor Documentation

tecplot::toolbox::StyleValue::StyleValue ( const char *  P1 = NULL,
const char *  P2 = NULL,
const char *  P3 = NULL,
const char *  P4 = NULL,
const char *  P5 = NULL,
const char *  P6 = NULL,
const char *  P7 = NULL 
)

Create a StyleValue object, which may be used to set and get style values from Tecplot.

Parameters:
P1 P1 - P7 are SV_ constants as described in the documentation for TecUtilStyleSetLowLevel, TecUtilStyleSetLowLevelX and TecUtilStyleGetLowLevelX. These constant represent the heirarchy of Tecplot's internal data structures and match the order that would be used if creating an equivalent macro command.
You may supply zero or more of these SV_ constants in the constructor. Any contants supplied will be considered "base" constants. When calling StyleValue::set() and StyleValue::get() any SV_ constants will be considered "extra" constants.

Parameters:
P2 See P1
P3 See P1
P4 See P1
P5 See P1
P6 See P1
P7 See P1
   //
   // Setting values
   //

   // Create a generic style value object
   StyleValue genericSV;
   // Set the X position of the current frame to 1
   genericSV.set(1, SV_FRAMELAYOUT, SV_XYPOS, SV_X);

   // Here's another way to do it.
   //
   // Create a style value object that operates on FRAMELAYOUT->XYPOS
   StyleValue frameLayoutXYPosSV(SV_FRAMELAYOUT, SV_XYPOS);
   // Set the X position of the current frame to 1
   frameLayoutXYPosSV.set(1, SV_X);

   // And yet another way
   //
   // Create a style value object that operates on FRAMELAYOUT->XYPOS->X
   StyleValue framePosX(SV_FRAMELAYOUT, SV_XYPOS, SV_X);
   framePosX.set(1);

   //
   // Getting values
   //

   // Create a generic style value object
   StyleValue genericSV;
   // Get the X position of the current frame.
   double frameXPos;
   genericSV.get(&frameXPos, SV_FRAMELAYOUT, SV_XYPOS, SV_X);

   // Here's another way to do it.
   //
   // Create a style value object that operates on FRAMELAYOUT->XYPOS
   StyleValue frameLayoutXYPosSV(SV_FRAMELAYOUT, SV_XYPOS);
   // Set the X position of the current frame to 1
   frameLayoutXYPosSV.get(&frameXPos, SV_X);

   // And yet another way
   //
   // Create a style value object that operates on FRAMELAYOUT->XYPOS->X
   StyleValue framePosX(SV_FRAMELAYOUT, SV_XYPOS, SV_X);
   framePosX.get(&frameXPos);

tecplot::toolbox::StyleValue::StyleValue ( const StringList &  paramList  ) 

Alternate constructor.

Parameters:
paramList A StringList containing zero or more P-Values which specify the style to operate on.

tecplot::toolbox::StyleValue::StyleValue ( const StyleValue &  other  ) 

virtual tecplot::toolbox::StyleValue::~StyleValue (  )  [virtual]

Member Function Documentation

const StringList& tecplot::toolbox::StyleValue::getParamList (  )  const [inline]

Return StringList of parameters used during the construction of the object.

static bool tecplot::toolbox::StyleValue::returnCodeOk ( SetValueReturnCode_e  SVRC  )  [static]

Check to see if the return code is considered ok.

Parameters:
SVRC A SetValueReturnCode_e, typically as a result of calling one of the StyleValue::set() methods.
Returns:
true if SVRC is SetValue_Ok or SetValue_DuplicateValue, false otherwise.

static bool tecplot::toolbox::StyleValue::returnCodeOk ( GetValueReturnCode_e  GVRC  )  [static]

Check to see if the return code is considered ok.

Parameters:
GVRC A GetValueReturnCode_e, typically as a result of calling one of the StyleValue::get() methods.
Returns:
true if GVRC is GetValue_Ok, false otherwise.

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::set ( T  value,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Sets a style value within Tecplot.

Note:
Tecplot must be locked when using this method.
Parameters:
value The value you want to set the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
SetValue_Ok - The command was formed correctly and the value was set. SetValue_DuplicateValue - The command was formed correctly and the value was already the value passed. Other values indicate an various errors.
   // Set the frame position to (2.5, 1.2)
   StyleValue framePos(SV_FRAMELAYOUT, SV_XYPOS);
   framePos.set(2.5, SV_X);
   framePos.set(1.2, SV_Y);

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::set ( T  value,
LgIndex_t  offset1,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Sets a style value within Tecplot.

Note:
Tecplot must be locked when using this method.
Parameters:
value The value you want to set the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
offset1 An offset value, generally used to specify which object group to use. Examples include SV_GLOBALCONTOUR, SV_SLICEATTRIBUTES, etc.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
SetValue_Ok - The command was formed correctly and the value was set. SetValue_DuplicateValue - The command was formed correctly and the value was already the value passed. Other values indicate an various errors.
   // Set the Slice contour type to Lines & Flood for slice group 2
   StyleValue sliceStyle(SV_SLICEATTRIBUTES);
   sliceStyle.set(ContourType_Overlay, 2, SV_CONTOUR, SV_CONTOURTYPE);

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::set ( T  value,
AssignOp_e  assignOp,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Sets a style value within Tecplot.

Note:
Tecplot must be locked when using this method.
Parameters:
value The value you want to set the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
assignOp An assignment operator for changing the desired style value.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
SetValue_Ok - The command was formed correctly and the value was set. SetValue_DuplicateValue - The command was formed correctly and the value was already the value passed. Other values indicate an various errors.
   // Remove field map 3 from the set of active field maps
   StyleValue activeFieldMaps(SV_ACTIVEFIELDMAPS);
   activeFieldMaps.set(Set(3), AssignOp_MinusEquals);

   // Double the current frame width
   StyleValue frameLayout(SV_FRAMELAYOUT);
   frameLayout.set(2.0, AssignOp_TimesEquals, SV_WIDTH);

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::set ( T  value,
LgIndex_t  offset1,
AssignOp_e  assignOp,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Sets a style value within Tecplot.

Note:
Tecplot must be locked when using this method.
Parameters:
value The value you want to set the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
offset1 An offset value, generally used to specify which object group to use. Examples include SV_GLOBALCONTOUR, SV_SLICEATTRIBUTES, etc.
assignOp An assignment operator for changing the desired style value.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
SetValue_Ok - The command was formed correctly and the value was set. SetValue_DuplicateValue - The command was formed correctly and the value was already the value passed. Other values indicate an various errors.

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::set ( T  value,
LgIndex_t  offset1,
LgIndex_t  offset2,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Sets a style value within Tecplot.

Note:
Tecplot must be locked when using this method.
Parameters:
value The value you want to set the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
offset1 An offset value, generally used to specify which object group to use. Examples include SV_GLOBALCONTOUR, SV_SLICEATTRIBUTES, etc.
offset2 As of Tecplot 11.2-0-302 only SV_COLORMAPOVERRIDE uses an offset2.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
SetValue_Ok - The command was formed correctly and the value was set. SetValue_DuplicateValue - The command was formed correctly and the value was already the value passed. Other values indicate an various errors.

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::set ( T  value,
LgIndex_t  offset1,
LgIndex_t  offset2,
AssignOp_e  assignOp,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Sets a style value within Tecplot.

Note:
Tecplot must be locked when using this method.
Parameters:
value The value you want to set the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
offset1 An offset value, generally used to specify which object group to use. Examples include SV_GLOBALCONTOUR, SV_SLICEATTRIBUTES, etc.
offset2 As of Tecplot 11.2-0-302 only SV_COLORMAPOVERRIDE uses an offset2.
assignOp An assignment operator for changing the desired style value.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
SetValue_Ok - The command was formed correctly and the value was set. SetValue_DuplicateValue - The command was formed correctly and the value was already the value passed. Other values indicate an various errors.

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::set ( T  value,
const Set &  objectSet,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Sets a style value within Tecplot.

Note:
Tecplot must be locked when using this method.
Parameters:
value The value you want to set the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
objectSet A Set that specifies which items to operate on. This is typically used with SV_FIELDMAP and SV_LINEMAP styles.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
SetValue_Ok - The command was formed correctly and the value was set. SetValue_DuplicateValue - The command was formed correctly and the value was already the value passed. Other values indicate an various errors.
   // Set the mesh color to Red and the line thickness to 1.2 
   // for field maps 1 through 5
   Set fieldMaps;
   fieldMaps.fromString("[1-5]");
   StyleValue fieldMapMesh(SV_FIELDMAP, SV_MESH);
   fieldMapMesh.set(Red_C, fieldMaps, SV_COLOR);
   fieldMapMesh.set(1.2, fieldMaps, SV_LINETHICKNESS);

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::set ( T  value,
const Set &  objectSet,
AssignOp_e  assignOp,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Sets a style value within Tecplot.

Note:
Tecplot must be locked when using this method.
Parameters:
value The value you want to set the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
objectSet A Set that specifies which items to operate on. This is typically used with SV_FIELDMAP and SV_LINEMAP styles.
assignOp An assignment operator for changing the desired style value.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
SetValue_Ok - The command was formed correctly and the value was set. SetValue_DuplicateValue - The command was formed correctly and the value was already the value passed. Other values indicate an various errors.
   // Set mesh line thickness to half its current width for fieldmaps 1 through 5
   Set fieldMaps;
   fieldMaps.fromString("[1-5]");
   StyleValue fieldMapMesh(SV_FIELDMAP, SV_MESH);
   fieldMapMesh.set(2, fieldMaps, AssignOp_DivideEquals, SV_LINETHICKNESS);

template<typename T>
GetValueReturnCode_e tecplot::toolbox::StyleValue::get ( T *  value,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Gets a style value from Tecplot.

Parameters:
value A pointer to value you want to get the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
GetValue_Ok if the value was retrieved. Passing the wrong type (double* instead of LgIndex_t*) will return GetValue_ResultTypeError. Unsupported sub-commands will return GetValue_SyntaxError.
   // Get the x position of the current frame.
   StyleValue genericSV;
   double     xPos;
   GetValueReturnCode_e GVRC = genericSV.get(&xPos, SV_FRAMELAYOUT, SV_XYPOS, SV_X);
   if ( genericSV.returnCodeOk(GVRC) )
     {
       // Do something with xPos
     }

template<typename T>
GetValueReturnCode_e tecplot::toolbox::StyleValue::get ( T *  value,
LgIndex_t  offset1,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Gets a style value from Tecplot.

Parameters:
value A pointer to value you want to get the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
offset1 Depending on the P-Values, this could represent a field map, line map, contour group, etc.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
GetValue_Ok if the value was retrieved. Passing the wrong type (double* instead of LgIndex_t*) will return GetValue_ResultTypeError. Unsupported sub-commands will return GetValue_SyntaxError.
   // Get the font of the contour legend header for contour group 2.
   StyleValue contLegendHeaderText(SV_GLOBALCONTOUR,SV_LEGEND,SV_HEADERTEXTSHAPE);
   Font_e font;
   int    group = 1;
   GetValueReturnCode_e GVRC = contLegendHeaderText.get(&font, group, SV_FONT);
   if ( contLegendHeaderText.returnCodeOk(GVRC) )
     {
       // Do something with font
     }

template<typename T>
GetValueReturnCode_e tecplot::toolbox::StyleValue::get ( T *  value,
LgIndex_t  offset1,
LgIndex_t  offset2,
const char *  aP1 = NULL,
const char *  aP2 = NULL,
const char *  aP3 = NULL,
const char *  aP4 = NULL,
const char *  aP5 = NULL,
const char *  aP6 = NULL,
const char *  aP7 = NULL 
) const [inline]

Gets a style value from Tecplot.

Parameters:
value A pointer to value you want to get the style of. This may include, but not limited to: LgIndex_t, EntIndex_t, double, char*, Set, ArbParam_t, ColorIndex_t, various enumerated types, etc.
offset1 Depending on the P-Values, this could represent a field map, line map, contour group, etc.
offset2 As of Tecplot 11.2-0-302 only SV_COLORMAPOVERRIDE uses an offset2.
aP1 Extra parameters that were not specified in the constructor of the object.
aP2 See aP1
aP3 See aP1
aP4 See aP1
aP5 See aP1
aP6 See aP1
aP7 See aP1
Returns:
GetValue_Ok if the value was retrieved. Passing the wrong type (double* instead of LgIndex_t*) will return GetValue_ResultTypeError. Unsupported sub-commands will return GetValue_SyntaxError.

virtual SetValueReturnCode_e tecplot::toolbox::StyleValue::styleSetLowLevel ( const ArgList &  argList  )  const [protected, virtual]

Set the value in Tecplot.

This method is the end of the road for the set methods.

Note:
Tecplot must be locked when using this method. You may wish to override this method with one that handles locking for you and optionally assert if the SetValueReturnCode is not SetValue_Ok or SetValue_DuplicateValue.
Parameters:
argList The complete argument list that is passed off to TecUtilStyleSetLowLevelX
Returns:
SetValue_Ok or SetValue_DuplicateValue if the value was set in Tecplot. Otherwise an appropriate error code will be returned.

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::setFinalValue ( T  value,
ArgList &  argList 
) const [inline, protected]

SetValueReturnCode_e tecplot::toolbox::StyleValue::setFinalValue ( bool  value,
ArgList &  argList 
) const [protected]

SetValueReturnCode_e tecplot::toolbox::StyleValue::setFinalValue ( int  value,
ArgList &  argList 
) const [protected]

SetValueReturnCode_e tecplot::toolbox::StyleValue::setFinalValue ( double  value,
ArgList &  argList 
) const [protected]

SetValueReturnCode_e tecplot::toolbox::StyleValue::setFinalValue ( const Set_pa  value,
ArgList &  argList 
) const [protected]

SetValueReturnCode_e tecplot::toolbox::StyleValue::setFinalValue ( const Set &  value,
ArgList &  argList 
) const [protected]

SetValueReturnCode_e tecplot::toolbox::StyleValue::setFinalValue ( const char *  value,
ArgList &  argList 
) const [protected]

SetValueReturnCode_e tecplot::toolbox::StyleValue::setFinalValue ( const std::string &  value,
ArgList &  argList 
) const [protected]

template<typename T>
SetValueReturnCode_e tecplot::toolbox::StyleValue::setValue ( const T &  value,
const StringList &  extraParams,
const Set *  objectSet,
LgIndex_t  offset1,
LgIndex_t  offset2,
AssignOp_e  assignOp 
) const [inline, protected]

virtual GetValueReturnCode_e tecplot::toolbox::StyleValue::styleGetLowLevel ( const ArgList &  argList  )  const [protected, virtual]

Get the value from Tecplot.

This method is the end of the road for the get methods.

Note:
You may wish to override this method with one asserts if the return code is not GetValue_Ok.
Parameters:
argList The complete argument list that is passed off to TecUtilStyleGetLowLevelX
Returns:
GetValue_Ok if the value was retieved from Tecplot. Otherwise an error code will be returned.

template<typename T>
GetValueReturnCode_e tecplot::toolbox::StyleValue::getFinalValue ( T *  value,
ArgList &  argList 
) const [inline, protected]

GetValueReturnCode_e tecplot::toolbox::StyleValue::getFinalValue ( bool *  value,
ArgList &  argList 
) const [protected]

GetValueReturnCode_e tecplot::toolbox::StyleValue::getFinalValue ( double *  value,
ArgList &  argList 
) const [protected]

GetValueReturnCode_e tecplot::toolbox::StyleValue::getFinalValue ( std::string *  value,
ArgList &  argList 
) const [protected]

GetValueReturnCode_e tecplot::toolbox::StyleValue::getFinalValue ( char **  value,
ArgList &  argList 
) const [protected]

GetValueReturnCode_e tecplot::toolbox::StyleValue::getFinalValue ( Set *  value,
ArgList &  argList 
) const [protected]

GetValueReturnCode_e tecplot::toolbox::StyleValue::getFinalValue ( Set_pa *  value,
ArgList &  argList 
) const [protected]

template<typename T>
GetValueReturnCode_e tecplot::toolbox::StyleValue::getValue ( T *  value,
LgIndex_t  offset1,
LgIndex_t  offset2,
const StringList &  extraParams 
) const [inline, protected]

const char* tecplot::toolbox::StyleValue::getPValueString ( int  depth  )  const [protected]

void tecplot::toolbox::StyleValue::validateParamList ( StringList &  stringList  )  const [protected]

void tecplot::toolbox::StyleValue::setupPValueArgList ( const StringList &  parameters,
ArgList &  argList 
) const [protected]

void tecplot::toolbox::StyleValue::setupSetValueArgList ( const StringList &  parameters,
const Set *  objectSet,
LgIndex_t  offset1,
LgIndex_t  offset2,
AssignOp_e  assignOp,
ArgList &  argList 
) const [protected]

void tecplot::toolbox::StyleValue::setupGetValueArgList ( const StringList &  parameters,
LgIndex_t  offset1,
LgIndex_t  offset2,
ArgList &  argList 
) const [protected]

Generated on Wed Dec 19 02:19:11 2007 for Tecplot by  doxygen 1.5.2-20070506