SCH::ISch_Lib Struct Reference

#include <EDP.SCH.Interfaces.h>

Inheritance diagram for SCH::ISch_Lib:

Public Member Functions
void	SetState_ShowHiddenPins (bool AValue)
void	SetState_Description (std::wstring AValue)
void	SetState_Current_SchComponent (ISch_Component *AValue)
void	SetState_ReleaseVaultGUID (std::wstring AValue)
void	SetState_FolderGUID (std::wstring AValue)
bool	GetState_ShowHiddenPins ()
std::wstring	GetState_Description ()
ISch_Component *	GetState_Current_SchComponent ()
void	SetState_CurrentSchComponentAddPart ()
void	SetState_CurrentSchComponentAddDisplayMode ()
void	SetState_CurrentSchComponentRemovePart ()
void	SetState_CurrentSchComponentRemoveDisplayMode ()
void	SetState_CurrentSchComponentPartId (int APartId)
int	GetState_CurrentSchComponentPartId ()
void	SetState_CurrentSchComponentDisplayMode (int ADisplayMode)
int	GetState_CurrentSchComponentDisplayMode ()
std::wstring	GetState_ReleaseVaultGUID ()
std::wstring	GetState_FolderGUID ()
void	AddSchComponent (ISch_Component *const AComponent)
void	RemoveSchComponent (ISch_Component *const AComponent)
ISch_Iterator *	SchLibIterator_Create ()
bool	LibIsEmpty ()
void	TransferComponentsPrimitivesBackFromEditor ()
void	TransferComponentsPrimitivesToEditor ()
ISch_LibraryRuleChecker *	Sch_LibraryRuleChecker_Create ()
void	SplitIntoComponents (std::wstring const AOutputDirectoryPath, bool AOverwriteExistingFile, bool ARemoveParameter, bool ARemoveModel, bool ARemoveBadCharactersFromName)
ISch_Component *	GetState_SchComponentByLibRef (std::wstring ALibRef)
bool	LinkDocumentToReleaseVault (std::wstring Parameters, std::wstring *ErrorMsg)
bool	ReleaseDocument (std::wstring Parameters, std::wstring *ErrorMsg)
void	SetState_LifeCycleDefinitionGUID (std::wstring AValue)
std::wstring	GetState_LifeCycleDefinitionGUID ()
void	SetState_RevisionNamingSchemeGUID (std::wstring AValue)
std::wstring	GetState_RevisionNamingSchemeGUID ()
void	LoadFromFile (std::wstring const VFSAddress)
void	SaveToFile (std::wstring const VFSAddress)
void	Sch_LibraryRuleChecker_Destroy (ISch_LibraryRuleChecker **ARuleChecker)
Public Member Functions inherited from SCH::ISch_Document
void	SetState_DocumentBorderStyle (TSheetDocumentBorderStyle AValue)
void	SetState_CustomSheetStyle (std::wstring AValue)
void	SetState_SheetStyle (TSheetStyle AValue)
void	SetState_WorkspaceOrientation (TSheetOrientation AValue)
void	SetState_TitleBlockOn (bool AValue)
void	SetState_ReferenceZonesOn (bool AValue)
void	SetState_BorderOn (bool AValue)
void	SetState_UseCustomSheet (bool AValue)
void	SetState_CustomX (int AValue)
void	SetState_CustomY (int AValue)
void	SetState_CustomXZones (int AValue)
void	SetState_CustomYZones (int AValue)
void	SetState_CustomMarginWidth (int AValue)
void	SetState_SnapGridOn (bool AValue)
void	SetState_SnapGridSize (int AValue)
void	SetState_VisibleGridOn (bool AValue)
void	SetState_VisibleGridSize (int AValue)
void	SetState_HotspotGridOn (bool AValue)
void	SetState_HotspotGridSize (int AValue)
void	SetState_ShowTemplateGraphics (bool AValue)
void	SetState_TemplateFileName (std::wstring AValue)
void	SetState_SheetSizeX (int AValue)
void	SetState_SheetSizeY (int AValue)
void	SetState_SheetZonesX (int AValue)
void	SetState_SheetZonesY (int AValue)
void	SetState_SheetMarginWidth (int AValue)
void	SetState_SystemFont (int AValue)
void	SetState_LoadFormat (std::wstring AValue)
void	SetState_Unit (TUnit AValue)
std::wstring	GetState_DocumentName ()
TSheetDocumentBorderStyle	GetState_DocumentBorderStyle ()
std::wstring	GetState_CustomSheetStyle ()
TSheetStyle	GetState_SheetStyle ()
TSheetOrientation	GetState_WorkspaceOrientation ()
bool	GetState_TitleBlockOn ()
bool	GetState_ReferenceZonesOn ()
bool	GetState_BorderOn ()
bool	GetState_UseCustomSheet ()
int	GetState_CustomX ()
int	GetState_CustomY ()
int	GetState_CustomXZones ()
int	GetState_CustomYZones ()
int	GetState_CustomMarginWidth ()
bool	GetState_SnapGridOn ()
int	GetState_SnapGridSize ()
bool	GetState_VisibleGridOn ()
int	GetState_VisibleGridSize ()
bool	GetState_HotspotGridOn ()
int	GetState_HotspotGridSize ()
bool	GetState_ShowTemplateGraphics ()
std::wstring	GetState_TemplateFileName ()
int	GetState_SheetSizeX ()
int	GetState_SheetSizeY ()
int	GetState_SheetZonesX ()
int	GetState_SheetZonesY ()
int	GetState_SheetMarginWidth ()
int	GetState_SystemFont ()
std::wstring	GetState_LoadFormat ()
TUnit	GetState_Unit ()
TUnitSystem	GetState_UnitSystem ()
int	GetState_InternalTolerance ()
C_CoordRect	Graphical_VirtualRectangle ()
C_CoordRect	BoundingRectangle_Selected ()
void	RegisterSchObjectInContainer (ISch_BasicContainer *AObject)
void	UnRegisterSchObjectFromContainer (ISch_BasicContainer *AObject)
std::wstring	ObjectReferenceZone (ISch_BasicContainer *AObject)
void	RedrawToDC (long DC, int PrintKind, int PrintWhat)
void	UnregisterAndFreeAllConnectionLines ()
void	LockViewUpdate ()
void	UnLockViewUpdate ()
ISch_HitTest *	CreateHitTest (THitTestMode ATestMode, DXP::C_Point ALocation)
void	CreateLibraryFromProject (bool AddLibToProject, std::wstring FileName, bool RunQuiet)
void	UpdateDocumentProperties ()
int	CountContextMenuObjects (TObjectSet AObjectSet)
ISch_HitTest *	PopupMenuHitTest ()
int	GridCoordinateUp (int ACoord)
int	GridCoordinateClosest (int ACoord)
void	UpdateDisplayForCurrentSheet ()
bool	IsInEditorView ()
bool	ChooseLocationInteractively (DXP::C_Point *ALocation, std::wstring Prompt)
bool	ChooseRectangleInteractively (C_CoordRect *ARect, std::wstring Prompt1, std::wstring Prompt2)
void	SetTemplateInfo (std::wstring const AVaultGUID, std::wstring const AItemGUID, std::wstring const ARevisionGUID, std::wstring const AVaultHRID, std::wstring const ARevisionHRID)
std::wstring	GetTemplateVaultGUID ()
std::wstring	GetTemplateItemGUID ()
std::wstring	GetTemplateRevisionGUID ()
std::wstring	GetTemplateVaultHRID ()
std::wstring	GetTemplateRevisionHRID ()
std::wstring	GetPropsVaultGUID ()
std::wstring	GetPropsRevisionGUID ()
void	SetPreferencesInfo (std::wstring const AVaultGUID, std::wstring const ARevisionGUID)
std::wstring	GenerateUniqueID ()
int	GetState_MinorVersion ()
void	RecreateHandles ()
bool	HasServerDocument ()
int	GetState_SchDocID ()
Public Member Functions inherited from SCH::ISch_ParametrizedGroup
bool	Import_FromUser_Parameters ()
void	ResetAllSchParametersPosition ()
Public Member Functions inherited from SCH::ISch_GraphicalObject
DXP::C_Point	GetState_Location ()
DXP::TColor	GetState_Color ()
DXP::TColor	GetState_AreaColor ()
bool	GetState_Selection ()
bool	GetState_EnableDraw ()
bool	GetState_Disabled ()
bool	GetState_Dimmed ()
int	GetState_OwnerPartId ()
int	GetState_OwnerPartDisplayMode ()
std::wstring	GetState_LiveHighlightValue ()
EDP::TErrorKind	GetState_ErrorKind ()
DXP::TColor	GetState_ErrorColor ()
bool	GetState_DisplayError ()
std::wstring	GetState_ErrorString ()
bool	GetState_CompilationMasked ()
void	SetState_Location (DXP::C_Point ALocation)
void	SetState_Color (DXP::TColor AColor)
void	SetState_AreaColor (DXP::TColor AColor)
void	SetState_Selection (bool B)
void	SetState_EnableDraw (bool B)
void	SetState_Disabled (bool B)
void	SetState_Dimmed (bool B)
void	SetState_OwnerPartId (int AValue)
void	SetState_OwnerPartDisplayMode (int AValue)
void	SetState_LiveHighlightValue (std::wstring AValue)
void	SetState_ErrorKind (EDP::TErrorKind AValue)
void	SetState_ErrorColor (DXP::TColor AValue)
void	SetState_DisplayError (bool AValue)
void	SetState_ErrorString (std::wstring const AValue)
void	SetState_CompilationMasked (bool AValue)
void	RotateBy90 (DXP::C_Point Center, TRotationBy90 A)
void	MoveByXY (int x, int y)
void	MoveToXY (int x, int y)
void	Mirror (DXP::C_Point Axis)
void	SetState_xSizeySize ()
void	GraphicallyInvalidate ()
C_CoordRect	BoundingRectangle ()
C_CoordRect	BoundingRectangle_Full ()
void	AddErrorString (std::wstring const AErrorString, bool AtEnd)
void	ResetErrorFields ()
Public Member Functions inherited from SCH::ISch_BasicContainer
void	SetState_Text (std::wstring AValue)
TObjectId	GetState_ObjectId ()
ISch_BasicContainer *	GetState_SchBasicContainer ()
ISch_Document *	GetState_OwnerSchDocument ()
std::wstring	GetState_Text ()
void	AddSchObject (ISch_BasicContainer *AObject)
void	AddAndPositionSchObject (ISch_BasicContainer *AObject)
void	RemoveSchObject (ISch_BasicContainer *AObject)
ISch_Iterator *	SchIterator_Create ()
void	DeleteAll ()
void	FreeAllContainedObjects ()
void	Setstate_Default (TUnitSystem AUnit)
bool	Import_FromUser ()
std::wstring	GetState_IdentifierString ()
std::wstring	GetState_DescriptionString ()
ISch_BasicContainer *	Replicate ()
std::wstring	ExportToParameters ()
void	SchIterator_Destroy (ISch_Iterator **AIterator)
void	SetState_UniqueId (std::wstring AValue)
std::wstring	GetState_Handle ()
std::wstring	GetState_UniqueId ()

