res_tmpl_create_over | ( tmpl_id, overwrite_tmpl, name, tool_type, desc, num_attributes, va_attributes , num_options, va_options, num_misc, va_misc, pclexp, title ) |
Description: | ||
This function creates a result template and states it in the database. | ||
Input: | ||
LOGICAL | overwrite_tmpl | If TRUE, causes existing template with the same name and tool type to be overwritten. |
STRING | name[max 31] | Template name. |
STRING | tool_type[] | Template tool type. |
STRING | desc[VIRTUAL] | Template description. |
INTEGER | num_attributes | Number of strings in va_attributes. |
STRING | va_attributes[113] (num_attributes) | Template attribute values. Each string consists of up to 32 characters of a key value, followed by : and then the value of up to 80 characters associated with that key. |
INTEGER | num_options | Number of strings in va_options. |
STRING | va_options[113] (num_options) | Template option values. Each string consists of up to 32 characters of a key value, followed by : and then the value of up to 80 characters associated with that key. |
INTEGER | num_misc | Number of strings in va_misc. |
STRING | va_misc[113](num_misc) | Template miscellaneous values. Each string consists of up to 32 characters of a key value, followed by : and then the value of up to 80 characters associated with that key. |
STRING | pclexp[VIRTUAL] | Template Pcl expression. Although a virtual string here, other parts of the code may limit it to no more than 200 characters. |
STRING | title[VIRTUAL] | Template title. Although a virtual string here, other parts of the code may limit it to no more than 159 characters. |
Output: | ||
INTEGER | tmpl_id | Internal database id of the newly created template. |
INTEGER | <Return Value> | Zero for success, else error message code. |
Error Conditions: | ||
MSG_RES_RDM_TMPL_INVALID_TYPE MSG_RES_RDM_INVALID_TOOL_TYPE MSG_RES_RDM_TOOL_DOES_NOT_EXIST MSG_RES_RDM_TMPL_NO_NAME MSG_RES_RDM_TOOL_ALREADY_EXISTS | ||
DbInvalidMemoryDbPageOffset DbInvalidMemoryDbPageId Other db errors DbVirtualMemoryExhausted Other db exceptions |
"LegendDisplay:value" , | where value is one of ON or OFF. |
"LegendSetting:value" , | where value is one of 0 or 1. |
"DeformedStyle:color,style,thickness,render" , | where color is one of the 16 color names (see Colors Available) ; style is one of Solid , Dash , Dotted , or DotDash ; thickness is one of 1 through 10 ; and render is one of Wireframe , FreeEdge , HiddenLine , or Shaded. |
"DeformedScale:value" , | where value is True=real_val or Model=real_val. |
"UndeformedStyle:onoff,color,style,thickness,render" , | where onoff is one of ON or OFF ; color is one of the 16 color names (see Colors Available) , style is one of Solid , Dash , Dotted , or DotDash ; thickness is one of 1 through 10 ; and render is one of Wireframe , FreeEdge , HiddenLine , or Shaded. |
"TitleDisplay:value" , | where value is one of ON or OFF. |
"MinMaxDisplay:value" , | where value is one of ON or OFF. |
"LabelStyle:form,font,color,digits" , | where form is one of Exponential , Fixed or Integer ; font is 12 ; color is one of the 16 color names (see Colors Available ) ; and digits is one of 0 through 13. |
"SpectrumDisplay:value" , | where value is one of ON or OFF. |
"LegendDisplay:value" , | where value is one of ON or OFF. |
"LegendSetting:value" , | where value is one of 0 or 1. |
"Range:value | where value is name of a range. |
"RangeOverwrite:value" , | where value is one of ON or OFF. |
"RangePost:value" , | where value is one of ON or OFF. |
"FringeStyle:value | where value is one of ElemFill , Discrete/Flat , Discrete/Smooth , or Continuous. |
"Shade:value | where value is one of None , or Shade. |
"ElemEdge:edge,color,style,thickness" , | where edge is one of None , FreeEdge , or ElemEdge ; color is one of the 16 color names (see ) , style is one of Solid , Dash , Dotted , or DotDash ; thickness is one of 1 through 10 |
"Shrink:value , | where value is percentage as an integer. |
"TitleDisplay:value" , | where value is one of ON or OFF. |
"MinMaxDisplay:value" , | where value is one of ON or OFF. |
"ValueDisplay:value" , | where value is one of ON or OFF. |
"LabelStyle:form,font,color,digits" , | where form is one of Exponential , Fixed or Integer ; font is 12 ; color is one of the 16 color names (see Colors Available ) ; and digits is one of 0 through 13. |
"ShowOnDeformed:value" , | where value is one of ON or OFF. |
"curveFitMethod:value" , | where value is one of Linear , Scatter , Spline , LeastSquares. |
"curveStyle:value" , | where value is one of Solid , LongDash , ShortDash , OddDash , Dotted , or DotDash. |
"symbolDisplay:value" , | where value is one of ON or OFF. |
"xAxisLabelDisplay:value" , | where value is one of ON or OFF. |
"xAxisLabel:value" , | where value is the axis label. |
"xAxisScale:value" , | where value is one of Linear or Log. |
"xAxisLabelFormat:form,font,color,digits" , | where form is one of Exponential , Fixed or Integer ; font is 12 ; color is one of the 16 color names (see Colors Available ) ; and digits is one of 0 through 13. |
"yAxisLabelDisplay:value" , | where value is one of ON or OFF |
"yAxisLabel:value" , | where value is the axis label |
"yAxisScale:value" , | where value is one of Linear or Log |
"yAxisLabelFormat:form,font,color,digits" , | where form is one of Exponential , Fixed or Integer ; font is 12 ; color is one of the 16 color names (see Colors Available ) ; and digits is one of 0 through 13. |
"sortPtsByXCoord:value" , | where value is one of ON or OFF |
"WindowName:value" , | where value is the window name. |
"AppendToWindow:value" , | where value is one of ON or OFF |
"ReportType:value" , | where value is one of Full , Summary , or DataOnly. |
"ReportTitle:value" , | where value is the title string. Note that reports can have several ReportTitle:value attributes. |
"ReportHeader:value" , | where value is the header string. |
"ReportFooter:value" , | where value is the footer string. |
"ReportPage:value" , | where value is Height=val,Width=val,TopMargin=val,LeftMargin=val,BottomMargin=val , where val is an integer and represents the number of lines for height or charaters for Width. |
"ReportPagination:value" , | where value is one of ON or OFF. |
"ReportPageNumber:value" , | where value is beginning page number. |
"ReportPageAlignment:value" , | where value is one of Center , Left , or Right. |
"EntitySort:value" , | where value is one of LoadCase or Entity. |
"ValueSort:column,direction,method" , | where column is 0 ; direction is one of Ascending or Descending ; and method is one of Algebraic or Absolute. |
"ColumnHeaders:value" | where value is one of ON or OFF. |
"SpectrumDisplay:value" , | where value is one of ON or OFF. |
"LegendDisplay:value" , | where value is one of ON or OFF. |
"LegendSetting:value" , | where value is one of 0 or 1. |
"Range:value | where value is name of a range. |
"RangeOverwrite:value" , | where value is one of ON or OFF. |
"RangePost:value" , | where value is one of ON or OFF. |
"ColoringMethod:value" , | where value is one of Constant or Spectrum. |
"TensorColors:color,color,color,color,color,color" , | where color is one of the 16 color names (see Colors Available ) or Spectrum. |
"PrincipalColors:color,color,color" , | where color is one of the 16 color names (see Colors Available ) or Spectrum. |
"VectorScale:value" , | where value is one of ScreenConstant=real_val , ScreenScaled=real_val , ModelConstant=real_val , or ModelScaled=real_val |
"HeadStyle:value" , | where value is one of None or Single. |
"VectorStyle:value" , | where value is one of Solid , or Cylinder. |
"BoxStyle:value," , | where value is one of ON or OFF ; and style is one of wireframe or filled. |
"BoxColor:value" , | where value is one of the 16 color names (see Colors Available ). |
"BoxScale:value" , | where value is one of ScreenConstant=real_val , ScreenScaled=real_val , ModelConstant=real_val , or ModelScaled=real_val |
"TitleDisplay:value" , | where value is one of ON or OFF. |
"MinMaxDisplay:value" , | where value is one of ON or OFF. |
"ValueDisplay:value" , | where value is one of ON or OFF. |
"LabelStyle:form,font,color,digits" , | where form is one of Exponential , Fixed or Integer ; font is 12 ; color is one of the 16 color names (see ) ; and digits is one of 0 through 13. |
"ShowOnDeformed:value" , | where value is one of ON or OFF. |
"SpectrumDisplay:value" , | where value is one of ON or OFF. |
"LegendDisplay:value" , | where value is one of ON or OFF. |
"LegendSetting:value" , | where value is one of 0 or 1. |
"Range:value | where value is name of a range. |
"RangeOverwrite:value" , | where value is one of ON or OFF. |
"RangePost:value" , | where value is one of ON or OFF. |
"ColoringMethod:value" , | where value is one of Constant or Spectrum. |
"VectorColors:color,color,color,color" , | where color is one of the 16 color names (see Colors Available ) or Spectrum. |
"VectorScale:value" , | where value is one of ScreenConstant=real_val , ScreenScaled=real_val , ModelConstant=real_val , or ModelScaled=real_val |
"VectorAttachment:value" , | where value is one of Head , Tail , or Middle. |
"HeadStyle:value" , | where value is one of None , Single, or Double |
"VectorStyle:value" , | where value is one of Solid , or Cylinder. |
"TailDisplay:value" , | where value is ON. |
"TitleDisplay:value" , | where value is one of ON or OFF. |
"MinMaxDisplay:value" , | where value is one of ON or OFF. |
"ValueDisplay:value" , | where value is one of ON or OFF. |
"LabelStyle:form,font,color,digits" , | where form is one of Exponential , Fixed or Integer ; font is 12 ; color is one of the 16 color names (see Colors Available ) ; and digits is one of 0 through 13. |
"ShowOnDeformed:value" , | where value is one of ON or OFF. |
"CoordTrans:value" , | where value is one of AsIs , Coord id , ResCoord id , Global , Default , Material , IJK , or Nodal. Id is a database id of a coordinate system. Note that not all possible values are valid for all analysis codes and results data. |
"FilterData:value" , | where value is one of blank , None , Minumun=real_val , Maximun=real_val , Range=real_val , Exclude=real_val. |
"ScaleFactor:value" , | where value is a real number |
"AverageDomain:value" , | where value is one of blank , All , Material , Property , Etype , Target , or Element. |
"AverageMethod:value" , | where value is one of blank , DeriveAverage , AverageDerive , Difference , or Sum. |
"ExtrapolateMethod:value" , | where value is one of AsIs , ShapeFunc , Average , Centroid , Min , or Max. |
"SpreadFlag:value" , | where value is on of ON or OFF |
"ComplexForm:value" , | where value is one of Real , Imaginary , Magnitude , Phase , or Angle. |
"ComplexAngle:value" , | where value is a real number. |
"PclFlag:value" , | where value is on of ON or OFF. |
" Spectrum_Use_Current :"
"Spectrum_Use_Name:spectrum_name”
"Spectrum_Definition:spectrum_name,Overwrite=TRUE" ,
"Spectrum_Attributes:Continuous=FALSE,Interpolation Factor=2." , "Spectrum_LookUpTable:16,[0,1,8,9,3,5,14,15,10,11,2,12,4,13,6,7]"
" Palette_Use_Current :"
"Palette_Use_Name:palette_name” - uses the existing palette named,
"Palette_Definition:gray_scale,Overwrite=TRUE,NumColors=16,RGB_HLS=RGB" ,
"Palette_Colors:0,[0.,0.,0.]" ,
"Palette_Colors:1,[0.07,0.07,0.07]" ,
"Palette_Colors:2,[0.13,0.13,0.13]" ,
"Palette_Colors:3,[0.2,0.2,0.2]" ,
"Palette_Colors:4,[0.27000001,0.27000001,0.27000001]" ,
"Palette_Colors:5,[0.33000001,0.33000001,0.33000001]" ,
"Palette_Colors:6,[0.40000001,0.40000001,0.40000001]" ,
"Palette_Colors:7,[0.47,0.47,0.47]" ,
"Palette_Colors:8,[0.52999997,0.52999997,0.52999997]" ,
"Palette_Colors:9,[0.60000002,0.60000002,0.60000002]" ,
"Palette_Colors:10,[0.67000002,0.67000002,0.67000002]" ,
"Palette_Colors:11,[0.73000002,0.73000002,0.73000002]" ,
"Palette_Colors:12,[0.80000001,0.80000001,0.80000001]" ,
"Palette_Colors:13,[0.87,0.87,0.87]" ,
"Palette_Colors:14,[0.93000001,0.93000001,0.93000001]" ,
"Palette_Colors:15,[1.,1.,1.]"
" Range_Use_Current :"
"Range_Definition:my range,Overwrite=TRUE,NumSubrange=15" ,
"Range_SubRange:0,[8.4472103,4.,6.2236052]" ,
"Range_SubRange:1,[4.,3.8461537,3.9230769]" ,
"Range_SubRange:2,[3.8461537,3.6923075,3.7692306]" ,
"Range_SubRange:3,[3.6923075,3.5384612,3.6153843]" ,
"Range_SubRange:4,[3.5384612,3.3846149,3.4615381]" ,
"Range_SubRange:5,[3.3846149,3.2307687,3.3076918]" ,
"Range_SubRange:6,[3.2307687,3.0769224,3.1538455]" ,
"Range_SubRange:7,[3.0769224,2.9230762,2.9999993]" ,
"Range_SubRange:8,[2.9230762,2.7692299,2.846153]" ,
"Range_SubRange:9,[2.7692299,2.6153836,2.6923068]" ,
"Range_SubRange:10,[2.6153836,2.4615374,2.5384605]" ,
"Range_SubRange:11,[2.4615374,2.3076911,2.3846142]" ,
"Range_SubRange:12,[2.3076911,2.1538448,2.230768]" ,
"Range_SubRange:13,[2.1538448,2.,2.0769217]" ,
"Range_SubRange:14,[2.,1.42274,1.71137]" ]
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_deform_tmpl" , "Deformation" , @
"My default settings for deformation plots" , @
8 , [ @
"LegendDisplay:ON" , @
"LegendSetting:1" , @
"DeformedStyle:White,Solid,1,Wireframe" , @
"DeformedScale:Model=0.2" , @
"UndeformedStyle:ON,Blue,Solid,1,Wireframe" , @
"TitleDisplay:ON" , @
"MinMaxDisplay:ON" , @
"LabelStyle:Exponential, 12, White, 3" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:" , @
"ScaleFactor:1." , @
"AverageDomain:" , @
"AverageMethod:" , @
"ExtrapolateMethod:AsIs" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"BENDING, Static Subcase, Displacements, Translational, (NON-LAYERED)" )
Example - Fringe
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_fringe_tmpl " , "Fringe" , @
"My default settings for fringe plots" , @
15 , [ @
"SpectrumDisplay:ON" , @
"LegendDisplay:ON" , @
"LegendSetting:1" , @
"Range:Fri_fri_t" , @
"RangeOverwrite:ON" , @
"RangePost:ON" , @
"FringeStyle:Discrete/Smooth" , @
"Shade:None" , @
"ElemEdge:FreeEdge,Blue,Solid,1" , @
"Shrink:5" , @
"TitleDisplay:ON" , @
"MinMaxDisplay:ON" , @
"ValueDisplay:OFF" , @
"LabelStyle:Exponential, 12, White, 3" , @
"ShowOnDeformed:ON" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:None" , @
"ScaleFactor:1." , @
"AverageDomain:" , @
"AverageMethod:" , @
"ExtrapolateMethod:AsIs" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
36 , [ @
"Spectrum_Definition:std1,Overwrite=TRUE" , @
"Spectrum_Attributes:Continuous=FALSE,Interpolation Factor=2." , @
"Spectrum_LookUpTable:16,[0,1,8,9,3,5,14,15,10,11,2,12,4,13,6,7]" , @
"Palette_Definition:standard_colortable,Overwrite=TRUE,NumColors=16,RGB_HLS=RGB" , @
"Palette_Colors:0,[0.,0.,0.]" , @
"Palette_Colors:1,[1.,0.,0.]" , @
"Palette_Colors:2,[0.,1.,0.]" , @
"Palette_Colors:3,[1.,1.,0.]" , @
"Palette_Colors:4,[0.,0.,1.]" , @
"Palette_Colors:5,[1.,0.,1.]" , @
"Palette_Colors:6,[0.,1.,1.]" , @
"Palette_Colors:7,[1.,1.,1.]" , @
"Palette_Colors:8,[1.,0.47,0.]" , @
"Palette_Colors:9,[1.,0.80000001,0.]" , @
"Palette_Colors:10,[0.,0.5,0.]" , @
"Palette_Colors:11,[0.,0.75,0.]" , @
"Palette_Colors:12,[0.,0.,0.67000002]" , @
"Palette_Colors:13,[0.,0.60000002,1.]" , @
"Palette_Colors:14,[1.,0.40000001,1.]" , @
"Palette_Colors:15,[1.,0.75,1.]" , @
"Range_Definition:my range,Overwrite=TRUE,NumSubrange=15" , @
"Range_SubRange:0,[8.4472103,4.,6.2236052]" , @
"Range_SubRange:1,[4.,3.8461537,3.9230769]" , @
"Range_SubRange:2,[3.8461537,3.6923075,3.7692306]" , @
"Range_SubRange:3,[3.6923075,3.5384612,3.6153843]" , @
"Range_SubRange:4,[3.5384612,3.3846149,3.4615381]" , @
"Range_SubRange:5,[3.3846149,3.2307687,3.3076918]" , @
"Range_SubRange:6,[3.2307687,3.0769224,3.1538455]" , @
"Range_SubRange:7,[3.0769224,2.9230762,2.9999993]" , @
"Range_SubRange:8,[2.9230762,2.7692299,2.846153]" , @
"Range_SubRange:9,[2.7692299,2.6153836,2.6923068]" , @
"Range_SubRange:10,[2.6153836,2.4615374,2.5384605]" , @
"Range_SubRange:11,[2.4615374,2.3076911,2.3846142]" , @
"Range_SubRange:12,[2.3076911,2.1538448,2.230768]" , @
"Range_SubRange:13,[2.1538448,2.,2.0769217]" , @
"Range_SubRange:14,[2.,1.42274,1.71137]" ] , @
““, @
"BENDING, Static Subcase, Displacements, Translational - Magnitude, (NON-LAYERED)" )
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_graph_tmpl" , "Graph" , @
"My default settings for graphs" , @
14 , [ @
"curveFitMethod:Linear" , @
"curveStyle:LongDash" , @
"symbolDisplay:OFF" , @
"xAxisLabelDisplay:ON" , @
"xAxisLabel:Displacements, Translational" , @
"xAxisScale:Linear" , @
"xAxisLabelFormat:Exponential, 12, White, 3" , @
"yAxisLabelDisplay:ON" , @
"yAxisLabel:Strain Tensor," , @
"yAxisScale:Linear" , @
"yAxisLabelFormat:Exponential, 12, White, 3" , @
"sortPtsByXCoord:ON" , @
"WindowName:3" , @
"AppendToWindow:OFF" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:" , @
"ScaleFactor:1." , @
"AverageDomain:All" , @
"AverageMethod:DeriveAverage" , @
"ExtrapolateMethod:ShapeFunc" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"Strain Tensor, VONM" )
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_report_tmpl" , "Report" , @
"My default settings for reports" , @
14 , [ @
"ReportType:Full" , @
"ReportTitle:$PRODUCT - Analysis Code: $CODE_NAME " , @
"ReportTitle:Load Case: $LC_NAME, $SC_NAME " , @
"ReportTitle:Result $PRES_NAME, $SRES_NAME - Layer $LYR_NAME " , @
"ReportTitle:Entity: Element Tensor" , @
"ReportHeader:Page $PAGE" , @
"ReportFooter:$DATE" , @
"ReportPage:Height=52,Width=128,TopMargin=5,LeftMargin=8,BottomMargin=5" , @
"ReportPagination:OFF" , @
"ReportPageNumber:1" , @
"ReportPageAlignment:Center" , @
"EntitySort:LoadCase" , @
"ValueSort:0,Descending,Algebraic" , @
"ColumnHeaders:ON" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:None" , @
"ScaleFactor:0.5" , @
"AverageDomain:All" , @
"AverageMethod:DeriveAverage" , @
"ExtrapolateMethod:ShapeFunc" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"" )
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_tensor_tmpl" , "Tensor" , @
"My default settings for tensor marker plots" , @
20 , [ @
"SpectrumDisplay:ON" , @
"LegendDisplay:ON" , @
"LegendSetting:1" , @
"Range:Ten_ten_t" , @
"RangeOverwrite:ON" , @
"RangePost:ON" , @
"ColoringMethod:Constant" , @
"TensorColors:Blue,Green,Yellow,Red,Magenta,White" , @
"PrincipalColors:Blue,Green,Yellow" , @
"VectorScale:ScreenConstant=0.400000" , @
"HeadStyle:Single" , @
"VectorStyle:Solid" , @
"BoxStyle:ON,Wireframe" , @
"BoxColor:Yellow" , @
"BoxScale:ScreenConstant=0.100000" , @
"TitleDisplay:ON" , @
"MinMaxDisplay:ON" , @
"ValueDisplay:ON" , @
"LabelStyle:Exponential, 12, White, 3" , @
"ShowOnDeformed:ON" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:None" , @
"ScaleFactor:1." , @
"AverageDomain:All" , @
"AverageMethod:DeriveAverage" , @
"ExtrapolateMethod:ShapeFunc" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"BENDING, Static Subcase, Strain Tensor,, (NON-LAYERED)" )
INTEGER tmpl_id
res_tmpl_create_over( tmpl_id , TRUE , @
"default_vector_tmpl" , "Vector" , @
"My default settings for vector marker plots" , @
18 , [ @
"SpectrumDisplay:ON" , @
"LegendDisplay:ON" , @
"LegendSetting:1" , @
"Range:Vec_vec_t" , @
"RangeOverwrite:ON" , @
"RangePost:ON" , @
"ColoringMethod:Constant" , @
"VectorColors:Spectrum,Spectrum,Spectrum,Spectrum" , @
"VectorScale:ScreenConstant=0.300000" , @
"VectorAttachment:Head" , @
"HeadStyle:Single" , @
"VectorStyle:Solid" , @
"TailDisplay:ON" , @
"TitleDisplay:ON" , @
"MinMaxDisplay:ON" , @
"ValueDisplay:ON" , @
"LabelStyle:Exponential, 12, White, 3" , @
"ShowOnDeformed:ON" ] , @
10 , [ @
"CoordTrans:AsIs" , @
"FilterData:Exclude = -1e-36, 1e-36" , @
"ScaleFactor:1." , @
"AverageDomain:" , @
"AverageMethod:" , @
"ExtrapolateMethod:AsIs" , @
"SpreadFlag:OFF" , @
"ComplexForm:Real" , @
"ComplexAngle:0." , @
"PclFlag:OFF" ] , @
0 , [ "" ] , @
"" , @
"BENDING, Static Subcase, Displacements, Translational, (NON-LAYERED)" )
Black | Red | Green | Yellow |
Blue | Magenta | Cyan | white |
Orange | LtOrange | DkGreen | LtGreen |
DkBlue | LtBlue | DkMagenta | LtMagenta |
res_tmpl_modify | ( tmpl_id , name , tool_type , desc , num_attributes , va_attributes , num_options , va_options , num_misc , va_misc , pclexp , title ) |
Description: | ||
This function modifies an existing results template in the database and replaces its stored values with the input data values. | ||
Input: | ||
INTEGER | tmpl_id | Internal database id of the result template record to modify. |
STRING | name[max 31] | Modified name. |
STRING | tool_type[] | Modified tool type. |
STRING | desc[VIRTUAL] | Modified description. |
INTEGER | num_attributes | Number of strings in va_attributes. |
STRING | va_attributes[113](num_attributes) | |
Modified attribute values. Each string consists of up to 32 characters of a key value, followed by : and then the value of up to 80 characters associated with that key. | ||
INTEGER | num_options | Number of strings in va_options. |
STRING | va_options[113](num_options) | |
Modified option values. Each string consists of up to 32 characters of a key value, followed by : and then the value of up to 80 characters associated with that key. | ||
INTEGER | num_misc | Number of strings in va_misc. |
STRING | va_misc[113](num_misc) | |
Modified miscellaneous values. Each string consists of up to 32 characters of a key value, followed by : and then the value of up to 80 characters associated with that key. | ||
STRING | pclexp[VIRTUAL] | Modified Pcl expression. Although a virtual string here, other parts of the code may limit it to no more than 200 characters. |
STRING | title[VIRTUAL] | Modified title. Although a virtual string here, other parts of the code may limit it to no more than 159 characters. |
Output: | ||
INTEGER | <Return Value> | Zero for success, else error message code. |
Error Conditions: | ||
MSG_RES_RDM_TMPL_INVALID_TYPE MSG_RES_RDM_INVALID_TOOL_TYPE MSG_RES_RDM_TOOL_DOES_NOT_EXIST MSG_RES_RDM_TMPL_NO_NAME DbInvalidMemoryDbPageOffset DbInvalidMemoryDbPageId Other db errors DbVirtualMemoryExhausted Other db exceptions |
res_tmpl_delete | ( name , tool_type ) |
Description: | ||
This function deletes the specified results template and its data from the database. | ||
Input: | ||
STRING | name[max 31] | Name of existing template to be deleted. |
STRING | tool_type[] | The template type. |
Output: | ||
INTEGER | <Return Value> | Zero for success, else error message code. |
Error Conditions: | ||
MSG_RES_RDM_TMPL_INVALID_TYPE MSG_RES_RDM_INVALID_TOOL_TYPE MSG_RES_RDM_TOOL_DOES_NOT_EXIST |
res_tmpl_copy | ( new_id , new_name , existing_name , tool_type ) |
Description: | ||
This function creates a new results template in the database and copies the data from an existing results template in the database to the new one. | ||
Input: | ||
STRING | name[max 31] | Name for the new template. |
STRING | existing_name[max 31] | Name of existing template to be copied. |
STRING | tool_type[] | The template type. |
Output: | ||
INTEGER | new_id | Internal database id of the newly created template. |
INTEGER | <Return Value> | Zero for success, else error message code. |
Error Conditions: | ||
MSG_RES_RDM_TMPL_INVALID_TYPE MSG_RES_RDM_INVALID_TOOL_TYPE MSG_RES_RDM_TOOL_DOES_NOT_EXIST MSG_RES_RDM_TMPL_NO_NAME MSG_RES_RDM_TOOL_ALREADY_EXISTS DbInvalidMemoryDbPageOffset DbInvalidMemoryDbPageId Other db errors DbVirtualMemoryExhausted Other db exceptions |
res_tmpl_set_force_overwrite | ( val ) |
Description: | ||
This function sets or clears a logical value that controls whether existing results templates in the database are overwritten when importing a template via the res_tmpl_create_over command. | ||
Input: | ||
LOGICAL | val | TRUE forces overwriting. FALSE has no effect. |
Output: | ||
None | ||
Error Conditions: | ||
None |