Altium C++ SDK 3.0
Loading...
Searching...
No Matches
EDP::IDocument Struct Reference

#include <EDP.Interfaces.h>

Inheritance diagram for EDP::IDocument:
EDP::IDMObject

Public Member Functions

std::wstring DM_FullPath ()
std::wstring DM_FileName ()
bool DM_DocumentIsLoaded ()
bool DM_LoadDocument ()
std::wstring DM_DocumentKind ()
bool DM_IsPrimaryImplementationDocument ()
IDocumentDM_LogicalDocument ()
IProjectDM_Project ()
bool DM_IsPhysicalDocument ()
std::wstring DM_PhysicalInstancePath ()
std::wstring DM_PhysicalInstanceName ()
std::wstring DM_PhysicalRoomName ()
IDocumentDM_PhysicalDocumentParent ()
int DM_PhysicalDocumentCount ()
int DM_CurrentInstanceNumber ()
int DM_ChannelIndex ()
std::wstring DM_ChannelPrefix ()
TChannelRoomNamingStyle DM_ChannelRoomNamingStyle ()
IDocumentDM_ChildDocuments (int Index)
IDocumentDM_ParentDocuments (int Index)
ISheetSymbolDM_ParentSheetSymbols (int Index)
INetItemDM_Ports (int Index)
ICrossSheetDM_CrossSheetConnectors (int Index)
IComponentDM_Components (int Index)
IComponentDM_UniqueComponents (int Index)
IBusDM_Buses (int Index)
IPartDM_UniqueParts (int Index)
IPartDM_Parts (int Index)
ISheetSymbolDM_SheetSymbols (int Index)
INetDM_Nets (int Index)
ITextFrameDM_TextFrames (int Index)
IRuleDM_Rules (int Index)
IChannelClassDM_ChannelClasses (int Index)
IComponentClassDM_ComponentClasses (int Index)
INetClassDM_NetClasses (int Index)
IDifferentialPairDM_DifferentialPairs (int Index)
IRoomDM_Rooms (int Index)
IVHDLEntityDM_VHDLEntities (int Index)
IConstraintGroupDM_ConstraintGroups (int Index)
int DM_ChildDocumentCount ()
int DM_ParentDocumentCount ()
int DM_ParentSheetSymbolCount ()
int DM_PortCount ()
int DM_CrossSheetConnectorCount ()
int DM_ComponentCount ()
int DM_UniqueComponentCount ()
int DM_BusCount ()
int DM_UniquePartCount ()
int DM_PartCount ()
int DM_SheetSymbolCount ()
int DM_NetCount ()
int DM_TextFrameCount ()
int DM_RuleCount ()
int DM_ChannelClassCount ()
int DM_ComponentClassCount ()
int DM_NetClassCount ()
int DM_DifferentialPairCount ()
int DM_RoomCount ()
int DM_VHDLEntityCount ()
int DM_ConstraintGroupCount ()
std::wstring DM_ModelKind ()
int DM_IndentLevel ()
void DM_UpdateDateModified ()
bool DM_Compile ()
bool DM_ScrapCompile (bool ForceCompile)
IViolationDM_CreateViolation (TErrorKind AErrorKind, std::wstring AErrorString)
bool DM_DocumentIsTextual ()
ISignalManagerDM_SignalManager ()
int DM_SpatialAnalysisForTest ()
INetDM_HarnessNets (int Index)
int DM_HarnessNetCount ()
ISheetSymbolDM_HarnessConnectors (int Index)
int DM_HarnessConnectorCount ()
bool DM_ScrapCompileWithOptions (bool ForceCompile, std::wstring AOptions)
std::wstring DM_GetItemRevisionGUID ()
void DM_SetItemRevisionGUID (std::wstring S)
IBlanketDM_Blankets (int Index)
int DM_BlanketCount ()
bool DM_NeedsScrapCompile ()
int DM_FSMStateCount ()
IDM_FSMStateDM_FSMState (int Index)
int DM_FSMTransitionCount ()
IDM_FSMTransitionDM_FSMTransition (int Index)
INetItemDM_FSMClockPort ()
INetItemDM_FSMResetPort ()
bool DM_SmartLoad ()
int DM_SheetSizeX ()
int DM_SheetSizey ()
IDocumentDM_PhysicalDocument (int Index)
bool DM_SpatialAnalysis (bool Force, bool AllowAbort, bool AbortOnMouseMove)
std::wstring DM_DocumentID ()
bool DM_IsDocumentFileLessEditing ()
void DM_DocumentLoaded ()
Public Member Functions inherited from EDP::IDMObject
IParameterDM_Parameters (int Index)
int DM_ParameterCount ()
bool DM_IsInferredObject ()
int DM_LocationX ()
int DM_LocationY ()
int DM_GeneralField ()
std::wstring DM_LocationString ()
std::wstring DM_LongDescriptorString ()
std::wstring DM_ShortDescriptorString ()
std::wstring DM_ObjectKindString ()
std::wstring DM_ObjectKindStringForCrossProbe ()
std::wstring DM_PrimaryCrossProbeString ()
std::wstring DM_SecondaryCrossProbeString ()
std::wstring DM_FullCrossProbeString ()
int DM_ImageIndex ()
IDocumentDM_OwnerDocument ()
std::wstring DM_OwnerDocumentName ()
std::wstring DM_OwnerDocumentFullPath ()
int DM_CurrentSheetInstanceNumber ()
bool DM_ValidForNavigation ()
int DM_NetIndex_Flat ()
int DM_NetIndex_Sheet ()
int DM_NetIndex_SubNet ()
int DM_SheetIndex_Logical ()
int DM_SheetIndex_Physical ()
IVHDLEntityDM_VHDLEntity ()
IDispatch * DM_GetVCSProject ()
void DM_SetVCSProject (IDispatch *const Value)
bool DM_IsFormulaString (std::wstring AFormula)
std::wstring DM_CalculateParameterValue (IParameter *AParameter)
int DM_PCBObjectHandle ()
int DM_SCHObjectHandle ()
IDispatch * DM_PCBObjectInterface ()
IDispatch * DM_SCHObjectInterface ()
std::wstring DM_PcbHandle ()
std::wstring DM_SchHandle ()

Member Function Documentation

◆ DM_BlanketCount()

int EDP::IDocument::DM_BlanketCount ( )

◆ DM_Blankets()

IBlanket * EDP::IDocument::DM_Blankets ( int Index)

◆ DM_BusCount()

int EDP::IDocument::DM_BusCount ( )

◆ DM_Buses()

IBus * EDP::IDocument::DM_Buses ( int Index)

◆ DM_ChannelClassCount()

int EDP::IDocument::DM_ChannelClassCount ( )

◆ DM_ChannelClasses()

IChannelClass * EDP::IDocument::DM_ChannelClasses ( int Index)

◆ DM_ChannelIndex()

int EDP::IDocument::DM_ChannelIndex ( )

◆ DM_ChannelPrefix()

std::wstring EDP::IDocument::DM_ChannelPrefix ( )

◆ DM_ChannelRoomNamingStyle()

TChannelRoomNamingStyle EDP::IDocument::DM_ChannelRoomNamingStyle ( )

◆ DM_ChildDocumentCount()

int EDP::IDocument::DM_ChildDocumentCount ( )

◆ DM_ChildDocuments()

IDocument * EDP::IDocument::DM_ChildDocuments ( int Index)

◆ DM_Compile()

bool EDP::IDocument::DM_Compile ( )

◆ DM_ComponentClassCount()

int EDP::IDocument::DM_ComponentClassCount ( )

◆ DM_ComponentClasses()

IComponentClass * EDP::IDocument::DM_ComponentClasses ( int Index)

◆ DM_ComponentCount()

int EDP::IDocument::DM_ComponentCount ( )

◆ DM_Components()

IComponent * EDP::IDocument::DM_Components ( int Index)

◆ DM_ConstraintGroupCount()

int EDP::IDocument::DM_ConstraintGroupCount ( )

◆ DM_ConstraintGroups()

IConstraintGroup * EDP::IDocument::DM_ConstraintGroups ( int Index)

◆ DM_CreateViolation()

