tecplot::toolbox::StyleValue Class Reference

#include <StyleValue.h>

Detailed Description

An object referring to a node in the Tecplot style hierarchy, which can be used to retrieve and modify style settings.

The Tecplot style hierarchy is a collection of settings that define the behavior of the Tecplot Engine and the appearance of plots. Some of the style values are global state; others are specific to a page, a frame, or a plot type. Only leaf nodes in the hierarchy contain actual settings. Non-leaf nodes are used to group related settings.

Nodes in the style hierarchy are named. To indicate a specific value, you name all the nodes from the root to the leaf that contains the value. For example, to set the color of the gridlines for the Y axis in a 3D plot, you specify THREEDAXIS, then YDETAIL, then GRIDLINES, and finally COLOR.

The Style Hierarchy Reference is a browseable version of the Tecplot style hierarchy that can help you determine the path to a setting you need.

Note:
In your application, you specify names in the form of constants, not strings. The constants used to specify style node names all begin with SV, such as SV_THREEDAXIS.
The StyleValue class in the Tecplot Toolbox is a convenient and flexible way to work with the style hierarchy in your application. A StyleValue object can refer to any node in the hierarchy: the root, a specific leaf that stores a setting you want to access, or an intermediate node that refers to a family of related settings.

You specify the node to which you want a given StyleValue object to refer at its construction. For example, the code below creates five StyleValue objects that refer to various nodes in the path that leads to the Y-axis gridline color for a 3D plot (as seen earlier).

   // Declare root StyleValue with access to the entire style hierarchy
   StyleValue style1();

   // Declare StyleValue with access to the THREEDAXIS subtree
   StyleValue style2(SV_THREEDAXIS);

   // Declare StyleValue objects with access to smaller subtrees
   StyleValue style3(SV_THREEDAXIS, SV_YDETAIL);
   StyleValue style4(SV_THREEDAXIS, SV_YDETAIL, SV_GRIDLINES);

   // Declare StyleValue object to access a specific setting
   StyleValue style5(SV_THREEDAXIS, SV_YDETAIL, SV_GRIDLINES, SV_COLOR);

The StyleValue object's get() and set() methods may be used to specify the path to the desired setting and to retrieve or modify its value. The path specified when instantiating the object is combined with the path specified in the get() or set() call to obtain the full path of the desired setting. The examples below all get the same gridline color setting, specifying only the part of the path not already specified at instantiaton of a given StyleValue object.

   // Get the Y-axis gridline color using each of the above objects
   ColorIndex_t result;

   // Must specify full SV path when using style1 since it refers to the root
   style1.get(&result, SV_THREEDAXIS, SV_YDETAIL, SV_GRIDLINES, SV_COLOR);

   // Specify partial SV paths when using style2-style4
   style2.get(&result, SV_YDETAIL, SV_GRIDLINES, SV_COLOR);
   style3.get(&result, SV_GRIDLINES, SV_COLOR);
   style4.get(&result, SV_COLOR);

   // style5 already refers directly to the desired leaf
   style5.get(&result);

Some nodes in the style hierarchy contain values for a group of similar Tecplot objects. For example, the GLOBALCONTOUR subtree holds settings for each contour group in a frame, while the SLICEATTRIBUTES subtree holds settings for each slice group. When using styles in such subtrees, you must indicate a specific contour group, slice group, or other Tecplot object in the call to the set() or get() method. Only one index may be specified in each set() or get() call. To retrieve or apply such a setting for all of the Tecplot objects in a group, you must use multiple calls.

The FIELDMAP and LINEMAP subtrees allow you to specify a group of fieldmaps or linemaps when you set a value using a Set object. The value is set for all of the specified fieldmaps or linemaps. If you do not provide a Set object, the setting is applied to all fieldmaps or linemaps. Retrieving a value in these subtrees still requires that you specify a single fieldmap or linemap using an index.

For page- or frame-specific settings, the get() and set() methods normally operate on the page or frame that is current when the method is invoked. You can create a StyleValue object that always operates on a particular page or frame by providing the unique ID of that page or frame to an alternate SetValue constructor. In the Style Hierarchy Reference, settings that allow a unique page or frame ID to be provided to the constructor have been conveniently separated into FrameStyle and PageStyle categories.

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 instance that represents a node in the Tecplot style value hierarchy.
 StyleValue (UniqueID_t pageOrFrameUniqueID, 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)
 Alternate constructor for the StyleValue class creates an object that refers to the styles of a specified page or frame.
 StyleValue (const StringList &paramList)
 Alternate constructor that uses a StringList rather than a series of SV constants to specify a style node.
 StyleValue (UniqueID_t pageOrFrameUniqueID, const StringList &paramList)
 Alternate constructor that uses a StringList and refers to the styles of a specified page or frame.
 StyleValue (const StyleValue &other)
virtual ~StyleValue ()
const StringList & getParamList () const
 Returns the stringlist 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 Tecplot style value.
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 Tecplot style value for a setting in a group.
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 Tecplot style value, optionally modifying the original value or converting units.
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 Tecplot style value in a group, optionally modifying the original value or converting units.
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 Tecplot style value in a group.
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 Tecplot style value in a group, optionally modifying the original value or converting units.
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 Tecplot style value for a set, such as for a set of fieldmaps or linemaps.
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 Tecplot style value for a set, such as for a set of fieldmaps or linemaps.
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 Tecplot style value.
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 Tecplot style value in a group.
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 Tecplot style value in a group.

Static Public Member Functions

static bool returnCodeOk (SetValueReturnCode_e SVRC)
 Checks a set() return code for an error condition.
static bool returnCodeOk (GetValueReturnCode_e GVRC)
 Check a get() return code for an error condition.

Protected Member Functions

virtual SetValueReturnCode_e styleSetLowLevel (const ArgList &argList) const
 Set a Tecplot style value.
template<typename T>
SetValueReturnCode_e setFinalValue (T value, ArgList &argList) const
SetValueReturnCode_e setFinalValue (bool 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
 Gets a Tecplot style value.
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

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 instance that represents a node in the Tecplot style value hierarchy.

The instance may then be used to retrieve or modify style values for the current page and frame using the get() and set() methods.

Parameters:
P1 P1 through P7 are SV constants that represent a path through the Tecplot style hierarchy, as explained in the detailed description above. You may provide zero or more SV constants to the constructor. The instance will then refer to that point in the style hierarchy, and you need only specify the path from there when calling the set() and get() methods.
P2 See P1.
P3 See P1.
P4 See P1.
P5 See P1.
P6 See P1.
P7 See P1.

tecplot::toolbox::StyleValue::StyleValue ( UniqueID_t  pageOrFrameUniqueID,
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 
)

Alternate constructor for the StyleValue class creates an object that refers to the styles of a specified page or frame.

Parameters:
pageOrFrameUniqueID Unique ID of the target page or frame.
P1 P1 through P7 are SV constants that represent a path through the Tecplot style hierarchy, as explained in the detailed description above. You may provide zero or more SV constants to the constructor. The instance will then refer to that point in the style hierarchy, and you need only specify the path from there when calling the set() and get() methods.
P2 See P1.
P3 See P1.
P4 See P1.
P5 See P1.
P6 See P1.
P7 See P1.

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

Alternate constructor that uses a StringList rather than a series of SV constants to specify a style node.

Parameters:
paramList A StringList containing zero or more style node names. (Do not use the SV prefix.)

tecplot::toolbox::StyleValue::StyleValue ( UniqueID_t  pageOrFrameUniqueID,
const StringList &  paramList 
)

Alternate constructor that uses a StringList and refers to the styles of a specified page or frame.

Parameters:
pageOrFrameUniqueID Unique ID of the target page or frame.
paramList A StringList containing zero or more style node names. (Do not use the SV prefix.)

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

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

Member Function Documentation

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

Returns the stringlist used during the construction of the object.

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

Checks a set() return code for an error condition.

Parameters:
SVRC A return code from a call to a StyleValue::set() method.
Returns:
true if SVRC is SetValue_Ok or SetValue_DuplicateValue, or false otherwise.

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

Check a get() return code for an error condition.

Parameters:
GVRC A return code from a call to a StyleValue::get() method.
Returns:
true if GVRC is GetValue_Ok, or 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 Tecplot style value.

Note:
The Tecplot Engine must be locked when using this method.
Parameters:
value The value to which the specified style node will be set. Supported types for this parameter include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
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 provided. Other values indicate 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);

