:py:mod:`vspyx.Exporter` ======================== .. py:module:: vspyx.Exporter Package Contents ---------------- Classes ~~~~~~~ .. autoapisummary:: vspyx.Exporter.AddQueueSubscriber vspyx.Exporter.CSVOutputFormat vspyx.Exporter.DataFile vspyx.Exporter.DataFileComparator vspyx.Exporter.DataProcessor vspyx.Exporter.DataQueue vspyx.Exporter.DefaultComparator vspyx.Exporter.EmptyQueueSubscriber vspyx.Exporter.FileSelectionQueueModifier vspyx.Exporter.FilesystemQueueModifier vspyx.Exporter.MDFOutputFormat vspyx.Exporter.Module vspyx.Exporter.OneshotQueueModifier vspyx.Exporter.OutputFormat vspyx.Exporter.PersistentQueueModifier vspyx.Exporter.PollingQueueModifier vspyx.Exporter.QueueManager vspyx.Exporter.QueueModifier vspyx.Exporter.RemoveQueueSubscriber vspyx.Exporter.ScriptQueueModifier vspyx.Exporter.UploadedQueueModifier vspyx.Exporter.VSAComparator .. py:class:: AddQueueSubscriber AddQueueSubscriber .. py:attribute:: OnAddDataFile :annotation: :vspyx.Core.Callback_abb7f0dc96 .. py:class:: CSVOutputFormat Bases: :py:obj:`OutputFormat` .. autoapi-inheritance-diagram:: vspyx.Exporter.CSVOutputFormat :parts: 1 :private-bases: CSVOutputFormat .. py:class:: DataFile DataFile .. py:class:: NetType Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.Exporter.DataFile.NetType :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: Cellular :annotation: = 2 .. py:attribute:: Ethernet :annotation: = 6 .. py:attribute:: WiFi :annotation: = 4 .. py:class:: Type Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.Exporter.DataFile.Type :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: Persistent :annotation: = 2 .. py:attribute:: Script :annotation: = 1 .. py:attribute:: VSA :annotation: = 0 .. py:attribute:: Path :annotation: :str .. py:attribute:: Primary :annotation: :int .. py:attribute:: Secondary :annotation: :int .. py:method:: AddNetType(self, netType: DataFile.NetType) -> Any .. py:method:: GetType(self) -> DataFile.Type .. py:method:: HasNetType(self, netType: DataFile.NetType) -> bool .. py:method:: __eq__(self, rhs: DataFile) -> bool Return self==value. .. py:method:: assign(self, arg0: DataFile) -> DataFile .. py:class:: DataFileComparator DataFileComparator .. py:method:: __call__(self, fileA: DataFile, fileB: DataFile) -> bool .. py:method:: assign(self, arg0: DataFileComparator) -> DataFileComparator .. py:class:: DataProcessor DataProcessor .. py:attribute:: ProcessTask :annotation: :vspyx.Core.Task_a3295bec43 .. py:class:: DataQueue DataQueue .. py:attribute:: AllPaths :annotation: :List[str] .. py:method:: Add(self, file: DataFile) -> Any .. py:method:: GetNext(self) -> DataFile GetNext(self, netType: DataFile.NetType) -> DataFile .. py:method:: HasFile(self, file: DataFile) -> bool .. py:method:: Remove(self, file: DataFile) -> bool .. py:method:: Size(self) -> int .. py:method:: assign(self, arg0: DataQueue) -> DataQueue .. py:class:: DefaultComparator Bases: :py:obj:`DataFileComparator` .. autoapi-inheritance-diagram:: vspyx.Exporter.DefaultComparator :parts: 1 :private-bases: DefaultComparator .. py:method:: __call__(self, fileA: DataFile, fileB: DataFile) -> bool .. py:class:: EmptyQueueSubscriber EmptyQueueSubscriber .. py:attribute:: OnEmptyQueue :annotation: :vspyx.Core.Callback_634bd5c449 .. py:class:: FileSelectionQueueModifier Bases: :py:obj:`OneshotQueueModifier` .. autoapi-inheritance-diagram:: vspyx.Exporter.FileSelectionQueueModifier :parts: 1 :private-bases: FileSelectionQueueModifier .. py:class:: FilesystemQueueModifier Bases: :py:obj:`PollingQueueModifier` .. autoapi-inheritance-diagram:: vspyx.Exporter.FilesystemQueueModifier :parts: 1 :private-bases: FilesystemQueueModifier .. py:class:: MDFOutputFormat Bases: :py:obj:`OutputFormat` .. autoapi-inheritance-diagram:: vspyx.Exporter.MDFOutputFormat :parts: 1 :private-bases: MDFOutputFormat .. py:class:: Module Bases: :py:obj:`vspyx.Core.Module` .. autoapi-inheritance-diagram:: vspyx.Exporter.Module :parts: 1 :private-bases: Module .. py:method:: Export(self, bufferPath: str, databasePaths: List[str], output: OutputFormat) -> bool Export(self, bufferPath: str, databasePaths: List[str], output: OutputFormat, connectionsConfigPath: str) -> bool Export(self, bufferPath: str, databasePaths: List[str], outputPath: str) -> bool Export(self, bufferPath: str, databasePaths: List[str], outputPath: str, connectionsConfigPath: str) -> bool .. py:class:: OneshotQueueModifier Bases: :py:obj:`QueueModifier` .. autoapi-inheritance-diagram:: vspyx.Exporter.OneshotQueueModifier :parts: 1 :private-bases: OneshotQueueModifier .. py:method:: Execute(self) -> Any .. py:class:: OutputFormat Bases: :py:obj:`vspyx.Core.Object` .. autoapi-inheritance-diagram:: vspyx.Exporter.OutputFormat :parts: 1 :private-bases: OutputFormat .. py:class:: Stage Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.Exporter.OutputFormat.Stage :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: AfterPreProcess :annotation: = 1 .. py:attribute:: AfterProcess :annotation: = 3 .. py:attribute:: BeforePreProcess :annotation: = 0 .. py:attribute:: BeforeProcess :annotation: = 2 .. py:method:: NeedsPreProcess(self) -> bool .. py:method:: OnStage(self, environment: vspyx.Runtime.Environment, scheduler: vspyx.Runtime.Scheduler, stage: OutputFormat.Stage) -> Any .. py:method:: PreProcess(self, point: vspyx.Runtime.Point, progress: float) -> Any .. py:method:: Process(self, point: vspyx.Runtime.Point, progress: float) -> Any .. py:class:: PersistentQueueModifier Bases: :py:obj:`OneshotQueueModifier` .. autoapi-inheritance-diagram:: vspyx.Exporter.PersistentQueueModifier :parts: 1 :private-bases: PersistentQueueModifier .. py:class:: PollingQueueModifier Bases: :py:obj:`QueueModifier` .. autoapi-inheritance-diagram:: vspyx.Exporter.PollingQueueModifier :parts: 1 :private-bases: PollingQueueModifier .. py:method:: Start(self) -> Any .. py:method:: Stop(self) -> Any .. py:class:: QueueManager QueueManager .. py:attribute:: AllPaths :annotation: :List[str] .. py:method:: GetNext(self) -> DataFile GetNext(self, type: DataFile.NetType) -> DataFile .. py:method:: Size(self) -> int .. py:method:: Start(self) -> Any .. py:method:: Stop(self) -> Any .. py:method:: assign(self, arg0: QueueManager) -> QueueManager .. py:class:: QueueModifier QueueModifier .. py:attribute:: OnAddDataFile :annotation: :vspyx.Core.Callback_abb7f0dc96 .. py:attribute:: OnRemoveDataFile :annotation: :vspyx.Core.Callback_abb7f0dc96 .. py:class:: RemoveQueueSubscriber RemoveQueueSubscriber .. py:attribute:: OnRemoveDataFile :annotation: :vspyx.Core.Callback_abb7f0dc96 .. py:class:: ScriptQueueModifier Bases: :py:obj:`OneshotQueueModifier` .. autoapi-inheritance-diagram:: vspyx.Exporter.ScriptQueueModifier :parts: 1 :private-bases: ScriptQueueModifier .. py:class:: UploadedQueueModifier Bases: :py:obj:`OneshotQueueModifier` .. autoapi-inheritance-diagram:: vspyx.Exporter.UploadedQueueModifier :parts: 1 :private-bases: UploadedQueueModifier .. py:class:: VSAComparator Bases: :py:obj:`DataFileComparator` .. autoapi-inheritance-diagram:: vspyx.Exporter.VSAComparator :parts: 1 :private-bases: VSAComparator .. py:method:: __call__(self, fileA: DataFile, fileB: DataFile) -> bool