Member Function Documentation

AddSchComponent()

void SCH::ISch_Lib::AddSchComponent

(

ISch_Component *const

AComponent

)

GetState_Current_SchComponent()

ISch_Component * SCH::ISch_Lib::GetState_Current_SchComponent

(

)

GetState_CurrentSchComponentDisplayMode()

int SCH::ISch_Lib::GetState_CurrentSchComponentDisplayMode

(

)

GetState_CurrentSchComponentPartId()

int SCH::ISch_Lib::GetState_CurrentSchComponentPartId

(

)

GetState_Description()

std::wstring SCH::ISch_Lib::GetState_Description

(

)

GetState_FolderGUID()

std::wstring SCH::ISch_Lib::GetState_FolderGUID

(

)

GetState_LifeCycleDefinitionGUID()

std::wstring SCH::ISch_Lib::GetState_LifeCycleDefinitionGUID

(

)

GetState_ReleaseVaultGUID()

std::wstring SCH::ISch_Lib::GetState_ReleaseVaultGUID

(

)

GetState_RevisionNamingSchemeGUID()

std::wstring SCH::ISch_Lib::GetState_RevisionNamingSchemeGUID

(

)

GetState_SchComponentByLibRef()

ISch_Component * SCH::ISch_Lib::GetState_SchComponentByLibRef

