ClassTemplate_v1 Class Reference

A short description of the class. More...

Inherits unit.

Public Member Functions
function	ClassTemplate_v1 (in param)
	Class constructor. More...
function	traverse (in obj, in in)
	Brief description of what the traverse function does. More...
Public Member Functions inherited from unit
function	traverseNode (in obj)
	Set unique ID when creating a unit. More...
function	connectOutput (in obj, in uobj, in unitOutput, in nextUnitInput)
	Specify where signal should go next. More...
function	connectOutputs (in obj, in units, in destInputs)
	Specify where signal should go next. More...
function	writeInputBuffer (in obj, in sig, in inputId)
	write input buffer
function	horzcat (in varargin)
	horizontal concatenation
function	vertcat (in varargin)
	vertical concatenation
function	setparams (in obj, in params, in REQUIRED_PARAMS, in QUIET_PARAMS)
	set parameters More...
function	view (in obj)
	Show interactive GUI through unit_view-class.

Public Attributes
Property	param1
	Description of param1 [measurment unit]. (Don't say anything about default values, they go in the constructor)
Property	param2
	Description of param2 [measurment unit]. (Parameters should start in lower case).
Property	param3Enabled
	Description of param3Enabled which is a flag that can take values true or false. Append the Enabled suffix.
Property	nInputs
	Number of inputs.
Property	nOutputs
	Number of outputs.
Property	myProp
	Internal variables that shuld not be set by the user.
Public Attributes inherited from unit
Property	inputBuffer
	Buffer for storing inputs as we traverse the graph.
Property	nextNodes
	Children nodes.
Property	destInputs
	Destination inputs in children.
Property	results
	For storing results.
Property	label
Property	draw
	enable/disable plotting
Property	nInputs
	Number of signals traverse expects.
Property	nOutputs
	Number of outputs traverse expects.

Detailed Description

A short description of the class.

{||||||}

This unit is based on the model described in [1, section 2]. A longer description of the class, with all the details required which spans multiple lines A longer description of the class, with all the details required which spans multiple lines A longer description of the class, with all the details required which spans multiple lines

Observations

1. First observation
2. Second observation

Conventions

• First convention
• Second convention

Example

% Here we put a FULLY WORKING example using the MINIMUM set of required parameters
param.classtemp.param1      = 2;

clTemp = ClassTemplate_v1(param.classtemp);

param.sig.L = 10e6;
param.sig.Fs = 64e9;
param.sig.Fc = 193.1e12;
param.sig.Rs = 10e9;
param.sig.PCol = [pwr(20,{-2,'dBm'}), pwr(-inf,{-inf,'dBm'})];
sIn = createDummySignal();

sigOut = clTemp.traverse(sIn);

Advanced Example (Optional)

% Here we put a FULLY WORKING example using a more extended set of parametersedit 
param.classtemp.param1      = 2;
param.classtemp.param2      = 'test';
param.classtemp.param3      = false;

clTemp = ClassTemplate_v1(param.classtemp);

param.sig.Fs = 64e9;
param.sig.Fc = 193.1e12;
param.sig.Rs = 10e9;
param.sig.PCol = [pwr(20,{-2,'dBm'}), pwr(-inf,{-inf,'dBm'})];
Ein = rand(1000,2);
sIn = signal_interface(Ein, param.sig);

sigOut = clTemp.traverse(sIn);

References

• [1] First formatted reference
• [2] Second formatted reference

Author

Author 1

Author 2

Version

1

Definition at line 72 of file ClassTemplate_v1.m.

Constructor & Destructor Documentation

function ClassTemplate_v1::ClassTemplate_v1

(

in

param

)

Class constructor.

Constructs an object of type ClassTemplate_v1 and more information.. Don't put example here, since we have it in the description..

Parameters

param.param1	Description of param1 (Start description sentence with capital letter) [unit]. [Default: Value]
param.param2	Description of param2 (Start description sentence with capital letter) [unit].
param.param3Enabled	Description of a flag to enable or disable something. [Default: Value]

Return values

obj	An instance of the class ClassTemplate_v1

Member Function Documentation

function ClassTemplate_v1::traverse ( in  obj, in  in  )

virtual

Brief description of what the traverse function does.

Parameters

in	The signal_interface of the input signal that...

Return values

out	The signal_interface of the signal which has been...

Reimplemented from unit.

---

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

• library/demo/ClassTemplate_v1.m