Altium C++ SDK 3.0
Loading...
Searching...
No Matches
SCH::ISch_Component Struct Reference

#include <EDP.SCH.Interfaces.h>

Inheritance diagram for SCH::ISch_Component:
SCH::ISch_ParametrizedGroup SCH::ISch_GraphicalObject SCH::ISch_BasicContainer

Public Member Functions

void SetState_DisplayMode (int AValue)
void SetState_DisplayModeCount_Check (int AValue)
void SetState_ShowHiddenPins (bool AValue)
void SetState_DisplayFieldNames (bool AValue)
void SetState_CurrentPartID (int AValue)
void SetState_PartCountNoPart0 (int AValue)
void SetState_Orientation (TRotationBy90 AValue)
void SetState_DesignatorLocked (bool AValue)
void SetState_PartIdLocked (bool AValue)
void SetState_PinsMoveable (bool AValue)
void SetState_PinColor (DXP::TColor AValue)
void SetState_OverideColors (bool AValue)
void SetState_IsMirrored (bool AValue)
void SetState_ShowHiddenFields (bool AValue)
void SetState_ComponentKind (EDP::TComponentKind AValue)
void SetState_LibraryPath (std::wstring AValue)
void SetState_SourceLibraryName (std::wstring AValue)
void SetState_LibReference (std::wstring AValue)
void SetState_SheetPartFileName (std::wstring AValue)
void SetState_TargetFileName (std::wstring AValue)
void SetState_ComponentDescription (std::wstring AValue)
void SetState_AliasAsText (std::wstring AValue)
void SetState_AliasAt (int I, std::wstring AValue)
void SetState_FilePosition (int AValue)
void SetState_DatabaseTableName (std::wstring AValue)
int GetState_DisplayMode ()
int GetState_DisplayModeCount ()
bool GetState_ShowHiddenPins ()
bool GetState_DisplayFieldNames ()
int GetState_CurrentPartID ()
int GetState_PartCountNoPart0 ()
TRotationBy90 GetState_Orientation ()
bool GetState_DesignatorLocked ()
bool GetState_PartIdLocked ()
bool GetState_PinsMoveable ()
DXP::TColor GetState_PinColor ()
bool GetState_OverideColors ()
bool GetState_IsMirrored ()
bool GetState_ShowHiddenFields ()
EDP::TComponentKind GetState_ComponentKind ()
std::wstring GetState_LibraryPath ()
std::wstring GetState_SourceLibraryName ()
std::wstring GetState_LibReference ()
std::wstring GetState_SheetPartFileName ()
std::wstring GetState_TargetFileName ()
std::wstring GetState_ComponentDescription ()
std::wstring GetState_AliasAsText ()
int GetState_AliasCount ()
std::wstring GetState_AliasAt (int I)
std::wstring GetState_ConfiguratorName ()
ISch_DesignatorGetState_SchDesignator ()
ISch_ParameterGetState_SchComment ()
std::wstring GetState_DatabaseLibraryName ()
std::wstring GetState_DatabaseTableName ()
void Alias_Add (std::wstring S)
void Alias_Remove (std::wstring S)
void Alias_Delete (int I)
void Alias_Clear ()
void AddPart ()
void AddDisplayMode ()
void DeletePart (int APartId)
void DeleteDisplayMode (int AMode)
std::wstring FullPartDesignator (int APartId)
ISch_ImplementationAddSchImplementation ()
void RemoveSchImplementation (ISch_Implementation *AnImplementation)
bool IsIntegratedComponent ()
bool IsMultiPartComponent ()
bool InSheet ()
bool InLibrary ()
void UpdatePrimitivesAccessibility ()
std::wstring GetState_DatabaseLibraryKeys (std::wstring ADelimiter)
EDP::IVariantOptionGetState_VariantOption ()
void SetState_VariantOption (EDP::IVariantOption *AValue)
bool GetState_UseLibraryName ()
bool GetState_UseDBTableName ()
EDP::TLibIdentifierKind GetState_LibIdentifierKind ()
std::wstring GetState_LibraryIdentifier ()
std::wstring GetState_DesignItemId ()
std::wstring GetState_SymbolReference ()
void SetState_UseLibraryName (bool AValue)
void SetState_UseDBTableName (bool AValue)
void SetState_DesignItemId (std::wstring AValue)
void SetState_SymbolReference (std::wstring AValue)
void OffsetParameters_Default ()
void SetState_OrientationWithoutRotating (TRotationBy90 AValue)
ISch_ParameterAddSchParameter ()
std::wstring SuggestedSearchKeywords ()
void SetState_IsUserConfigurable (bool AValue)
bool GetState_IsUserConfigurable ()
void SaveToFile (std::wstring VFSAddress)
std::wstring GetState_ConfigurationParameters ()
std::wstring GetState_VaultGUID ()
std::wstring GetState_ItemGUID ()
std::wstring GetState_RevisionGUID ()
std::wstring GetState_SymbolVaultGUID ()
std::wstring GetState_SymbolItemGUID ()
std::wstring GetState_SymbolRevisionGUID ()
void SetState_VaultGUID (std::wstring AValue)
void SetState_ItemGUID (std::wstring AValue)
void SetState_RevisionGUID (std::wstring AValue)
void SetState_SymbolVaultGUID (std::wstring AValue)
void SetState_SymbolItemGUID (std::wstring AValue)
void SetState_SymbolRevisionGUID (std::wstring AValue)
void UpdatePart_PreProcess ()
void UpdatePart_PostProcess ()
bool GetState_SelectedInLibrary ()
void SetState_SelectedInLibrary (bool AValue)
void ValidateImplementationsCurrentState ()
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_BasicContainerGetState_SchBasicContainer ()
ISch_DocumentGetState_OwnerSchDocument ()
std::wstring GetState_Text ()
void AddSchObject (ISch_BasicContainer *AObject)
void AddAndPositionSchObject (ISch_BasicContainer *AObject)
void RemoveSchObject (ISch_BasicContainer *AObject)
ISch_IteratorSchIterator_Create ()
void DeleteAll ()
void FreeAllContainedObjects ()
void Setstate_Default (TUnitSystem AUnit)
bool Import_FromUser ()
std::wstring GetState_IdentifierString ()
std::wstring GetState_DescriptionString ()
ISch_BasicContainerReplicate ()
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