(

std::wstring

ALibRef

)

GetState_ShowHiddenPins()

bool SCH::ISch_Lib::GetState_ShowHiddenPins

(

)

LibIsEmpty()

bool SCH::ISch_Lib::LibIsEmpty

(

)

LinkDocumentToReleaseVault()

bool SCH::ISch_Lib::LinkDocumentToReleaseVault	(	std::wstring	Parameters,
		std::wstring *	ErrorMsg )

LoadFromFile()

void SCH::ISch_Lib::LoadFromFile

(

std::wstring const

VFSAddress

)

ReleaseDocument()

bool SCH::ISch_Lib::ReleaseDocument	(	std::wstring	Parameters,
		std::wstring *	ErrorMsg )

RemoveSchComponent()

void SCH::ISch_Lib::RemoveSchComponent

(

ISch_Component *const

AComponent

)

SaveToFile()

void SCH::ISch_Lib::SaveToFile

(

std::wstring const

VFSAddress

)

Sch_LibraryRuleChecker_Create()

ISch_LibraryRuleChecker * SCH::ISch_Lib::Sch_LibraryRuleChecker_Create

(

)

Sch_LibraryRuleChecker_Destroy()

void SCH::ISch_Lib::Sch_LibraryRuleChecker_Destroy

(

ISch_LibraryRuleChecker **

ARuleChecker

)

