Skip to content

OutputAssignODs

Type ISIAPIOutputAssignODs · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 7C1C70A0-EAAB-4F7C-9E66-28FDD8329227

OutputAssignOD wrapper collection interface

Declaration

[Guid("7C1C70A0-EAAB-4F7C-9E66-28FDD8329227")]
public interface ISIAPIOutputAssignODs

Members

Properties

Property Type Summary
Count int Gets the number of Assign OD Output objects contained in the collection.
this[] ISIAPIOutputAssignOD Get an Assign OD Output object by the Origin Zone ID and the Destination Zone ID showed in the Assign Volume Bin O-D Volumes dialog.
this[] ISIAPIOutputAssignOD Get an Assign OD Output object at the specified index.

Methods

Method Returns Summary
OutputAssignODExists(string, string) bool Queries whether a particular Assign OD Output exists in the collection

Properties

Count

Gets the number of Assign OD Output objects contained in the collection.

int Count { get; }

Type int

Code samples
int count = outputAssignODs.Count;
long count;
outputAssignODs->get_Count(&count);
count = outputAssignODs.Count

this[]

Get an Assign OD Output object by the Origin Zone ID and the Destination Zone ID showed in the Assign Volume Bin O-D Volumes dialog.

ISIAPIOutputAssignOD this[] { get; }

Type ISIAPIOutputAssignOD - Return the Assign OD Output object if it exists in the data storage; otherwise, null/Nothing.

Code samples
var this[] = outputAssignODs.this[];
CComPtr<ISIAPIOutputAssignOD> this[];
outputAssignODs->get_this[](&this[]);
this[] = outputAssignODs.this[]

this[]

Get an Assign OD Output object at the specified index.

ISIAPIOutputAssignOD this[] { get; }

Type ISIAPIOutputAssignOD

Code samples
var this[] = outputAssignODs.this[];
CComPtr<ISIAPIOutputAssignOD> this[];
outputAssignODs->get_this[](&this[]);
this[] = outputAssignODs.this[]

Methods

OutputAssignODExists(string, string)

Queries whether a particular Assign OD Output exists in the collection

bool OutputAssignODExists(string originID, string destinationID)

Parameters

Name Type Description
originID string Type: System.String; Origin Zone's ID showed in the Assign Volume Bin O-D Volumes dialog.
destinationID string Type: System.String; Destination Zone's ID showed in the Assign Volume Bin O-D Volumes dialog.

Returns bool - true if it exists in the data storage; otherwise, false

Code samples
bool result = outputAssignODs.OutputAssignODExists(@"id-1", @"id-1");
VARIANT_BOOL result;
outputAssignODs->OutputAssignODExists(CComBSTR(L"id-1"), CComBSTR(L"id-1"), &result);
result = outputAssignODs.OutputAssignODExists(r"id-1", r"id-1")