◆ AddDisplayMode()

void SCH::ISch_Component::AddDisplayMode ( )

◆ AddPart()

void SCH::ISch_Component::AddPart ( )

◆ AddSchImplementation()

ISch_Implementation * SCH::ISch_Component::AddSchImplementation ( )

◆ AddSchParameter()

ISch_Parameter * SCH::ISch_Component::AddSchParameter ( )

◆ Alias_Add()

void SCH::ISch_Component::Alias_Add ( std::wstring S)

◆ Alias_Clear()

void SCH::ISch_Component::Alias_Clear ( )

◆ Alias_Delete()

void SCH::ISch_Component::Alias_Delete ( int I)

◆ Alias_Remove()

void SCH::ISch_Component::Alias_Remove ( std::wstring S)

◆ DeleteDisplayMode()

void SCH::ISch_Component::DeleteDisplayMode ( int AMode)

◆ DeletePart()

void SCH::ISch_Component::DeletePart ( int APartId)

◆ FullPartDesignator()

std::wstring SCH::ISch_Component::FullPartDesignator ( int APartId)

◆ GetState_AliasAsText()

std::wstring SCH::ISch_Component::GetState_AliasAsText ( )

◆ GetState_AliasAt()

std::wstring SCH::ISch_Component::GetState_AliasAt ( int I)

◆ GetState_AliasCount()

int SCH::ISch_Component::GetState_AliasCount ( )

◆ GetState_ComponentDescription()

std::wstring SCH::ISch_Component::GetState_ComponentDescription ( )

◆ GetState_ComponentKind()

EDP::TComponentKind SCH::ISch_Component::GetState_ComponentKind ( )

◆ GetState_ConfigurationParameters()

std::wstring SCH::ISch_Component::GetState_ConfigurationParameters ( )

◆ GetState_ConfiguratorName()

std::wstring SCH::ISch_Component::GetState_ConfiguratorName ( )

◆ GetState_CurrentPartID()

int SCH::ISch_Component::GetState_CurrentPartID ( )

◆ GetState_DatabaseLibraryKeys()

std::wstring SCH::ISch_Component::GetState_DatabaseLibraryKeys ( std::wstring ADelimiter)

◆ GetState_DatabaseLibraryName()

std::wstring SCH::ISch_Component::GetState_DatabaseLibraryName ( )

◆ GetState_DatabaseTableName()

std::wstring SCH::ISch_Component::GetState_DatabaseTableName ( )

◆ GetState_DesignatorLocked()

bool SCH::ISch_Component::GetState_DesignatorLocked ( )

◆ GetState_DesignItemId()

std::wstring SCH::ISch_Component::GetState_DesignItemId ( )

◆ GetState_DisplayFieldNames()

bool SCH::ISch_Component::GetState_DisplayFieldNames ( )

◆ GetState_DisplayMode()

int SCH::ISch_Component::GetState_DisplayMode ( )

◆ GetState_DisplayModeCount()

int SCH::ISch_Component::GetState_DisplayModeCount ( )

◆ GetState_IsMirrored()

bool SCH::ISch_Component::GetState_IsMirrored ( )

◆ GetState_IsUserConfigurable()

bool SCH::ISch_Component::GetState_IsUserConfigurable ( )

