C# Class PurplePen.QueryEvent

Show file Open project: petergolde/PurplePen

Public Methods

Method	Description
AllCoursesHaveLoads ( EventDB eventDB ) : bool
AllVariationsOfCourseControl ( EventDB eventDB, Id courseControlId ) : IEnumerable>
AnyCoursesHaveLoads ( EventDB eventDB ) : bool
AnyMultipartCourses ( EventDB eventDB ) : bool
CanAddVariation ( EventDB eventDB, CourseDesignator courseDesignator, Id courseControlId ) : bool
CompareControlIds ( EventDB eventDB, Id controlId1, Id controlId2 ) : int
ComputeFlaggedLegLength ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : float
ComputeLegLength ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : float
ComputeSpecialLength ( EventDB eventDB, Id specialId ) : float
ComputeStraightLineControlDistance ( EventDB eventDB, Id controlId1, Id controlId2 ) : float
ControlsUnusedInCourses ( EventDB eventDB ) : List>
CountCourseParts ( EventDB eventDB, CourseDesignator courseDesignator ) : int
CountCourseParts ( EventDB eventDB, Id courseId ) : int
CountCourses ( EventDB eventDB ) : int
CourseContainsSpecial ( EventDB eventDB, CourseDesignator courseDesignator, Id specialId ) : bool
CourseIsForked ( EventDB eventDB, CourseDesignator courseDesignator ) : bool
CourseList ( EventDB eventDB, IEnumerable courses ) : string
CourseUsesControl ( EventDB eventDB, CourseDesignator courseDesignator, Id controlId ) : bool
CoursesUsingControl ( EventDB eventDB, Id controlId ) : Id[]
CoursesUsingLeg ( EventDB eventDB, Id control1, Id control2 ) : Id[]
CreateOutputFileName ( EventDB eventDB, CourseDesignator courseDesignator, string filePrefix, string fileSuffix, string extension ) : string
DistanceBetweenPointsInMeters ( EventDB eventDB, PointF pt1, PointF pt2 ) : float
DoesCourseControlPrecede ( EventDB eventDB, CourseDesignator courseDesignator, Id courseControl1, Id courseControl2 ) : bool
EnumCourseControlIds ( EventDB eventDB, CourseDesignator courseDesignator ) : IEnumerable>
EnumLegs ( EventDB eventDB, CourseDesignator courseDesignator ) : IEnumerable
EnumerateCourseDesignators ( EventDB eventDB, Id courseIds, Dictionary variationChoicesPerCourse, bool enumeratePartsSeparately ) : IEnumerable
EnumerateCourseDesignators ( EventDB eventDB, Id courseIds, bool enumeratePartsSeparately ) : IEnumerable
FindClosestLeg ( EventDB eventDB, CourseDesignator courseDesignator, PointF pt ) : LegInfo
FindCode ( EventDB eventDB, string code ) : Id
FindControlInsertionPoint ( EventDB eventDB, CourseDesignator courseDesignator, Id &courseControl1, Id &courseControl2 ) : void
FindLeg ( EventDB eventDB, Id controlId1, Id controlId2 ) : Id
GetAllPunchPatterns ( EventDB eventDB ) : PunchPattern>.Dictionary
GetAllVariations ( EventDB eventDB, Id courseId ) : IEnumerable
GetAutoNumbering ( EventDB eventDB, int &firstCode, bool &disallowInvertibleCodes ) : void
GetControlGaps ( EventDB eventDB, Id controlId, float scale ) : PurplePen.CircleGap[]
GetControlLoad ( EventDB eventDB, Id controlId ) : int
GetCourseControlsInCourse ( EventDB eventDB, CourseDesignator courseDesignator, Id controlId ) : Id[]
GetCourseLoad ( EventDB eventDB, Id courseId ) : int
GetCoursePartBounds ( EventDB eventDB, CourseDesignator courseDesignator, Id &startCourseControlId, Id &endCourseControlId ) : bool
GetCourseSortOrder ( EventDB eventDB, Id courseId ) : int
GetCustomSymbolText ( EventDB eventDB, Dictionary &customSymbolText, bool>.Dictionary &customSymbolKey ) : void
GetDefaultDescKind ( EventDB eventDB, Id courseId ) : DescriptionKind
GetDescriptionColumns ( EventDB eventDB, Id specialId ) : int
GetDescriptionLanguage ( EventDB eventDB ) : string
GetDesignatorsFromVariationChoices ( EventDB eventDB, Id courseId, VariationChoices variationChoices ) : IEnumerable
GetEventTitle ( EventDB eventDB, string lineSep ) : string
GetForkStart ( EventDB eventDB, Id courseId, Id courseControlId ) : Id
GetLegFlagging ( EventDB eventDB, Id controlId1, Id controlId2 ) : FlaggingKind
GetLegFlagging ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : FlaggingKind
GetLegGaps ( EventDB eventDB, Id controlId1, Id controlId2 ) : LegGap[]
GetLegGaps ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : LegGap[]
GetLegLoad ( EventDB eventDB, Id control1, Id control2 ) : int
GetLegPath ( EventDB eventDB, Id controlId1, Id controlId2 ) : SymPath
GetLegPath ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : SymPath
GetPartOptions ( EventDB eventDB, CourseDesignator courseDesignator ) : PartOptions
GetPrintArea ( EventDB eventDB, CourseDesignator courseDesignator ) : PrintArea
GetPrintScale ( EventDB eventDB, Id courseId ) : float
GetSpecialDisplayedCourses ( EventDB eventDB, Id specialId ) : CourseDesignator[]
GetTextSpecialFonts ( EventDB eventDB ) : IEnumerable
GetVariantCodeMapping ( EventDB eventDB, CourseDesignator courseDesignator ) : char>.Dictionary
GetVariationString ( EventDB eventDB, Id courseId, VariationInfo variationPath ) : string
HasFinishControl ( EventDB eventDB, Id courseId ) : bool
HasPartSpecificPrintArea ( EventDB eventDB, CourseDesignator courseDesignator ) : bool
HasStartControl ( EventDB eventDB, Id courseId ) : bool
HasVariations ( EventDB eventDB, Id courseId ) : bool
IsCodeInUse ( EventDB eventDB, string code ) : bool
IsCourseControlInPart ( EventDB eventDB, CourseDesignator courseDesignator, Id courseControlId ) : bool
IsImageNameUsed ( EventDB eventDB, string imageName ) : bool
IsLegalControlCode ( string code, string &reason ) : bool
IsPreferredControlCode ( EventDB eventDB, string code, string &reason ) : bool
LastCourseControl ( EventDB eventDB, Id courseId, bool dontReturnFinish ) : Id
NextUnusedControlCode ( EventDB eventDB ) : string
ShouldWarnAboutMovingControl ( EventDB eventDB, Id courseId, Id courseControlId, PointF newLocation ) : Id[]
SortedCourseIds ( EventDB eventDB ) : Id[]
UniqueImageName ( EventDB eventDB, string imageName ) : string

