Public Member Functions | List of all members
FilterDefinition Class Reference

FilterDefinition class is used to specify result filters.
The class can be called from Study class.
. More...

Public Member Functions

String GetCaseGroup ()
 Returns the case group of the filter definition. More...
 
String GetCaseRange ()
 Returns the cases of the filter definition. More...
 
String GetConditions ()
 Returns the conditions of the filter definition. More...
 
int GetFilterType ()
 Returns the filter type. More...
 
String GetName ()
 Returns the title of the filter definition. More...
 
String GetSpecifiedFilters ()
 Returns the specified filters of the filter definition. More...
 
bool IsValid ()
 Returns True if the object is valid. More...
 
void SetCaseGroup (String &caseGroup)
 Specifies the case group of the filter definition. More...
 
void SetCaseRange (String &caseNo)
 Specifies the case number of the filter definition. More...
 
void SetConditions (String &conditions)
 Specifies the conditions of the filter definition. More...
 
void SetFilterType (Variant &filterType)
 Specifies the type of the filter definition. More...
 
void SetName (String &title)
 Specifies the title of the filter definition. More...
 
void SetSpecifiedFilters (String &filters)
 Specifies the filters of the filter definition. More...
 

Detailed Description

FilterDefinition class is used to specify result filters.
The class can be called from Study class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetFilterDefinition(0)

Member Function Documentation

String FilterDefinition::GetCaseGroup ( )

Returns the case group of the filter definition.

Returns
Case group
String FilterDefinition::GetCaseRange ( )

Returns the cases of the filter definition.

Returns
Case number
String FilterDefinition::GetConditions ( )

Returns the conditions of the filter definition.

Returns
Conditions
int FilterDefinition::GetFilterType ( )

Returns the filter type.

Returns
Filter type
String FilterDefinition::GetName ( )

Returns the title of the filter definition.

Returns
Title
String FilterDefinition::GetSpecifiedFilters ( )

Returns the specified filters of the filter definition.

Returns
Specified filters
bool FilterDefinition::IsValid ( )

Returns True if the object is valid.

Returns
Whether or not the FilterDefinition object is valid
void FilterDefinition::SetCaseGroup ( String &  caseGroup)

Specifies the case group of the filter definition.

Parameters
caseGroupCase group
void FilterDefinition::SetCaseRange ( String &  caseRange)

Specifies the case number of the filter definition.

Parameters
caseRangeCase number
void FilterDefinition::SetConditions ( String &  conditions)

Specifies the conditions of the filter definition.

Parameters
conditionsConditions
void FilterDefinition::SetFilterType ( Variant &  filterType)

Specifies the type of the filter definition.

Parameters
filterTypeFilter type
void FilterDefinition::SetName ( String &  title)

Specifies the title of the filter definition.

Parameters
titleFilter title
void FilterDefinition::SetSpecifiedFilters ( String &  filters)

Specifies the filters of the filter definition.

Parameters
filtersSpecified filters