Description

The compiler detail class for VuoPublishedPort.

Definition at line 19 of file VuoCompilerPublishedPort.hh.

Public Member Functions
	VuoCompilerPublishedPort (VuoPort *basePort)
	Creates a published port that is not connected to any port in a running composition. More...

string	getIdentifier (void)
	Returns a unique, consistent identifier for this port. More...

void	setInitialValue (string initialValueAsString)
	Sets the initial value of the port data. More...

string	getInitialValue (void)
	Returns the string representation of the initial value of the port data. More...

json_object *	getDetails (bool isInput)
	Returns details for this published port, such as "suggestedMin". More...

string	getGraphvizAttributes (void)
	Returns a string representation of this published port's type and details, as they would appear in the attributes list of a published node declaration within a .vuo (Graphviz DOT format) file. More...

Value *	generateCreatePortContext (Module module, BasicBlock block)
	Returns null, since VuoCompilerPort::generateCreatePortContext() doesn't mean anything for published ports. More...

Public Member Functions inherited from VuoCompilerPort
bool	hasConnectedCable (void) const
	Returns a boolean indicating whether this port has any attached cables. More...

bool	hasConnectedDataCable (void) const
	Returns a boolean indicating whether this port has any attached data+event cables. More...

VuoType *	getDataVuoType (void)
	Returns this port's data type, or null if this port is event-only. More...

void	setDataVuoType (VuoType *dataType)
	Sets the data type for this port, overriding the type from the port class. More...

void	setNodeIdentifier (string nodeIdentifier)
	Sets an identifier that will be part of the string returned by getIdentifier(). More...

void	setIndexInPortContexts (int indexInPortContexts)
	Sets the index of this node within the array of port contexts within the node context. More...

int	getIndexInPortContexts (void)
	Returns the index of this node within the array of port contexts within the node context. More...

void	setConstantsCache (VuoCompilerConstantsCache *constantsCache)
	Sets the cache used to generate constant string values. More...

Value *	getDataVariable (Module module, BasicBlock block, Value *nodeContextValue)
	Returns the address of the `data` field within this port's context. More...

Value *	generateGetPortContext (Module module, BasicBlock block, Value *nodeContextValue)
	Returns this port's context. More...

Public Member Functions inherited from VuoCompilerNodeArgument
virtual	~VuoCompilerNodeArgument (void)
	Destructor. More...

Public Member Functions inherited from VuoBaseDetail< VuoPort >
	VuoBaseDetail (string description, VuoPort *base)
	Creates a detail class. More...

VuoPort *	getBase (void) const
	Returns the detail class instance's base class instance. More...

void	setBase (VuoPort *base)
	Sets the detail class instance's base class instance. More...

Static Public Member Functions
static VuoCompilerPublishedPort *	newPort (string name, VuoType *type)
	Creates a VuoCompilerPublishedPort along with its VuoCompilerPublishedPortClass. More...

Additional Inherited Members
Protected Member Functions inherited from VuoCompilerPort
	VuoCompilerPort (VuoPort *basePort)
	Creates a compiler detail from a given `basePort`. More...

Protected Member Functions inherited from VuoCompilerNodeArgument
	VuoCompilerNodeArgument (VuoPort *basePort)
	Creates an argument instance based on the specified `argumentClass`. More...

Protected Attributes inherited from VuoCompilerPort
VuoCompilerConstantsCache *	constantsCache
	Cache used to generate constant string values. More...

Constructor & Destructor Documentation

◆ VuoCompilerPublishedPort()

VuoCompilerPublishedPort::VuoCompilerPublishedPort ( VuoPort * basePort )

Creates a published port that is not connected to any port in a running composition.

Definition at line 37 of file VuoCompilerPublishedPort.cc.

Member Function Documentation

◆ generateCreatePortContext()

Value * VuoCompilerPublishedPort::generateCreatePortContext	(	Module *	module,
		BasicBlock *	block
	)

virtual

Returns null, since VuoCompilerPort::generateCreatePortContext() doesn't mean anything for published ports.

Implements VuoCompilerPort.

Definition at line 382 of file VuoCompilerPublishedPort.cc.

◆ getDetails()

json_object * VuoCompilerPublishedPort::getDetails ( bool isInput )

Returns details for this published port, such as "suggestedMin".

If the detail was set by a call to setDetail(), then that value is used. Otherwise, the detail's value is coalesced across all connected ports.

Definition at line 80 of file VuoCompilerPublishedPort.cc.

◆ getGraphvizAttributes()

string VuoCompilerPublishedPort::getGraphvizAttributes ( void )

Returns a string representation of this published port's type and details, as they would appear in the attributes list of a published node declaration within a .vuo (Graphviz DOT format) file.

Definition at line 337 of file VuoCompilerPublishedPort.cc.