Private Methods

Method	Description
ComputeLoad ( EventDB eventDB, Id courses ) : int
EnumCourseControlsAndSplitStarts ( EventDB eventDB, Id courseId ) : List
EnumCourseControlsAndSplitStartsToJoin ( EventDB eventDB, Id courseId, Id begin, Id join, Id splitStart ) : List
EnumCourseControlsToJoin ( EventDB eventDB, CourseDesignator courseDesignator, Id start, Id join, IEnumerable variationChoices, bool ignoreFirstSplit, int currentPart ) : List>
GetNextControl ( EventDB eventDB, CourseDesignator courseDesignator, Id courseControlId ) : Id
GetVariationString ( EventDB eventDB, IEnumerable choices, Dictionary variationMapper ) : string
GetVariationString ( EventDB eventDB, Id courseId, VariationInfo variationPath, Dictionary variationMapper ) : string
GetVariations ( EventDB eventDB, CourseDesignator courseDesignator, Id start, HashSet alreadyVisited ) : List>>
LowestNumericCode ( EventDB eventDB ) : int

Method Details

AllCoursesHaveLoads() public static method

public static AllCoursesHaveLoads ( EventDB eventDB ) : bool
eventDB	EventDB
return	bool

AllVariationsOfCourseControl() public static method

public static AllVariationsOfCourseControl ( EventDB eventDB, Id courseControlId ) : IEnumerable>
eventDB	EventDB
courseControlId	Id
return	IEnumerable>