References STYLEVALUE_NO_ASSIGNOP, and STYLEVALUE_NO_OFFSET.

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 Tecplot style value for a setting in a group.

Note:
The Tecplot Engine must be locked when using this method.
Parameters:
value The value to which the specified style node will be set. Supported types for this parameter include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
offset1 An offset or index used to specify which object or group the setting should be applied to.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
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 provided. Other values indicate 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);

References STYLEVALUE_NO_ASSIGNOP, and STYLEVALUE_NO_OFFSET.

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 Tecplot style value, optionally modifying the original value or converting units.

Note:
The Tecplot Engine must be locked when using this method.
Parameters:
value The value which will be used to modify the specified style setting. Supported types for this parameter include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
assignOp The assignment operator for changing the specified style node. May be set to replace the original setting (AssignOp_Equals), to perform a simple calculation on the original value, or to convert the specified value from various units. When the value is a set, AssignOp_MinusEquals and AssignOp_PlusEquals can be used to add or remove items from the set.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
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 provided. Other values indicate 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);

References STYLEVALUE_NO_OFFSET.

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 Tecplot style value in a group, optionally modifying the original value or converting units.

Note:
The Tecplot Engine must be locked when using this method.
Parameters:
value The value which will be used to modify the specified style setting. Supported types for this parameter include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
offset1 An offset or index used to specify which object or group the setting should be applied to.
assignOp The assignment operator for changing the specified style node. May be set to replace the original setting (AssignOp_Equals), to perform a simple calculation on the original value, or to convert the specified value from various units. When the value is a set, AssignOp_MinusEquals and AssignOp_PlusEquals can be used to add or remove items from the set.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
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 provided. Other values indicate various errors.

References STYLEVALUE_NO_OFFSET.

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 Tecplot style value in a group.

Note:
The Tecplot Engine must be locked when using this method.
Parameters:
value The value to which the specified style node will be set. Supported types for this parameter include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
offset1 An offset or index used to specify which object or group the setting should be applied to.
offset2 A second offset or index used to specify a subgroup. Currently, only SV_COLORMAPOVERRIDE requires a second offset.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
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 provided. Other values indicate various errors.

References STYLEVALUE_NO_ASSIGNOP.

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 Tecplot style value in a group, optionally modifying the original value or converting units.

Note:
The Tecplot Engine must be locked when using this method.
Parameters:
value The value which will be used to modify the specified style setting. Supported types for this parameter include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
offset1 An offset or index used to specify which object or group the setting should be applied to.
offset2 A second offset or index used to specify a subgroup. Currently, only SV_COLORMAPOVERRIDE requires a second offset.
assignOp The assignment operator for changing the specified style node. May be set to replace the original setting (AssignOp_Equals), to perform a simple calculation on the original value, or to convert the specified value from various units. When the value is a set, AssignOp_MinusEquals and AssignOp_PlusEquals can be used to add or remove items from the set.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
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 provided. Other values indicate 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 Tecplot style value for a set, such as for a set of fieldmaps or linemaps.

Note:
The Tecplot Engine must be locked when using this method.
Parameters:
value The value to which the specified style node will be set. Supported types for this parameter include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
objectSet A Set that specifies the items to operate on. This is typically used with SV_FIELDMAP and SV_LINEMAP styles.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
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 provided. Other values indicate various errors.
   // Set the mesh color to Red and the line thickness to 1.2
   // for field maps 1 through 5
   Set fieldMaps;
   fieldMaps.assign("[1-5]");

   StyleValue fieldMapMesh(SV_FIELDMAP, SV_MESH);
   fieldMapMesh.set(Red_C, fieldMaps, SV_COLOR);
   fieldMapMesh.set(1.2, fieldMaps, SV_LINETHICKNESS);

References STYLEVALUE_NO_ASSIGNOP, and STYLEVALUE_NO_OFFSET.

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 Tecplot style value for a set, such as for a set of fieldmaps or linemaps.

