Acoustic Research Tool (ART)  v0.10
ARTItimeModule::IPortType Class Reference

This class represents all input ports of time modules and actually refers to an existing output/function port.

An input port can only point to a single output port whereas an output port can be referenced by multiple input ports.

Inheritance diagram for ARTItimeModule::IPortType:
ARTItimeModule::PortType ARTItimeModule::timeProperty ARTdataProp ARTproperty ARTdataContainer ARTcell

Public Member Functions

 IPortType (const string &name, const OPortType *refPort)
 Constructor of the IPortType class.
virtual const Variable & GetParserVar ()
 Returns the variable object of the referenced output port.
virtual const Variable & GetParserVar () const
 Returns the constant variable object of the referenced output port.
virtual ~IPortType ()
 Destructor of the IPortType class.
- Public Member Functions inherited from ARTItimeModule::PortType
 PortType (const T_ART_Type dtyp, const int dlen, const string &name, const string sds="", const string lds="", const string htm="")
 Constructor of the PortType class.
virtual ~PortType ()
 Destructor of the PortType class.
- Public Member Functions inherited from ARTItimeModule::timeProperty
 timeProperty (const T_ART_Type dtyp, const int dlen, const string &name, const string sds="", const string lds="", const string htm="")
 Constructor of the timeProperty class.
virtual ~timeProperty ()
 Destructor of the timeProperty class.
- Public Member Functions inherited from ARTdataProp
 ARTdataProp (const T_ART_Type dtyp, const int dlen, const string name, const string sds="", const string lds="", const string htm="")
 ARTdataProp (const ARTdataProp &orig)
 copy constructor
ARTvariant * GetRange ()
void SetRange (ARTvariant *r)
virtual ARTcellclone ()
- Public Member Functions inherited from ARTproperty
 ARTproperty (const string name, const string sds="", const string lds="", const string htm="", const bool listable=false)
 ARTproperty (const ARTproperty &orig)
bool IsListable ()
- Public Member Functions inherited from ARTcell
 ARTcell (const string name="", const string sds="", const string lds="", const string htm="")
 ARTcell (const ARTcell &orig)
const string & GetName () const
const string & GetShortDescription () const
const string & GetLongDescription () const
const string & GetHelpFilename () const
void SetName (const string name)
- Public Member Functions inherited from ARTdataContainer
void EvaluateIfInvalid ()
void DebugDepTree (const string intend, const string linebreak="\n")
 Just for debugging: to print the dependency tree...
string WriteDepTree (const string intend, const string linebreak="\n")
 ARTdataContainer ()
 default constructor
 ARTdataContainer (const T_ART_Type dtyp, const int dlen, const string varname="")
 ARTdataContainer (std::string name, ARTfunctionoid *func=NULL)
 ARTdataContainer (const int i)
 ARTdataContainer (const double d)
 ARTdataContainer (const float f)
 ARTdataContainer (const char *s)
 ARTdataContainer (const char *s1, const char *s2)
 ARTdataContainer (const char *s1, const char *s2, const char *s3)
 ARTdataContainer (const char *s1, const char *s2, const char *s3, const char *s4)
 ARTdataContainer (const ARTdataContainer &orig)
 copy constructor
T_ART_Type GetDatatype ()
int GetCount ()
int GetIterationNumber ()
double GetComplexity ()
 This function is not used right now.
T_ART_Var * GetValue ()
bool IsValid ()
int GetInt ()
const string & GetDefinition ()
void SetValue (ARTvariant *var)
 direct change of data value (ignore definition string); set value pointer and force value to be valid.
virtual void SetVal (const int i, const int ind=0)
virtual void SetVal (const double d, const int ind=0)
virtual void SetVal (const float f, const int ind=0)
virtual void SetVal (std::complex< double >, const int ind=0)
virtual void SetVal (const double re, const double im, const int ind=0)
virtual void SetVal (const char *s)
virtual void SetVal (const char *s, int ind)
void Invalidate ()
 mark value as invalid and invalidate all dependent data containers
void NotifyClients ()
 invalidate all dependent data containers
int GetEvaluationCost ()
void AddDependency (ARTdataContainer *dependency)
 Observe AND be notified.
void RemoveAllDependencies ()
void AddPropertiesAsDependency (ARTobject *obj)
 Add all data properties of the ARTobject pointed to by obj as dependencies.
void DoNotNotify (ARTdataContainer *client)
void RemoveDependency (ARTdataContainer *dependency)
void RemoveFromDefinition (ARTdataContainer *dependency)
void SetParser (ParserX *p)
virtual ParserX * GetParser ()
virtual ARTdataContainerGetParent ()
void Rename (const string &newname)
void SetParserVar (const string &varname)
void DestroyParserVar ()
string GetVarName () const
void SetDefinition (const string &s, ARTsimulator *scope)
void SetDefinition (const string &s)
void RedoDefinitionDependencies ()
void ResetEvaluation ()
 This function sets the flags of this data container and all dependencies to the value indicating that no evaluation is taking place.
void SetScope (ARTsimulator *sim)
ARTsimulatorGetScope ()
void SetFunction (ARTfunctionoid *func)
string DebugInfo ()
list< ARTdataContainer * > GetClientList ()
bool CheckValidity ()
ARTdataContainerGetArrayElement (int idx)
void SetCurrentIndex (int idx)
void SetParentModuleName (const string &name)
const string & GetParentModuleName () const
void deleteVar ()
 Array constructor.
virtual IValue & operator[] (std::size_t idx)
virtual IValue & operator[] (int idx)
virtual IValue & operator= (int_type a_iVal)
virtual IValue & operator= (float_type a_fVal)
virtual IValue & operator= (string_type a_sVal)
virtual IValue & operator= (bool val)
virtual IValue & operator= (const array_type &a_vVal)
virtual IValue & operator= (const cmplx_type &val)
virtual IValue & operator= (const char_type *a_szVal)
virtual char_type GetType () const
virtual float_type GetFloat () const
virtual float_type GetImag () const
virtual bool GetBool () const
virtual const cmplx_type & GetComplex () const
virtual const string_type & GetString () const
virtual const array_type & GetArray () const
virtual bool IsVolatile () const
virtual IToken * Clone () const
virtual Value * AsValue ()
virtual IValue * AsIValue ()

Protected Attributes

const OPortTyperefPort_
 Pointer to the existing output port.

Additional Inherited Members

- Static Public Attributes inherited from ARTdataContainer
static ARTprogressIndicator progressIndicator = ARTprogressIndicator(NULL,0)
- Protected Member Functions inherited from ARTdataContainer
void SetCountedFlag (bool b)
 Description.
virtual int EvaluationCost ()
virtual void Evaluate () const
void AddNotify (ARTdataContainer *client)
 Add a new client to this dataContainer.
virtual void resizeArray (int newSize)
 Resizes the used array in case the current data container is of type C_ART_na.

Constructor & Destructor Documentation

ARTItimeModule::IPortType::IPortType ( const string &  name,
const OPortType refPort 
)

Constructor of the IPortType class.

Parameters
[in]nameIdentifier of the input port.
[in]refPortOutput or function port which will be referenced by the current input port.

Member Data Documentation

const OPortType* ARTItimeModule::IPortType::refPort_
protected

Pointer to the existing output port.