Sage Modeling and Simulation Library

SimpleInputPort Members

The SimpleInputPort type exposes the following members.

Constructors


  Name Description
Public method SimpleInputPort
Creates a simple input port with a specified owner and handler to be called when data arrives on the port. If the handler is null, then an internal handler is used that, in effect, refuses delivery of the data. It is the responsibility of the creator to add the port to the owner's PortSet.

Methods


  Name Description
Protected method DetachedPortInUse (Inherited from GenericPort.)
Public method DetachHandlers
Detaches this input port's data arrival 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.
(Inherited from GenericPort.)
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.
(Inherited from GenericPort.)
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.
(Inherited from GenericPort.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method NotifyDataAvailable
Called by the peer output port to let the input port know that data is available on the output port, in case the input port wants to pull that data.
Protected method OnAcceptingData
Handler for the acceptance of data. For an output port, this will be the port accepting data from the port owner, and for an input port, it will be the port's peer accepting data offered through the connector by this port.
(Inherited from GenericPort.)
Protected method OnPresentingData
Handler for arrival of data. For an output port, this will be the PortOwner presenting data to the port, for an input port, it will be the IPort's peer presenting data through the connector.
(Inherited from GenericPort.)
Protected method OnRejectingData
Handler for the acceptance of data. For an output port, this will be the port accepting data from the port owner, and for an input port, it will be the port's peer accepting data offered through the connector by this port.
(Inherited from GenericPort.)
Public method OwnerPeek
The port owner can use this API to look at, but not remove, what is on the upstream port.
Public method OwnerTake
The owner of an Input Port uses this to remove an object from the port.
Public method Put
Called by this port's peer when it is pushing data to this port.
Public method SetDefaultOutOfBandData
Sets the default out-of-band data.
(Inherited from GenericPort.)
Public method SetOutOfBandData
Sets an out-of-band data item based on its key.
(Inherited from GenericPort.)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)

Properties


  Name Description
Public property Connector
The connector, if any, to which this port is attached. If there is already a connector, then the setter is allowed to set Connector to <null>. Thereafter, the setter will be permitted to set the connector to a new value. This is to prevent accidentally overwriting a connection in code.
(Inherited from GenericPort.)
Public property Description
The description for this object. Typically used for human-readable representations.
(Inherited from GenericPort.)
Public property Guid
The Guid for this object. Typically required to be unique.
(Inherited from GenericPort.)
Public property Index
The port index represents its sequence, if any, with respect to the other ports.
(Inherited from GenericPort.)
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.
(Inherited from GenericPort.)
Public property Key
Returns the key by which this port is known to its owner.
(Inherited from GenericPort.)
Public property Model
The model that owns this object, or from which this object gets time, etc. data.
(Inherited from GenericPort.)
Public property Name
The user-friendly name for this object.
(Inherited from GenericPort.)
Public property Owner
This port's owner.
(Inherited from GenericPort.)
Public property Peer
Returns the peer of this port. A port's peer is the port that is at the other end of the connector to which this port is attached, or null if there is no attached conenctor or if there is no port on the other end.
(Inherited from GenericPort.)
Protected property PortPrefix
Gets the default naming prefix for all ports of this type.
Public property PutHandler
This sets the DataArrivalHandler that this port will use, 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.
(Inherited from GenericPort.)
Public event AfterConnectionMade
This event fires immediately after the port's connector property becomes non-null.
(Inherited from GenericPort.)
Public event BeforeConnectionBroken
This event fires immediately before the port's connector property becomes null.
(Inherited from GenericPort.)
Public event BeforeConnectionMade
This event fires immediately before the port's connector property becomes non-null.
(Inherited from GenericPort.)
Public event DataAvailable
This event is fired when new data is available to be taken from a port.
Public event PortDataAccepted
This event fires when data is accepted by a port. For an input port, this implies acceptance by an outsider, and for an output port, it implies acceptance by the port owner.
(Inherited from GenericPort.)
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.
(Inherited from GenericPort.)
Public event PortDataRejected
This event fires when data is rejected by a port. For an input port, this implies rejection by an outsider, and for an output port, it implies rejection by the port owner.
(Inherited from GenericPort.)