Public Member Functions | List of all members
ParametricGraphDefinition Class Reference

ParametricGraphDefinition class is used to create a response graph.
The class can be called from Study class.
. More...

Public Member Functions

void AddConstraintFilter (String &itemName)
 Adds a filter from the parameter/constraint condition name. More...
 
void AddItemFilter (String &itemName, Variant &value)
 Adds a filter to an item. More...
 
DataSetCreateParametricGraph ()
 Creates a response graph.
 
Variant GetParameter (String &key)
 Returns the value of a specified parameter. More...
 
bool IsValid ()
 Returns True if an object is valid. More...
 
void SetCustomFilter (String &filters)
 Specifies a list of custom filters. If it is empty, there is no specification. More...
 
void SetGroupFilter (String &groups)
 Specifies the list of case groups. An empty list uses all cases. More...
 
void SetParameter (String &key, Variant &value)
 Specifies a parameter value. More...
 

Detailed Description

ParametricGraphDefinition class is used to create a response graph.
The class can be called from Study class.
.

Example of calling the class object:

app.GetCurrentStudy().CreateParametricGraphDefinition()

The property name and flag described in Properties for the Response Graph Display are used to specify the properties.

Member Function Documentation

void ParametricGraphDefinition::AddConstraintFilter ( String &  itemName)

Adds a filter from the parameter/constraint condition name.

Parameters
itemNameParameter/Constraint conditionname
void ParametricGraphDefinition::AddItemFilter ( String &  itemName,
Variant &  value 
)

Adds a filter to an item.

Parameters
itemNameParameter/Constraint name
valueValue of parameter
Variant ParametricGraphDefinition::GetParameter ( String &  key)

Returns the value of a specified parameter.

Parameters
keyParameter name
Returns
The parameter value
bool ParametricGraphDefinition::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the ParametricGraphDefinition objects in the list are valid
void ParametricGraphDefinition::SetCustomFilter ( String &  filters)

Specifies a list of custom filters. If it is empty, there is no specification.

Parameters
filtersComma separated list of custom filters
void ParametricGraphDefinition::SetGroupFilter ( String &  groups)

Specifies the list of case groups. An empty list uses all cases.

Parameters
groupsComma separated list of case groups
void ParametricGraphDefinition::SetParameter ( String &  key,
Variant &  value 
)

Specifies a parameter value.

Parameters
keyParameter name
valueParameter value