A port is an input or output connection to another object.
Actually, a port is more like a connection point on an operator, which may or may not be actually connected to something (some operator ports are optional).
Use SIObject::GetName to get the name of this port.
#include <xsi_port.h>
Public Member Functions | |
Port () | |
~Port () | |
Port (const CRef &in_ref) | |
Port (const Port &in_obj) | |
bool | IsA (siClassID in_ClassID) const |
siClassID | GetClassID () const |
Port & | operator= (const Port &in_obj) |
Port & | operator= (const CRef &in_ref) |
bool | IsConnected () const |
LONG | GetIndex () const |
siPortType | GetPortType () const |
CRef | GetTarget (void) const |
LONG | GetGroupIndex (void) const |
CString | GetGroupName (void) const |
LONG | GetGroupInstance (void) const |
siPortFlags | GetFlags (void) const |
bool | GetBranchGroup () const |
CString | GetTargetPath () const |
Port | ( | ) |
Default constructor.
~Port | ( | ) |
Default destructor.
bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if a given class type is compatible with this API class.
in_ClassID | class type. |
Reimplemented from SIObject.
Reimplemented in InputPort, and OutputPort.
siClassID GetClassID | ( | ) | const [virtual] |
Returns the type of the API class.
Reimplemented from SIObject.
Reimplemented in InputPort, and OutputPort.
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
in_obj | constant class object. |
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
in_ref | constant class object. |
Reimplemented from SIObject.
Reimplemented in InputPort, and OutputPort.
bool IsConnected | ( | ) | const |
Returns true if the port is connected, false otherwise
LONG GetIndex | ( | ) | const |
Returns the port index of this port as a LONG
within its port group or -1 if there is a failure.
siPortType GetPortType | ( | ) | const |
Returns the type of the port, input or output.
CRef GetTarget | ( | void | ) | const |
Returns a reference object for the object connected to the port. If this function is called from the Update() context of a custom operator it will return an empty CRef.
out_pTarget | the object to which the port is connected. |
LONG GetGroupIndex | ( | void | ) | const |
Returns the index of the port group to which the port belongs.
CString GetGroupName | ( | void | ) | const |
Returns the name of the port group to which the port belongs.
LONG GetGroupInstance | ( | void | ) | const |
Returns the port group instance index for the port. There may be many objects of the same type connected to the same port group. Each object is connected to a port group instance, and within the port group instance there may be many ports.
siPortFlags GetFlags | ( | void | ) | const |
Returns the mask of port flags described in siPortFlags.
bool GetBranchGroup | ( | ) | const |
Returns true if the port supports branch and group connections.
CString GetTargetPath | ( | ) | const |
Returns a string containing the path to the target object.