IViolation * EDP::IDocument::DM_CreateViolation ( TErrorKind AErrorKind,
std::wstring AErrorString )

◆ DM_CrossSheetConnectorCount()

int EDP::IDocument::DM_CrossSheetConnectorCount ( )

◆ DM_CrossSheetConnectors()

ICrossSheet * EDP::IDocument::DM_CrossSheetConnectors ( int Index)

◆ DM_CurrentInstanceNumber()

int EDP::IDocument::DM_CurrentInstanceNumber ( )

◆ DM_DifferentialPairCount()

int EDP::IDocument::DM_DifferentialPairCount ( )

◆ DM_DifferentialPairs()

IDifferentialPair * EDP::IDocument::DM_DifferentialPairs ( int Index)

◆ DM_DocumentID()

std::wstring EDP::IDocument::DM_DocumentID ( )

◆ DM_DocumentIsLoaded()

bool EDP::IDocument::DM_DocumentIsLoaded ( )

◆ DM_DocumentIsTextual()

bool EDP::IDocument::DM_DocumentIsTextual ( )

◆ DM_DocumentKind()

std::wstring EDP::IDocument::DM_DocumentKind ( )

◆ DM_DocumentLoaded()

void EDP::IDocument::DM_DocumentLoaded ( )

◆ DM_FileName()

std::wstring EDP::IDocument::DM_FileName ( )

◆ DM_FSMClockPort()

INetItem * EDP::IDocument::DM_FSMClockPort ( )

◆ DM_FSMResetPort()

INetItem * EDP::IDocument::DM_FSMResetPort ( )

◆ DM_FSMState()

IDM_FSMState * EDP::IDocument::DM_FSMState ( int Index)

◆ DM_FSMStateCount()

int EDP::IDocument::DM_FSMStateCount ( )

◆ DM_FSMTransition()

IDM_FSMTransition * EDP::IDocument::DM_FSMTransition ( int Index)

◆ DM_FSMTransitionCount()

int EDP::IDocument::DM_FSMTransitionCount ( )

◆ DM_FullPath()

std::wstring EDP::IDocument::DM_FullPath ( )

◆ DM_GetItemRevisionGUID()

std::wstring EDP::IDocument::DM_GetItemRevisionGUID ( )

◆ DM_HarnessConnectorCount()

int EDP::IDocument::DM_HarnessConnectorCount ( )

◆ DM_HarnessConnectors()

ISheetSymbol * EDP::IDocument::DM_HarnessConnectors ( int Index)

◆ DM_HarnessNetCount()

int EDP::IDocument::DM_HarnessNetCount ( )

◆ DM_HarnessNets()

INet * EDP::IDocument::DM_HarnessNets ( int Index)

◆ DM_IndentLevel()

int EDP::IDocument::DM_IndentLevel ( )

◆ DM_IsDocumentFileLessEditing()

bool EDP::IDocument::DM_IsDocumentFileLessEditing ( )

◆ DM_IsPhysicalDocument()

bool EDP::IDocument::DM_IsPhysicalDocument ( )

◆ DM_IsPrimaryImplementationDocument()

bool EDP::IDocument::DM_IsPrimaryImplementationDocument ( )

◆ DM_LoadDocument()

bool EDP::IDocument::DM_LoadDocument ( )

◆ DM_LogicalDocument()

IDocument * EDP::IDocument::DM_LogicalDocument ( )

◆ DM_ModelKind()

std::wstring EDP::IDocument::DM_ModelKind ( )

◆ DM_NeedsScrapCompile()

bool EDP::IDocument::DM_NeedsScrapCompile ( )

◆ DM_NetClassCount()

int EDP::IDocument::DM_NetClassCount ( )

◆ DM_NetClasses()

INetClass * EDP::IDocument::DM_NetClasses ( int Index)

◆ DM_NetCount()

int EDP::IDocument::DM_NetCount ( )

◆ DM_Nets()

INet * EDP::IDocument::DM_Nets ( int Index)

◆ DM_ParentDocumentCount()

int EDP::IDocument::DM_ParentDocumentCount ( )

◆ DM_ParentDocuments()

IDocument * EDP::IDocument::DM_ParentDocuments ( int Index)

◆ DM_ParentSheetSymbolCount()

int EDP::IDocument::DM_ParentSheetSymbolCount ( )

◆ DM_ParentSheetSymbols()

ISheetSymbol * EDP::IDocument::DM_ParentSheetSymbols ( int Index)

◆ DM_PartCount()

int EDP::IDocument::DM_PartCount ( )

◆ DM_Parts()

IPart * EDP::IDocument::DM_Parts ( int Index)

◆ DM_PhysicalDocument()

IDocument * EDP::IDocument::DM_PhysicalDocument ( int Index)

◆ DM_PhysicalDocumentCount()

int EDP::IDocument::DM_PhysicalDocumentCount ( )

◆ DM_PhysicalDocumentParent()

IDocument * EDP::IDocument::DM_PhysicalDocumentParent ( )

◆ DM_PhysicalInstanceName()

std::wstring EDP::IDocument::DM_PhysicalInstanceName ( )

◆ DM_PhysicalInstancePath()

std::wstring EDP::IDocument::DM_PhysicalInstancePath ( )

◆ DM_PhysicalRoomName()

std::wstring EDP::IDocument::DM_PhysicalRoomName ( )

◆ DM_PortCount()

int EDP::IDocument::DM_PortCount ( )

◆ DM_Ports()

INetItem * EDP::IDocument::DM_Ports ( int Index)

◆ DM_Project()

IProject * EDP::IDocument::DM_Project ( )

◆ DM_RoomCount()

int EDP::IDocument::DM_RoomCount ( )

◆ DM_Rooms()

IRoom * EDP::IDocument::DM_Rooms ( int Index)

◆ DM_RuleCount()

int EDP::IDocument::DM_RuleCount ( )

◆ DM_Rules()

IRule * EDP::IDocument::DM_Rules ( int Index)

◆ DM_ScrapCompile()

bool EDP::IDocument::DM_ScrapCompile ( bool ForceCompile)

◆ DM_ScrapCompileWithOptions()

bool EDP::IDocument::DM_ScrapCompileWithOptions ( bool ForceCompile,
std::wstring AOptions )

◆ DM_SetItemRevisionGUID()

void EDP::IDocument::DM_SetItemRevisionGUID ( std::wstring S)

◆ DM_SheetSizeX()

int EDP::IDocument::DM_SheetSizeX ( )

◆ DM_SheetSizey()

int EDP::IDocument::DM_SheetSizey ( )

◆ DM_SheetSymbolCount()

int EDP::IDocument::DM_SheetSymbolCount ( )

◆ DM_SheetSymbols()

ISheetSymbol * EDP::IDocument::DM_SheetSymbols ( int Index)

◆ DM_SignalManager()

ISignalManager * EDP::IDocument::DM_SignalManager ( )

◆ DM_SmartLoad()

bool EDP::IDocument::DM_SmartLoad ( )

◆ DM_SpatialAnalysis()

bool EDP::IDocument::DM_SpatialAnalysis ( bool Force,
bool AllowAbort,
bool AbortOnMouseMove )

◆ DM_SpatialAnalysisForTest()

int EDP::IDocument::DM_SpatialAnalysisForTest ( )

◆ DM_TextFrameCount()

int EDP::IDocument::DM_TextFrameCount ( )

◆ DM_TextFrames()

ITextFrame * EDP::IDocument::DM_TextFrames ( int Index)

◆ DM_UniqueComponentCount()

int EDP::IDocument::DM_UniqueComponentCount ( )

◆ DM_UniqueComponents()

IComponent * EDP::IDocument::DM_UniqueComponents ( int Index)

◆ DM_UniquePartCount()

int EDP::IDocument::DM_UniquePartCount ( )

◆ DM_UniqueParts()

IPart * EDP::IDocument::DM_UniqueParts ( int Index)

◆ DM_UpdateDateModified()

void EDP::IDocument::DM_UpdateDateModified ( )

◆ DM_VHDLEntities()

IVHDLEntity * EDP::IDocument::DM_VHDLEntities ( int Index)

◆ DM_VHDLEntityCount()

int EDP::IDocument::DM_VHDLEntityCount ( )

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