◆ GetState_ItemGUID()

std::wstring SCH::ISch_Component::GetState_ItemGUID ( )

◆ GetState_LibIdentifierKind()

EDP::TLibIdentifierKind SCH::ISch_Component::GetState_LibIdentifierKind ( )

◆ GetState_LibraryIdentifier()

std::wstring SCH::ISch_Component::GetState_LibraryIdentifier ( )

◆ GetState_LibraryPath()

std::wstring SCH::ISch_Component::GetState_LibraryPath ( )

◆ GetState_LibReference()

std::wstring SCH::ISch_Component::GetState_LibReference ( )

◆ GetState_Orientation()

TRotationBy90 SCH::ISch_Component::GetState_Orientation ( )

◆ GetState_OverideColors()

bool SCH::ISch_Component::GetState_OverideColors ( )

◆ GetState_PartCountNoPart0()

int SCH::ISch_Component::GetState_PartCountNoPart0 ( )

◆ GetState_PartIdLocked()

bool SCH::ISch_Component::GetState_PartIdLocked ( )

◆ GetState_PinColor()

DXP::TColor SCH::ISch_Component::GetState_PinColor ( )

◆ GetState_PinsMoveable()

bool SCH::ISch_Component::GetState_PinsMoveable ( )

◆ GetState_RevisionGUID()

std::wstring SCH::ISch_Component::GetState_RevisionGUID ( )

◆ GetState_SchComment()

ISch_Parameter * SCH::ISch_Component::GetState_SchComment ( )

◆ GetState_SchDesignator()

ISch_Designator * SCH::ISch_Component::GetState_SchDesignator ( )

◆ GetState_SelectedInLibrary()

bool SCH::ISch_Component::GetState_SelectedInLibrary ( )

◆ GetState_SheetPartFileName()

std::wstring SCH::ISch_Component::GetState_SheetPartFileName ( )

◆ GetState_ShowHiddenFields()

bool SCH::ISch_Component::GetState_ShowHiddenFields ( )

◆ GetState_ShowHiddenPins()

bool SCH::ISch_Component::GetState_ShowHiddenPins ( )

◆ GetState_SourceLibraryName()

std::wstring SCH::ISch_Component::GetState_SourceLibraryName ( )

◆ GetState_SymbolItemGUID()

std::wstring SCH::ISch_Component::GetState_SymbolItemGUID ( )

◆ GetState_SymbolReference()

std::wstring SCH::ISch_Component::GetState_SymbolReference ( )

◆ GetState_SymbolRevisionGUID()

std::wstring SCH::ISch_Component::GetState_SymbolRevisionGUID ( )

◆ GetState_SymbolVaultGUID()

std::wstring SCH::ISch_Component::GetState_SymbolVaultGUID ( )

◆ GetState_TargetFileName()

std::wstring SCH::ISch_Component::GetState_TargetFileName ( )

◆ GetState_UseDBTableName()

bool SCH::ISch_Component::GetState_UseDBTableName ( )

◆ GetState_UseLibraryName()

bool SCH::ISch_Component::GetState_UseLibraryName ( )

◆ GetState_VariantOption()

EDP::IVariantOption * SCH::ISch_Component::GetState_VariantOption ( )

◆ GetState_VaultGUID()

std::wstring SCH::ISch_Component::GetState_VaultGUID ( )

◆ InLibrary()

bool SCH::ISch_Component::InLibrary ( )

◆ InSheet()

bool SCH::ISch_Component::InSheet ( )

◆ IsIntegratedComponent()

bool SCH::ISch_Component::IsIntegratedComponent ( )

◆ IsMultiPartComponent()

bool SCH::ISch_Component::IsMultiPartComponent ( )

◆ OffsetParameters_Default()

void SCH::ISch_Component::OffsetParameters_Default ( )

◆ RemoveSchImplementation()

void SCH::ISch_Component::RemoveSchImplementation ( ISch_Implementation * AnImplementation)

◆ SaveToFile()

void SCH::ISch_Component::SaveToFile ( std::wstring VFSAddress)

◆ SetState_AliasAsText()

void SCH::ISch_Component::SetState_AliasAsText ( std::wstring AValue)

◆ SetState_AliasAt()

void SCH::ISch_Component::SetState_AliasAt ( int I,
std::wstring AValue )

◆ SetState_ComponentDescription()

void SCH::ISch_Component::SetState_ComponentDescription ( std::wstring AValue)

◆ SetState_ComponentKind()

void SCH::ISch_Component::SetState_ComponentKind ( EDP::TComponentKind AValue)

◆ SetState_CurrentPartID()

void SCH::ISch_Component::SetState_CurrentPartID ( int AValue)

◆ SetState_DatabaseTableName()

void SCH::ISch_Component::SetState_DatabaseTableName ( std::wstring AValue)

◆ SetState_DesignatorLocked()

void SCH::ISch_Component::SetState_DesignatorLocked ( bool AValue)

◆ SetState_DesignItemId()

void SCH::ISch_Component::SetState_DesignItemId ( std::wstring AValue)

◆ SetState_DisplayFieldNames()

void SCH::ISch_Component::SetState_DisplayFieldNames ( bool AValue)

◆ SetState_DisplayMode()

void SCH::ISch_Component::SetState_DisplayMode ( int AValue)

◆ SetState_DisplayModeCount_Check()

void SCH::ISch_Component::SetState_DisplayModeCount_Check ( int AValue)

◆ SetState_FilePosition()

void SCH::ISch_Component::SetState_FilePosition ( int AValue)

◆ SetState_IsMirrored()

void SCH::ISch_Component::SetState_IsMirrored ( bool AValue)

◆ SetState_IsUserConfigurable()

void SCH::ISch_Component::SetState_IsUserConfigurable ( bool AValue)

◆ SetState_ItemGUID()

void SCH::ISch_Component::SetState_ItemGUID ( std::wstring AValue)

◆ SetState_LibraryPath()

void SCH::ISch_Component::SetState_LibraryPath ( std::wstring AValue)

◆ SetState_LibReference()

void SCH::ISch_Component::SetState_LibReference ( std::wstring AValue)

◆ SetState_Orientation()

void SCH::ISch_Component::SetState_Orientation ( TRotationBy90 AValue)

◆ SetState_OrientationWithoutRotating()

void SCH::ISch_Component::SetState_OrientationWithoutRotating ( TRotationBy90 AValue)

◆ SetState_OverideColors()

void SCH::ISch_Component::SetState_OverideColors ( bool AValue)

◆ SetState_PartCountNoPart0()

void SCH::ISch_Component::SetState_PartCountNoPart0 ( int AValue)

◆ SetState_PartIdLocked()

void SCH::ISch_Component::SetState_PartIdLocked ( bool AValue)

◆ SetState_PinColor()

void SCH::ISch_Component::SetState_PinColor ( DXP::TColor AValue)

◆ SetState_PinsMoveable()

void SCH::ISch_Component::SetState_PinsMoveable ( bool AValue)

◆ SetState_RevisionGUID()

void SCH::ISch_Component::SetState_RevisionGUID ( std::wstring AValue)

◆ SetState_SelectedInLibrary()

void SCH::ISch_Component::SetState_SelectedInLibrary ( bool AValue)

◆ SetState_SheetPartFileName()

void SCH::ISch_Component::SetState_SheetPartFileName ( std::wstring AValue)

◆ SetState_ShowHiddenFields()

void SCH::ISch_Component::SetState_ShowHiddenFields ( bool AValue)

◆ SetState_ShowHiddenPins()

void SCH::ISch_Component::SetState_ShowHiddenPins ( bool AValue)

◆ SetState_SourceLibraryName()

void SCH::ISch_Component::SetState_SourceLibraryName ( std::wstring AValue)

◆ SetState_SymbolItemGUID()

void SCH::ISch_Component::SetState_SymbolItemGUID ( std::wstring AValue)

◆ SetState_SymbolReference()

void SCH::ISch_Component::SetState_SymbolReference ( std::wstring AValue)

◆ SetState_SymbolRevisionGUID()

void SCH::ISch_Component::SetState_SymbolRevisionGUID ( std::wstring AValue)

◆ SetState_SymbolVaultGUID()

void SCH::ISch_Component::SetState_SymbolVaultGUID ( std::wstring AValue)

◆ SetState_TargetFileName()

void SCH::ISch_Component::SetState_TargetFileName ( std::wstring AValue)

◆ SetState_UseDBTableName()

void SCH::ISch_Component::SetState_UseDBTableName ( bool AValue)

◆ SetState_UseLibraryName()

void SCH::ISch_Component::SetState_UseLibraryName ( bool AValue)

◆ SetState_VariantOption()

void SCH::ISch_Component::SetState_VariantOption ( EDP::IVariantOption * AValue)

◆ SetState_VaultGUID()

void SCH::ISch_Component::SetState_VaultGUID ( std::wstring AValue)

◆ SuggestedSearchKeywords()

std::wstring SCH::ISch_Component::SuggestedSearchKeywords ( )

◆ UpdatePart_PostProcess()

void SCH::ISch_Component::UpdatePart_PostProcess ( )

◆ UpdatePart_PreProcess()

void SCH::ISch_Component::UpdatePart_PreProcess ( )

◆ UpdatePrimitivesAccessibility()

void SCH::ISch_Component::UpdatePrimitivesAccessibility ( )

◆ ValidateImplementationsCurrentState()

void SCH::ISch_Component::ValidateImplementationsCurrentState ( )

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