AnyCoursesHaveLoads() public static method

public static AnyCoursesHaveLoads ( EventDB eventDB ) : bool
eventDB	EventDB
return	bool

AnyMultipartCourses() public static method

public static AnyMultipartCourses ( EventDB eventDB ) : bool
eventDB	EventDB
return	bool

CanAddVariation() public static method

public static CanAddVariation ( EventDB eventDB, CourseDesignator courseDesignator, Id courseControlId ) : bool
eventDB	EventDB
courseDesignator	CourseDesignator
courseControlId	Id
return	bool

CompareControlIds() public static method

public static CompareControlIds ( EventDB eventDB, Id controlId1, Id controlId2 ) : int
eventDB	EventDB
controlId1	Id
controlId2	Id
return	int

ComputeFlaggedLegLength() public static method

public static ComputeFlaggedLegLength ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : float
eventDB	EventDB
controlId1	Id
controlId2	Id
legId	Id
return	float

ComputeLegLength() public static method

public static ComputeLegLength ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : float
eventDB	EventDB
controlId1	Id
controlId2	Id
legId	Id
return	float

ComputeSpecialLength() public static method

public static ComputeSpecialLength ( EventDB eventDB, Id specialId ) : float
eventDB	EventDB
specialId	Id
return	float

ComputeStraightLineControlDistance() public static method

public static ComputeStraightLineControlDistance ( EventDB eventDB, Id controlId1, Id controlId2 ) : float
eventDB	EventDB
controlId1	Id
controlId2	Id
return	float

ControlsUnusedInCourses() public static method

public static ControlsUnusedInCourses ( EventDB eventDB ) : List>
eventDB	EventDB
return	List>

CountCourseParts() public static method

public static CountCourseParts ( EventDB eventDB, CourseDesignator courseDesignator ) : int
eventDB	EventDB
courseDesignator	CourseDesignator
return	int

CountCourseParts() public static method

public static CountCourseParts ( EventDB eventDB, Id courseId ) : int
eventDB	EventDB
courseId	Id
return	int

CountCourses() public static method

public static CountCourses ( EventDB eventDB ) : int
eventDB	EventDB
return	int

CourseContainsSpecial() public static method

public static CourseContainsSpecial ( EventDB eventDB, CourseDesignator courseDesignator, Id specialId ) : bool
eventDB	EventDB
courseDesignator	CourseDesignator
specialId	Id
return	bool

CourseIsForked() public static method

public static CourseIsForked ( EventDB eventDB, CourseDesignator courseDesignator ) : bool
eventDB	EventDB
courseDesignator	CourseDesignator
return	bool

CourseList() public static method

public static CourseList ( EventDB eventDB, IEnumerable courses ) : string
eventDB	EventDB
courses	IEnumerable
return	string

CourseUsesControl() public static method

public static CourseUsesControl ( EventDB eventDB, CourseDesignator courseDesignator, Id controlId ) : bool
eventDB	EventDB
courseDesignator	CourseDesignator
controlId	Id
return	bool

CoursesUsingControl() public static method

public static CoursesUsingControl ( EventDB eventDB, Id controlId ) : Id[]
eventDB	EventDB
controlId	Id
return	Id[]

CoursesUsingLeg() public static method

public static CoursesUsingLeg ( EventDB eventDB, Id control1, Id control2 ) : Id[]
eventDB	EventDB
control1	Id
control2	Id
return	Id[]

