Open CASCADE Technology 6.6.0
Public Member Functions
Interface_FileParameter Class Reference

Auxiliary class to store a litteral parameter in a file
intermediate directory or in an UndefinedContent : a reference
type Parameter detains an Integer which is used to address a
record in the directory.
FileParameter is intended to be stored in a ParamSet : hence
memory management is performed by ParamSet, which calls Clear
to work, while the Destructor (see Destroy) does nothing.
Also a FileParameter can be read for consultation only, not to
be read from a Structure to be included into another one.

#include <Interface_FileParameter.hxx>

Public Member Functions

 Interface_FileParameter ()
void Init (const TCollection_AsciiString &val, const Interface_ParamType typ)
 Fills fields (with Entity Number set to zero)

void Init (const Standard_CString val, const Interface_ParamType typ)
 Same as above, but builds the Value from a CString

Standard_CString CValue () const
 Same as above, but as a CString (for immediate exploitation)
was C++ : return const

Interface_ParamType ParamType () const
 Returns the type of the parameter

void SetEntityNumber (const Standard_Integer num)
 Allows to set a reference to an Entity in a numbered list

Standard_Integer EntityNumber () const
 Returns value set by SetEntityNumber

void Clear ()
 Clears stored data : frees memory taken for the String Value

void Destroy ()
 Destructor. Does nothing because Memory is managed by ParamSet

 ~Interface_FileParameter ()

Constructor & Destructor Documentation

Interface_FileParameter::Interface_FileParameter ( )
Interface_FileParameter::~Interface_FileParameter ( ) [inline]

Member Function Documentation

void Interface_FileParameter::Clear ( )
Standard_CString Interface_FileParameter::CValue ( ) const
void Interface_FileParameter::Destroy ( )
Standard_Integer Interface_FileParameter::EntityNumber ( ) const
void Interface_FileParameter::Init ( const Standard_CString  val,
const Interface_ParamType  typ 
)
void Interface_FileParameter::Init ( const TCollection_AsciiString val,
const Interface_ParamType  typ 
)
Interface_ParamType Interface_FileParameter::ParamType ( ) const
void Interface_FileParameter::SetEntityNumber ( const Standard_Integer  num)

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines