Public Member Functions
InputPort Class Reference

Detailed Description

An InputPort object represents an input port of an Operator.

See also:
Port, OutputPort, Operator

#include <xsi_inputport.h>

Inheritance diagram for InputPort:
Inheritance graph
[legend]

List of all members.

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

Constructor & Destructor Documentation

InputPort ( )

Default constructor.

~InputPort ( )

Default destructor.

InputPort ( const CRef in_ref )

Constructor.

Parameters:
in_ref constant reference object.
InputPort ( const InputPort in_obj )

Copy constructor.

Parameters:
in_obj constant class object.

Member Function Documentation

bool IsA ( siClassID  in_ClassID ) const [virtual]

Returns true if a given class type is compatible with this API class.

Parameters:
in_ClassID class type.
Returns:
true if the class is compatible, false otherwise.

Reimplemented from Port.

siClassID GetClassID ( ) const [virtual]

Returns the type of the API class.

Returns:
The class type.

Reimplemented from Port.

InputPort& operator= ( const InputPort in_obj )

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:
in_obj constant class object.
Returns:
The new InputPort object.
InputPort& operator= ( const CRef in_ref )

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:
in_ref constant class object.
Returns:
The new InputPort 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.

Returns:
The current 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.

Returns:
true if the port is optional
Since:
4.0

The documentation for this class was generated from the following file: