Related Scripting Object: InputPort
An InputPort object represents an input port of an Operator. More...
#include <xsi_inputport.h>
Inheritance diagram for InputPort:
Public Member Functions |
|
| InputPort () | |
| ~InputPort () | |
| InputPort (const CRef &in_ref) | |
| InputPort (const InputPort &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| InputPort & | operator= (const InputPort &in_obj) |
| InputPort & | operator= (const CRef &in_ref) |
| CValue | GetValue () const |
| bool | GetOptional () const |
| InputPort | ( | ) |
Default constructor.
| ~InputPort | ( | ) |
Default destructor.
Constructor.
| in_ref | constant reference object. |
Copy constructor.
| in_obj | constant class object. |
| 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 Port.
| siClassID GetClassID | ( | ) | const [virtual] |
Returns the type of the API class.
Reimplemented from Port.
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 Port.
| CValue GetValue | ( | ) | const |
Returns the current value of the data attached to the port. This function can only be called from within a custom operator's Update() callback; if called outside of a custom operator it returns an empty value.
Empty if the port is not connected or if the function failed.
| bool GetOptional | ( | ) | const |
Returns true if the connection of target to port is optional, true otherwise.