CreateOutputFileName() public static method

public static CreateOutputFileName ( EventDB eventDB, CourseDesignator courseDesignator, string filePrefix, string fileSuffix, string extension ) : string
eventDB	EventDB
courseDesignator	CourseDesignator
filePrefix	string
fileSuffix	string
extension	string
return	string

DistanceBetweenPointsInMeters() public static method

public static DistanceBetweenPointsInMeters ( EventDB eventDB, PointF pt1, PointF pt2 ) : float
eventDB	EventDB
pt1	System.Drawing.PointF
pt2	System.Drawing.PointF
return	float

DoesCourseControlPrecede() public static method

public static DoesCourseControlPrecede ( EventDB eventDB, CourseDesignator courseDesignator, Id courseControl1, Id courseControl2 ) : bool
eventDB	EventDB
courseDesignator	CourseDesignator
courseControl1	Id
courseControl2	Id
return	bool

EnumCourseControlIds() public static method

public static EnumCourseControlIds ( EventDB eventDB, CourseDesignator courseDesignator ) : IEnumerable>
eventDB	EventDB
courseDesignator	CourseDesignator
return	IEnumerable>

EnumLegs() public static method

public static EnumLegs ( EventDB eventDB, CourseDesignator courseDesignator ) : IEnumerable
eventDB	EventDB
courseDesignator	CourseDesignator
return	IEnumerable

EnumerateCourseDesignators() public static method

public static EnumerateCourseDesignators ( EventDB eventDB, Id courseIds, Dictionary variationChoicesPerCourse, bool enumeratePartsSeparately ) : IEnumerable
eventDB	EventDB
courseIds	Id
variationChoicesPerCourse	Dictionary
enumeratePartsSeparately	bool
return	IEnumerable

EnumerateCourseDesignators() public static method

public static EnumerateCourseDesignators ( EventDB eventDB, Id courseIds, bool enumeratePartsSeparately ) : IEnumerable
eventDB	EventDB
courseIds	Id
enumeratePartsSeparately	bool
return	IEnumerable

FindClosestLeg() public static method

public static FindClosestLeg ( EventDB eventDB, CourseDesignator courseDesignator, PointF pt ) : LegInfo
eventDB	EventDB
courseDesignator	CourseDesignator
pt	System.Drawing.PointF
return	LegInfo

FindCode() public static method

public static FindCode ( EventDB eventDB, string code ) : Id
eventDB	EventDB
code	string
return	Id

FindControlInsertionPoint() public static method

public static FindControlInsertionPoint ( EventDB eventDB, CourseDesignator courseDesignator, Id &courseControl1, Id &courseControl2 ) : void
eventDB	EventDB
courseDesignator	CourseDesignator
courseControl1	Id
courseControl2	Id
return	void

FindLeg() public static method

public static FindLeg ( EventDB eventDB, Id controlId1, Id controlId2 ) : Id
eventDB	EventDB
controlId1	Id
controlId2	Id
return	Id

GetAllPunchPatterns() public static method

public static GetAllPunchPatterns ( EventDB eventDB ) : PunchPattern>.Dictionary
eventDB	EventDB
return	PunchPattern>.Dictionary

GetAllVariations() public static method

public static GetAllVariations ( EventDB eventDB, Id courseId ) : IEnumerable
eventDB	EventDB
courseId	Id
return	IEnumerable

GetAutoNumbering() public static method

public static GetAutoNumbering ( EventDB eventDB, int &firstCode, bool &disallowInvertibleCodes ) : void
eventDB	EventDB
firstCode	int
disallowInvertibleCodes	bool
return	void

GetControlGaps() public static method

public static GetControlGaps ( EventDB eventDB, Id controlId, float scale ) : PurplePen.CircleGap[]
eventDB	EventDB
controlId	Id
scale	float
return	PurplePen.CircleGap[]

GetControlLoad() public static method

public static GetControlLoad ( EventDB eventDB, Id controlId ) : int
eventDB	EventDB
controlId	Id
return	int

