Pointwise Plugin SDK
Macros
+ Collaboration diagram for Published Variable Attribute Groups:

Macros

#define PWU_GROUP_JOIN(j1, j2)   j1 "." j2
 
#define PWU_GROUP_VALUE_DEFNS(grp)   PWU_GROUP_JOIN(grp, PWU_PUBLISH_DEFNS_STR)
 
#define PWU_GROUP_VALUE_NAMES(grp)   PWU_GROUP_JOIN(grp, PWU_PUBLISH_NAMES_STR)
 
#define PWU_PUBLISH_DEFNS_STR   "PublishedVar.Definitions"
 
#define PWU_PUBLISH_NAMES_STR   "PublishedVar.Names"
 
#define PWU_VALUE_DEFN_ACCESS_STR   "access"
 
#define PWU_VALUE_DEFN_DEFAULT_STR   "default"
 
#define PWU_VALUE_DEFN_DESC_STR   "description"
 
#define PWU_VALUE_DEFN_NAME_STR   "name"
 
#define PWU_VALUE_DEFN_RANGE_STR   "range"
 
#define PWU_VALUE_DEFN_TYPE_STR   "type"
 

Detailed Description

Plugin published variables are stored using these attribute groups.

The value definition hieracrchy:
<group>.<PWU_PUBLISH_NAMES_STR> = valName[|valName...]
<PWU_PUBLISH_DEFNS_STR>.<valName>.type = one of: String, Int, Uint, Float, Real
<PWU_PUBLISH_DEFNS_STR>.<valName>.access = combo of: R, W, D
<PWU_PUBLISH_DEFNS_STR>.<valName>.description = free form text
<PWU_PUBLISH_DEFNS_STR>.<valName>.default = type-specific value
<PWU_PUBLISH_DEFNS_STR>.<valName>.range = type-specific range specification

Macro Definition Documentation

◆ PWU_GROUP_JOIN

#define PWU_GROUP_JOIN (   j1,
  j2 
)    j1 "." j2

Definition at line 1085 of file apiPWP.h.

◆ PWU_GROUP_VALUE_DEFNS

#define PWU_GROUP_VALUE_DEFNS (   grp)    PWU_GROUP_JOIN(grp, PWU_PUBLISH_DEFNS_STR)

Definition at line 1087 of file apiPWP.h.

◆ PWU_GROUP_VALUE_NAMES

#define PWU_GROUP_VALUE_NAMES (   grp)    PWU_GROUP_JOIN(grp, PWU_PUBLISH_NAMES_STR)

Definition at line 1086 of file apiPWP.h.

◆ PWU_PUBLISH_DEFNS_STR

#define PWU_PUBLISH_DEFNS_STR   "PublishedVar.Definitions"

Definition at line 1076 of file apiPWP.h.

Referenced by PwuValueDefnsGroup().

◆ PWU_PUBLISH_NAMES_STR

#define PWU_PUBLISH_NAMES_STR   "PublishedVar.Names"

Definition at line 1075 of file apiPWP.h.

Referenced by PwuValueNamesGroup().

◆ PWU_VALUE_DEFN_ACCESS_STR

#define PWU_VALUE_DEFN_ACCESS_STR   "access"

Definition at line 1080 of file apiPWP.h.

Referenced by PwuValueDefnAccessKey().

◆ PWU_VALUE_DEFN_DEFAULT_STR

#define PWU_VALUE_DEFN_DEFAULT_STR   "default"

Definition at line 1082 of file apiPWP.h.

Referenced by PwuValueDefnDefaultKey().

◆ PWU_VALUE_DEFN_DESC_STR

#define PWU_VALUE_DEFN_DESC_STR   "description"

Definition at line 1081 of file apiPWP.h.

Referenced by PwuValueDefnDescKey().

◆ PWU_VALUE_DEFN_NAME_STR

#define PWU_VALUE_DEFN_NAME_STR   "name"

Definition at line 1078 of file apiPWP.h.

Referenced by PwuValueDefnNameKey().

◆ PWU_VALUE_DEFN_RANGE_STR

#define PWU_VALUE_DEFN_RANGE_STR   "range"

Definition at line 1083 of file apiPWP.h.

Referenced by PwuValueDefnRangeKey().

◆ PWU_VALUE_DEFN_TYPE_STR

#define PWU_VALUE_DEFN_TYPE_STR   "type"

Definition at line 1079 of file apiPWP.h.

Referenced by PwuValueDefnTypeKey().