Note:
The Tecplot Engine must be locked when using this method.
Parameters:
value The value which will be used to modify the specified style setting. Supported types for this parameter include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
objectSet A Set that specifies the items to operate on. This is typically used with SV_FIELDMAP and SV_LINEMAP styles.
assignOp The assignment operator for changing the specified style node. May be set to replace the original setting (AssignOp_Equals), to perform a simple calculation on the original value, or to convert the specified value from various units. When the value is a set, AssignOp_MinusEquals and AssignOp_PlusEquals can be used to add or remove items from the set.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
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 provided. Other values indicate various errors.
   // Set mesh line thickness to half its current width for fieldmaps 1 through 5
   Set fieldMaps;
   fieldMaps.assign("[1-5]");
   StyleValue fieldMapMesh(SV_FIELDMAP, SV_MESH);
   fieldMapMesh.set(2, fieldMaps, AssignOp_DivideEquals, SV_LINETHICKNESS);

References STYLEVALUE_NO_OFFSET.

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 Tecplot style value.

Parameters:
value A pointer or reference to the variable that will receive the retrieved style setting. Supported types for this variable include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
aP2 See aP1.
aP3 See aP1.
aP4 See aP1.
aP5 See aP1.
aP6 See aP1.
aP7 See aP1.
Returns:
GetValue_Ok: the value was retrieved successfully. GetValue_ResultTypeError: the variable provided to receive the value was of the wrong type.
   // 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
     }

References STYLEVALUE_NO_OFFSET.

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 Tecplot style value in a group.

Parameters:
value A pointer or reference to the variable that will receive the retrieved style setting. Supported types for this variable include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
offset1 An offset or index used to specify which object or group the setting should be applied to.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
aP2 See aP1.
aP3 See aP1.
aP4 See aP1.
aP5 See aP1.
aP6 See aP1.
aP7 See aP1.
Returns:
GetValue_Ok: the value was retrieved successfully. GetValue_ResultTypeError: the variable provided to receive the value was of the wrong type. Other values indicate various errors.
   // 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
     }

References STYLEVALUE_NO_OFFSET.

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 Tecplot style value in a group.

Parameters:
value A pointer or reference to the variable that will receive the retrieved style setting. Supported types for this variable include, but are not limited to, LgIndex_t, EntIndex_t, double, char*, Set Commands, ArbParam_t, ColorIndex_t, and various enumerated types.
offset1 An offset or index used to specify which object or group the setting should be applied to.
offset2 A second offset or index used to specify a subgroup. Currently, only SV_COLORMAPOVERRIDE requires a second offset.
aP1 Parameters aP1 through aP7 specify a full or partial path to the desired node in the style hierarchy using SV constants. This path is appended to the path (if any) passed to the constructor at instantiation to obtain the full path to the desired style node.
aP2 See aP1.
aP3 See aP1.
aP4 See aP1.
aP5 See aP1.
aP6 See aP1.
aP7 See aP1.
Returns:
GetValue_Ok: the value was retrieved successfully. GetValue_ResultTypeError: the variable provided to receive the value was of the wrong type. Other values indicate various errors.

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

Set a Tecplot style value.

This is the most low-level method for setting styles with the StyleValue class.

Note:
The Tecplot Engine must be locked when using this method. You may wish to override this method with one that handles locking for you and optionally asserts if the SetValueReturnCode is not SetValue_Ok or SetValue_DuplicateValue.
Parameters:
argList The complete argument list that is passed to TecUtilStyleSetLowLevelX().
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 provided. Other values indicate various errors.

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

References tecplot::toolbox::ArgList::appendArbParam(), and tecplot::toolbox::ArgList::appendDouble().

SetValueReturnCode_e tecplot::toolbox::StyleValue::setFinalValue ( bool  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]

References tecplot::toolbox::StringList::append(), IMPLICATION, tecplot::toolbox::StringList::size(), STYLEVALUE_NO_ASSIGNOP, and STYLEVALUE_NO_OFFSET.

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

Gets a Tecplot style value.

This is the most low-level method for setting styles with the StyleValue object.

Note:
You may wish to override this method with one that asserts if the returned value is not GetValue_Ok.
Parameters:
argList The complete argument list that is passed to TecUtilStyleGetLowLevelX().
Returns:
GetValue_Ok: the value was retrieved successfully. GetValue_ResultTypeError: the variable provided to receive the value was of the wrong type. Other values indicate various errors.

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

References tecplot::toolbox::ArgList::appendArbParamPtr().

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]

References tecplot::toolbox::StringList::size(), and STYLEVALUE_NO_OFFSET.

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 Tue Mar 12 02:24:48 2013 for Tecplot by  doxygen 1.5.5