Vuo  1.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
VuoCompilerPublishedPortClass Class Reference

Description

A published port type.

Public Member Functions

 VuoCompilerPublishedPortClass (string name, VuoPortClass::PortType portType, Type *type)
 Creates a published port type.
 
VuoCompilerPortnewPort (void)
 Creates a new port based on this port type, and creates its corresponding base VuoPort.
 
VuoCompilerPortnewPort (VuoPort *port)
 Creates a new port based on this port type, using the pre-existing port as its base.
 
VuoTypegetDataVuoType (void)
 Returns the type of data carried by this port, or null if this port is event-only.
 
void setDataVuoType (VuoType *type)
 Sets the type of the data carried by this port.
 
string getDisplayName (void)
 Returns the port class's display name.
 
void setDetail (string key, string value)
 Sets the value of a detail for this published port.
 
void unsetDetail (string key)
 Unsets the value of a detail for this published port.
 
- Public Member Functions inherited from VuoCompilerPortClass
 ~VuoCompilerPortClass (void)
 Destructor.
 
void setDetails (struct json_object *details)
 Sets details for this port.
 
json_objectgetDetails (void)
 Returns details for this port, set in setDetails().
 
- Public Member Functions inherited from VuoCompilerNodeArgumentClass
virtual ~VuoCompilerNodeArgumentClass (void)
 to make this class dynamic_cast-able
 
virtual Type * getType (void)
 Returns the type of this argument.
 
bool isInEventFunction (void)
 Returns true if this is known to be one of the parameters in its node class's event function.
 
size_t getIndexInEventFunction (void)
 Returns the index of this port's parameter in its node class's event function.
 
void setIndexInEventFunction (size_t indexInEventFunction)
 Indicates that this is the parameter at index indexInEventFunction in its node class's event function.
 
bool isInInitFunction (void)
 Returns true if this is known to be one of the parameters in its node class's init function.
 
size_t getIndexInInitFunction (void)
 Returns the index of this port's parameter in its node class's init function.
 
void setIndexInInitFunction (size_t indexInInitFunction)
 Indicates that this is the parameter at index indexInInitFunction in its node class's init function.
 
bool isInCallbackStartFunction (void)
 Returns true if this is known to be one of the parameters in its node class's callback start function.
 
size_t getIndexInCallbackStartFunction (void)
 Returns the index of this port's parameter in its node class's callback start function.
 
void setIndexInCallbackStartFunction (size_t indexInCallbackStartFunction)
 Indicates that this is the parameter at index indexInCallbackStartFunction in its node class's callback start function.
 
bool isInCallbackUpdateFunction (void)
 Returns true if this is known to be one of the parameters in its node class's callback update function.
 
size_t getIndexInCallbackUpdateFunction (void)
 Returns the index of this port's parameter in its node class's callback update function.
 
void setIndexInCallbackUpdateFunction (size_t indexInCallbackUpdateFunction)
 Indicates that this is the parameter at index indexInCallbackUpdateFunction in its node class's callback update function.
 
bool isInCallbackStopFunction (void)
 Returns true if this is known to be one of the parameters in its node class's callback stop function.
 
size_t getIndexInCallbackStopFunction (void)
 Returns the index of this port's parameter in its node class's callback stop function.
 
void setIndexInCallbackStopFunction (size_t indexInCallbackStopFunction)
 Indicates that this is the parameter at index indexInCallbackStopFunction in its node class's callback stop function.
 
- Public Member Functions inherited from VuoBaseDetail< VuoPortClass >
 VuoBaseDetail (string description, VuoPortClass *base)
 Creates a VuoPortClass detail class.
 
VuoPortClassgetBase (void) const
 Returns the VuoPortClass detail class instance's base class instance.
 
void setBase (VuoPortClass *base)
 Sets the VuoPortClass detail class instance's base class instance.
 

Additional Inherited Members

- Protected Member Functions inherited from VuoCompilerPortClass
 VuoCompilerPortClass (string name, VuoPortClass::PortType portType, Type *type)
 Creates a port type and creates its corresponding base VuoPortClass.
 
- Protected Attributes inherited from VuoCompilerPortClass
struct json_objectdetails
 Metadata specified in the node class implementation, such as the port's display name.
 

Constructor & Destructor Documentation

VuoCompilerPublishedPortClass::VuoCompilerPublishedPortClass ( string  name,
VuoPortClass::PortType  portType,
Type *  type 
)

Creates a published port type.

Member Function Documentation

VuoType * VuoCompilerPublishedPortClass::getDataVuoType ( void  )
virtual

Returns the type of data carried by this port, or null if this port is event-only.

Implements VuoCompilerPortClass.

string VuoCompilerPublishedPortClass::getDisplayName ( void  )
virtual

Returns the port class's display name.

Reimplemented from VuoCompilerPortClass.

VuoCompilerPort * VuoCompilerPublishedPortClass::newPort ( void  )
virtual

Creates a new port based on this port type, and creates its corresponding base VuoPort.

Implements VuoCompilerPortClass.

VuoCompilerPort * VuoCompilerPublishedPortClass::newPort ( VuoPort port)
virtual

Creates a new port based on this port type, using the pre-existing port as its base.

Implements VuoCompilerPortClass.

void VuoCompilerPublishedPortClass::setDataVuoType ( VuoType type)
virtual

Sets the type of the data carried by this port.

Assumes this port is not event-only.

Implements VuoCompilerPortClass.

void VuoCompilerPublishedPortClass::setDetail ( string  key,
string  value 
)

Sets the value of a detail for this published port.

The previous detail value for key (if any) is replaced by value.

void VuoCompilerPublishedPortClass::unsetDetail ( string  key)

Unsets the value of a detail for this published port.

The previous detail value for key (if any) is removed.


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