GetCourseControlsInCourse() public static method

public static GetCourseControlsInCourse ( EventDB eventDB, CourseDesignator courseDesignator, Id controlId ) : Id[]
eventDB	EventDB
courseDesignator	CourseDesignator
controlId	Id
return	Id[]

GetCourseLoad() public static method

public static GetCourseLoad ( EventDB eventDB, Id courseId ) : int
eventDB	EventDB
courseId	Id
return	int

GetCoursePartBounds() public static method

public static GetCoursePartBounds ( EventDB eventDB, CourseDesignator courseDesignator, Id &startCourseControlId, Id &endCourseControlId ) : bool
eventDB	EventDB
courseDesignator	CourseDesignator
startCourseControlId	Id
endCourseControlId	Id
return	bool

GetCourseSortOrder() public static method

public static GetCourseSortOrder ( EventDB eventDB, Id courseId ) : int
eventDB	EventDB
courseId	Id
return	int

GetCustomSymbolText() public static method

public static GetCustomSymbolText ( EventDB eventDB, Dictionary &customSymbolText, bool>.Dictionary &customSymbolKey ) : void
eventDB	EventDB
customSymbolText	Dictionary
customSymbolKey	bool>.Dictionary
return	void

GetDefaultDescKind() public static method

public static GetDefaultDescKind ( EventDB eventDB, Id courseId ) : DescriptionKind
eventDB	EventDB
courseId	Id
return	DescriptionKind

GetDescriptionColumns() public static method

public static GetDescriptionColumns ( EventDB eventDB, Id specialId ) : int
eventDB	EventDB
specialId	Id
return	int

GetDescriptionLanguage() public static method

public static GetDescriptionLanguage ( EventDB eventDB ) : string
eventDB	EventDB
return	string

GetDesignatorsFromVariationChoices() public static method

public static GetDesignatorsFromVariationChoices ( EventDB eventDB, Id courseId, VariationChoices variationChoices ) : IEnumerable
eventDB	EventDB
courseId	Id
variationChoices	VariationChoices
return	IEnumerable

GetEventTitle() public static method

public static GetEventTitle ( EventDB eventDB, string lineSep ) : string
eventDB	EventDB
lineSep	string
return	string

GetForkStart() public static method

public static GetForkStart ( EventDB eventDB, Id courseId, Id courseControlId ) : Id
eventDB	EventDB
courseId	Id
courseControlId	Id
return	Id

GetLegFlagging() public static method

public static GetLegFlagging ( EventDB eventDB, Id controlId1, Id controlId2 ) : FlaggingKind
eventDB	EventDB
controlId1	Id
controlId2	Id
return	FlaggingKind

GetLegFlagging() public static method

public static GetLegFlagging ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : FlaggingKind
eventDB	EventDB
controlId1	Id
controlId2	Id
legId	Id
return	FlaggingKind

GetLegGaps() public static method

public static GetLegGaps ( EventDB eventDB, Id controlId1, Id controlId2 ) : LegGap[]
eventDB	EventDB
controlId1	Id
controlId2	Id
return	LegGap[]

GetLegGaps() public static method

public static GetLegGaps ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : LegGap[]
eventDB	EventDB
controlId1	Id
controlId2	Id
legId	Id
return	LegGap[]

GetLegLoad() public static method

public static GetLegLoad ( EventDB eventDB, Id control1, Id control2 ) : int
eventDB	EventDB
control1	Id
control2	Id
return	int

GetLegPath() public static method

public static GetLegPath ( EventDB eventDB, Id controlId1, Id controlId2 ) : SymPath
eventDB	EventDB
controlId1	Id
controlId2	Id
return	SymPath

GetLegPath() public static method

public static GetLegPath ( EventDB eventDB, Id controlId1, Id controlId2, Id legId ) : SymPath
eventDB	EventDB
controlId1	Id
controlId2	Id
legId	Id
return	SymPath

GetPartOptions() public static method

public static GetPartOptions ( EventDB eventDB, CourseDesignator courseDesignator ) : PartOptions
eventDB	EventDB
courseDesignator	CourseDesignator
return	PartOptions

GetPrintArea() public static method

public static GetPrintArea ( EventDB eventDB, CourseDesignator courseDesignator ) : PrintArea
eventDB	EventDB
courseDesignator	CourseDesignator
return	PrintArea

GetPrintScale() public static method

public static GetPrintScale ( EventDB eventDB, Id courseId ) : float
eventDB	EventDB
courseId	Id
return	float

GetSpecialDisplayedCourses() public static method

public static GetSpecialDisplayedCourses ( EventDB eventDB, Id specialId ) : CourseDesignator[]
eventDB	EventDB
specialId	Id
return	CourseDesignator[]

GetTextSpecialFonts() public static method

public static GetTextSpecialFonts ( EventDB eventDB ) : IEnumerable
eventDB	EventDB
return	IEnumerable

GetVariantCodeMapping() public static method

public static GetVariantCodeMapping ( EventDB eventDB, CourseDesignator courseDesignator ) : char>.Dictionary
eventDB	EventDB
courseDesignator	CourseDesignator
return	char>.Dictionary

GetVariationString() public static method

public static GetVariationString ( EventDB eventDB, Id courseId, VariationInfo variationPath ) : string
eventDB	EventDB
courseId	Id
variationPath	VariationInfo
return	string

HasFinishControl() public static method

public static HasFinishControl ( EventDB eventDB, Id courseId ) : bool
eventDB	EventDB
courseId	Id
return	bool

HasPartSpecificPrintArea() public static method

public static HasPartSpecificPrintArea ( EventDB eventDB, CourseDesignator courseDesignator ) : bool
eventDB	EventDB
courseDesignator	CourseDesignator
return	bool

HasStartControl() public static method

public static HasStartControl ( EventDB eventDB, Id courseId ) : bool
eventDB	EventDB
courseId	Id
return	bool

HasVariations() public static method

public static HasVariations ( EventDB eventDB, Id courseId ) : bool
eventDB	EventDB
courseId	Id
return	bool

IsCodeInUse() public static method

public static IsCodeInUse ( EventDB eventDB, string code ) : bool
eventDB	EventDB
code	string
return	bool

IsCourseControlInPart() public static method

public static IsCourseControlInPart ( EventDB eventDB, CourseDesignator courseDesignator, Id courseControlId ) : bool
eventDB	EventDB
courseDesignator	CourseDesignator
courseControlId	Id
return	bool

IsImageNameUsed() public static method

public static IsImageNameUsed ( EventDB eventDB, string imageName ) : bool
eventDB	EventDB
imageName	string
return	bool

IsLegalControlCode() public static method

public static IsLegalControlCode ( string code, string &reason ) : bool
code	string
reason	string
return	bool

IsPreferredControlCode() public static method

public static IsPreferredControlCode ( EventDB eventDB, string code, string &reason ) : bool
eventDB	EventDB
code	string
reason	string
return	bool

LastCourseControl() public static method

public static LastCourseControl ( EventDB eventDB, Id courseId, bool dontReturnFinish ) : Id
eventDB	EventDB
courseId	Id
dontReturnFinish	bool
return	Id

NextUnusedControlCode() public static method

public static NextUnusedControlCode ( EventDB eventDB ) : string
eventDB	EventDB
return	string

ShouldWarnAboutMovingControl() public static method

public static ShouldWarnAboutMovingControl ( EventDB eventDB, Id courseId, Id courseControlId, PointF newLocation ) : Id[]
eventDB	EventDB
courseId	Id
courseControlId	Id
newLocation	PointF
return	Id[]

SortedCourseIds() public static method

public static SortedCourseIds ( EventDB eventDB ) : Id[]
eventDB	EventDB
return	Id[]

UniqueImageName() public static method

public static UniqueImageName ( EventDB eventDB, string imageName ) : string
eventDB	EventDB
imageName	string
return	string