Sage Modeling and Simulation Library

Highpoint.Sage.ItemBased.Ports Namespace

Classes


  Class Description
Public class GeneralPortChannelInfo
Public class GenericPort
Base class implementation for ports.
Public class InputPortManager
Public class InputPortProxy
Class InputPortProxy is a class that represents to an outer container the functionality of an input port on an internal port owner. This can be used to expose the externally-visible ports from a network of blocks that is being represented as one container-level block.
Public class OutputPortManager
Public class OutputPortProxy
Class OutputPortProxy is a class that represents to an outer container the functionality of a port on an internal port owner. This can be used to expose the externally-visible ports from a network of blocks that is being represented as one container-level block.
Public class PortManagementFacade
Class PortManagementFacade provides one object from which the managers for all of a group of ports owned by one owner can be obtained. It is a convenience class.
Public class PortManager
Class PortManager is an abstract class that sets up some of the basic functionality of both input port managers and output port managers.
Public class PortSet
Contains and provides IPort objects based on keys. PortOwner objects (those which implement IPortOwner) will typically (though not necessarily) contain one of these.
Public class SimpleInputPort
A simple implementation of input port. A data arrival handler may be defined to react to data that has been pushed from its peer - if none is provided, then it cannot accept pushed data, (i.e. can only pull data from its peer at the request of its owner.)
Public class SimpleOutputPort
A simple implementation of output port. A data provision handler may be defined to react to a data take request from its peer - if none is provided, then it cannot accept a data take request, (i.e. it can only provide data as a push, driven by the port owner.) A similar handler, with the same conditions, is provided for handling a 'peek' request. If no data provision handler has been provided, either request will return null.

Interfaces


  Interface Description
Public interface IInputPort
IInputPort is the portion of an InputPort that is intended to be visible and accessible from outside the scope of its owner.
Public interface IOutputPort
IOutputPort is the portion of an output port that is intended to be visible and accessible from outside the scope of its owner.
Public interface IPort
This interface specifies the methods common to all types of ports, that are visible to objects other than the owner of the port.
Public interface IPortChannelInfo
Interface IPortChannelInfo specifies information about what travels on the port, and in what direction. Examples might be "Input" or "Output", or maybe "Control", "Kanban", etc.
Public interface IPortEvents
An interface describing the events that are fired by all IPort objects.
Public interface IPortOwner
Interface implemented by any object that exposes ports.
Public interface IPortSelector
This interface is implemented by any object that can choose ports. It is useful in constructing an autonomous route navigator, route strategy object, or transportation manager.
Public interface IPortSet
An interface implemented by a PortSet. Permits indexing to a port by key.

Delegates


  Delegate Description
Public delegate DataArrivalHandler
Implemented by a method designed to respond to the arrival of data on a port.
Public delegate DataProvisionHandler
Implemented by a method designed to provide data on an external entity's requesting it from a port.
Public delegate PortDataEvent
This is implemented by a method that will be paying attention to a port. PortData events include those occurring when data is presented to a port, accepted by a port, or rejected by a port.
Public delegate PortEvent
This is the signature of a listener to a port. PortEvents are fired when data becomes available on a port, when a port has just been pulled from or pushed to, or when someone has tried to pull from an empty port.
Public delegate PortSelector
This delegate receives the object passed in on a port and the set of choices to which it can be passed.

Enumerations


  Enumeration Description
Public enumeration InputPortManager..::..DataReadSource
Public enumeration InputPortManager..::..DataWriteAction
Public enumeration PortDirection
Public enumeration PortManager..::..BufferPersistence
Types of buffer persistence. How long the data is buffered for the port.