SchLibIterator_Create()

ISch_Iterator * SCH::ISch_Lib::SchLibIterator_Create

(

)

SetState_Current_SchComponent()

void SCH::ISch_Lib::SetState_Current_SchComponent

(

ISch_Component *

AValue

)

SetState_CurrentSchComponentAddDisplayMode()

void SCH::ISch_Lib::SetState_CurrentSchComponentAddDisplayMode

(

)

SetState_CurrentSchComponentAddPart()

void SCH::ISch_Lib::SetState_CurrentSchComponentAddPart

(

)

SetState_CurrentSchComponentDisplayMode()

void SCH::ISch_Lib::SetState_CurrentSchComponentDisplayMode

(

int

ADisplayMode

)

SetState_CurrentSchComponentPartId()

void SCH::ISch_Lib::SetState_CurrentSchComponentPartId

(

int

APartId

)

SetState_CurrentSchComponentRemoveDisplayMode()

void SCH::ISch_Lib::SetState_CurrentSchComponentRemoveDisplayMode

(

)

SetState_CurrentSchComponentRemovePart()

void SCH::ISch_Lib::SetState_CurrentSchComponentRemovePart

(

)

SetState_Description()

void SCH::ISch_Lib::SetState_Description

(

std::wstring

AValue

)

SetState_FolderGUID()

void SCH::ISch_Lib::SetState_FolderGUID

(

std::wstring

AValue

)

SetState_LifeCycleDefinitionGUID()

void SCH::ISch_Lib::SetState_LifeCycleDefinitionGUID

(

std::wstring

AValue

)

SetState_ReleaseVaultGUID()

void SCH::ISch_Lib::SetState_ReleaseVaultGUID

(

std::wstring

AValue

)

SetState_RevisionNamingSchemeGUID()

void SCH::ISch_Lib::SetState_RevisionNamingSchemeGUID

(

std::wstring

AValue

)

SetState_ShowHiddenPins()

void SCH::ISch_Lib::SetState_ShowHiddenPins

(

bool

AValue

)

SplitIntoComponents()

void SCH::ISch_Lib::SplitIntoComponents	(	std::wstring const	AOutputDirectoryPath,
		bool	AOverwriteExistingFile,
		bool	ARemoveParameter,
		bool	ARemoveModel,
		bool	ARemoveBadCharactersFromName )

TransferComponentsPrimitivesBackFromEditor()

void SCH::ISch_Lib::TransferComponentsPrimitivesBackFromEditor

(

)

TransferComponentsPrimitivesToEditor()

void SCH::ISch_Lib::TransferComponentsPrimitivesToEditor

(

)

---

The documentation for this struct was generated from the following file:

• EDP.SCH.Interfaces.h