DtPlanVariableSubstitutor Class Reference

Public Member Functions
	DtPlanVariableSubstitutor (DtVrfObject *)
virtual	~DtPlanVariableSubstitutor ()
virtual std::vector < DtReaderWriter * >	substituteVariablesIn (const DtRwVariableBindings &, DtReaderWriter *) const
	Iterates over all items in the reader writer registry of the supplied item, and, if any of the variables are UUIDs and they happen to match the UUID of the simulation object or created object variable, those values in the reader/writer supplied will be set to those of the variable.
virtual std::vector < DtReaderWriter * >	substitutedValues (const DtRwVariableBindings &, const DtReaderWriter *) const
	Returns a vector list of reader/writer values (cloned from the source) that were substituted. The results of this call must be freed by the user.
virtual bool	subsituteUUIDIfAvailable (const DtRwVariableBindings &, const DtReaderWriter *, DtUUID &uuid) const
	If, in the supplied reader/writer there is a matching UUID to substitute, place the resultant value in the givem UUID and return true.

Protected Member Functions
virtual std::vector < DtReaderWriter * >	substitutedValues (const DtRwVariableBindings &, DtReaderWriter *, bool clone) const
	The results of this call must be freed by the caller if clone is true.
virtual void	substituteVariablesIn (boost::unordered_map< DtUUID, const DtRwPlanSimulationObject * > &, DtReaderWriter *, bool clone, std::vector< DtReaderWriter * > &replaced) const
	Substitute any variables found in the reader/writer registry. Will recurse for variables of type variable bindings.

Protected Attributes
DtVrfObject *	myVrfObject

Private Member Functions
	DtPlanVariableSubstitutor (const DtPlanVariableSubstitutor &orig)
	Not implemented.
DtPlanVariableSubstitutor &	operator= (const DtPlanVariableSubstitutor &orig)
	Not implemented.

Constructor & Destructor Documentation

DtPlanVariableSubstitutor::DtPlanVariableSubstitutor ( const DtPlanVariableSubstitutor &  orig )

private

Not implemented.

DtPlanVariableSubstitutor::DtPlanVariableSubstitutor

(

DtVrfObject *

)

virtual DtPlanVariableSubstitutor::~DtPlanVariableSubstitutor ( )

virtual

Member Function Documentation

DtPlanVariableSubstitutor& DtPlanVariableSubstitutor::operator= ( const DtPlanVariableSubstitutor &  orig )

private

Not implemented.

virtual std::vector<DtReaderWriter*> DtPlanVariableSubstitutor::substituteVariablesIn ( const DtRwVariableBindings &  , DtReaderWriter *    ) const

virtual

Iterates over all items in the reader writer registry of the supplied item, and, if any of the variables are UUIDs and they happen to match the UUID of the simulation object or created object variable, those values in the reader/writer supplied will be set to those of the variable.

This call will return the values that were substituted. Do not delete the returned memory as this is the reader/writer value as it exists

virtual std::vector<DtReaderWriter*> DtPlanVariableSubstitutor::substitutedValues ( const DtRwVariableBindings &  , const DtReaderWriter *    ) const

virtual

Returns a vector list of reader/writer values (cloned from the source) that were substituted. The results of this call must be freed by the user.

virtual bool DtPlanVariableSubstitutor::subsituteUUIDIfAvailable ( const DtRwVariableBindings &  , const DtReaderWriter *  , DtUUID &  uuid  ) const

virtual

If, in the supplied reader/writer there is a matching UUID to substitute, place the resultant value in the givem UUID and return true.

virtual std::vector<DtReaderWriter*> DtPlanVariableSubstitutor::substitutedValues ( const DtRwVariableBindings &  , DtReaderWriter *  , bool  clone  ) const

protectedvirtual

The results of this call must be freed by the caller if clone is true.

If clone is true they will not be substituted inline with the supplied reader/writer. This class only supports UUIDs.

virtual void DtPlanVariableSubstitutor::substituteVariablesIn ( boost::unordered_map< DtUUID, const DtRwPlanSimulationObject * > &  , DtReaderWriter *  , bool  clone, std::vector< DtReaderWriter * > &  replaced  ) const

protectedvirtual

Substitute any variables found in the reader/writer registry. Will recurse for variables of type variable bindings.

Member Data Documentation

DtVrfObject* DtPlanVariableSubstitutor::myVrfObject

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfutil/planVariableSubstitutor.h