Sage Modeling and Simulation Library

OutputPortProxy Members

The OutputPortProxy type exposes the following members.

Constructors


  Name Description
Public method OutputPortProxy
Initializes a new instance of the OutputPortProxy class.

Methods


  Name Description
Public method DetachHandlers
Detaches this output port's data peek and take handler.
Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method GetOutOfBandData()()()()
Returns the default out-of-band data from this port. Out-of-band data is data that is not material that is to be transferred out of, or into, this port, but rather context, type, or other metadata to the transfer itself.
Public method GetOutOfBandData(Object)
Returns out-of-band data from this port. Out-of-band data is data that is not material that is to be transferred out of, or into, this port, but rather context, type, or other metadata to the transfer itself.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method InitializeIdentity
Initializes the fields that feed the properties of this IModelObject identity.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Peek
Nonconsumptively returns the contents of this port. A subsequent Take may or may not produce the same object, if, for example, the stuff produced from this port is time-sensitive.
Public method Take
This method removes and returns the current contents of the port.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)

Properties


  Name Description
Public property Connector
This property represents the connector object that this port is associated with.
Public property Description
The description for this object. Typically used for human-readable representations.
Public property Guid
The Guid for this object. Typically required to be unique in a pan-model context.
Public property Index
The port index represents its sequence, if any, with respect to the other ports.
Public property Intrinsic
Gets and sets a value indicating whether this IPort is intrinsic. An intrinsic port is a hard-wired part of its owner. It is there when its owner is created, and cannot be removed.
Public property IsPeekable
True if Peek can be expected to return meaningful data.
Public property Key
Returns the key by which this port is known to its owner.
Public property Model
The IModel to which this object belongs.
Public property Name
The name by which this object is known. Typically not required to be unique in a pan-model context.
Public property Owner
This property contains the owner of the port.
Public property PeekHandler
This sets the DataProvisionHandler that this port will use to handle requests to peek at data on this port, replacing the current one. This should be used only by objects under the control of, or owned by, the IPortOwner that owns this port.
Public property Peer
This property returns the port at the other end of the connector to which this port is connected, or null, if there is no connector, and/or no port on the other end of a connected connector.
Public property TakeHandler
This sets the DataProvisionHandler that this port will use to handle requests to take data from this port, replacing the current one. This should be used only by objects under the control of, or owned by, the IPortOwner that owns this port.

Events


  Name Description
Public event AfterConnectionBroken
This event fires immediately after the port's connector property becomes null.
Public event AfterConnectionMade
This event fires immediately after the port's connector property becomes non-null.
Public event BeforeConnectionBroken
This event fires immediately before the port's connector property becomes null.
Public event BeforeConnectionMade
This event fires immediately before the port's connector property becomes non-null.
Public event DataAvailable
This event fires when data has been made available on this port.
Public event PortDataAccepted
This event fires when data is accepted by a port. For an input port, this implies acceptance by the port owner, and for an output port, it implies acceptance by an outsider.
Public event PortDataPresented
This event fires when data is presented on a port. For an input port, this implies presentation by an outsider, and for an output port, it implies presentation by the port owner.
Public event PortDataRejected
This event fires when data is rejected by a port. For an input port, this implies rejection by the port owner, and for an output port, it implies rejection by an outsider.