All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Class ENOVCustoCommandUtils

ENOVCustoCommandUtils
 

Usage: you must use this class as is. You should never derive it.


public class ENOVCustoCommandUtils

Class ENOVCustoCommandUtils.
Role : This class contains utilities to get and set parameters involved in the client communication.


Constructor and Destructor Index


o ENOVCustoCommandUtils(CustomCommadDispatcher&)
nodoc
o ~ENOVCustoCommandUtils()

Method Index


o GetBooleanParameter(CATUnicodeString,boolean&)
Get a boolean values sent from the client.
o GetByteListParameter(CATUnicodeString,SEQUENCE(octet)*&)
Get a byte Array sent from the client.
o GetDoubleParameter(CATUnicodeString,double&)
Get a double values sent from the client.
o GetIntParameter(CATUnicodeString,int&)
Get an Integer value sent from the client.
o GetObjAttrAccessParameter(CATUnicodeString&,ENOVIObjectAttrAccess*&)
Get a object sent from the client.
o GetObjListParameter(CATUnicodeString,CATLISTV(CATIVpmFactoryObject_var)&)
Get a list of objects sent from the client.
o GetObjParameter(CATUnicodeString,CATIVpmFactoryObject_var&)
Get an object value sent from the client.
o GetStringParameter(CATUnicodeString&,CATUnicodeString&)
Get a CATUnicodeString values sent from the client.
o setResult(CATUnicodeString,CATIVpmFactoryObject_var)
Set a object the stream to return to the client.
o setResult(CATUnicodeString,CATLISTV(CATIVpmFactoryObject_var)&)
Set a list of objects the stream to return to the client.
o setResult(CATUnicodeString,CATUnicodeString)
Set a double value in the stream to return to the client.
o setResult(CATUnicodeString,SEQUENCE(octet)&)
Set a byte List to return to the client.
o setResult(CATUnicodeString,boolean)
Set a boolean value in the stream to return to the client.
o setResult(CATUnicodeString,double)
Set a double value in the stream to return to the client.
o setResult(CATUnicodeString,int)
Set a int value in the stream to return to the client.

Constructor and Destructor


o ENOVCustoCommandUtils
public ENOVCustoCommandUtils(CustomCommadDispatcher& currentCMD)
nodoc
o ~ENOVCustoCommandUtils
public ~ENOVCustoCommandUtils()

Methods


o GetBooleanParameter
public HRESULT GetBooleanParameter(CATUnicodeString outName,
boolean& outVal)
Get a boolean values sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetByteListParameter
public HRESULT GetByteListParameter(CATUnicodeString inName,
SEQUENCE(octet)*& outVal)
Get a byte Array sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetDoubleParameter
public HRESULT GetDoubleParameter(CATUnicodeString outName,
double& outVal)
Get a double values sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetIntParameter
public HRESULT GetIntParameter(CATUnicodeString outName,
int& outVal)
Get an Integer value sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetObjAttrAccessParameter
public HRESULT GetObjAttrAccessParameter( const CATUnicodeString& iParmName,
ENOVIObjectAttrAccess*& oAttrAccess)
Get a object sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the object sent from the client. Be sure to delete the returned value.
o GetObjListParameter
public HRESULT GetObjListParameter(CATUnicodeString inName,
CATLISTV(CATIVpmFactoryObject_var)& oFactObjList)
Get a list of objects sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetObjParameter
public HRESULT GetObjParameter(CATUnicodeString outName,
CATIVpmFactoryObject_var& oFactObj)
Get an object value sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetStringParameter
public HRESULT GetStringParameter( const CATUnicodeString& outName,
CATUnicodeString& outVal)
Get a CATUnicodeString values sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o setResult
public HRESULT setResult(CATUnicodeString inName,
CATIVpmFactoryObject_var inValue)
Set a object the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public HRESULT setResult(CATUnicodeString inName,
CATLISTV(CATIVpmFactoryObject_var)& oFactObjList)
Set a list of objects the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public HRESULT setResult(CATUnicodeString inName,
CATUnicodeString inValue)
Set a double value in the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public HRESULT setResult(CATUnicodeString inName,
SEQUENCE(octet)& inValue)
Set a byte List to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public HRESULT setResult(CATUnicodeString inName,
boolean inValue)
Set a boolean value in the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public HRESULT setResult(CATUnicodeString inName,
double inValue)
Set a double value in the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public HRESULT setResult(CATUnicodeString inName,
int inValue)
Set a int value in the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return

This object is included in the file: ENOVCustoCommandUtils.h
If needed, your Imakefile.mk should include the module: VDO0VPMSession

Copyright © 2003, Dassault Systèmes. All rights reserved.