Open CASCADE Technology  7.7.0.dev
Public Member Functions

Interface_FileParameter Class Reference

Auxiliary class to store a literal 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. More...

#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) More...
 
void Init (const Standard_CString val, const Interface_ParamType typ)
 Same as above, but builds the Value from a CString. More...
 
Standard_CString CValue () const
 Same as above, but as a CString (for immediate exploitation) was C++ : return const. More...
 
Interface_ParamType ParamType () const
 Returns the type of the parameter. More...
 
void SetEntityNumber (const Standard_Integer num)
 Allows to set a reference to an Entity in a numbered list. More...
 
Standard_Integer EntityNumber () const
 Returns value set by SetEntityNumber. More...
 
void Clear ()
 Clears stored data : frees memory taken for the String Value. More...
 
void Destroy ()
 Destructor. Does nothing because Memory is managed by ParamSet. More...
 
 ~Interface_FileParameter ()
 

Detailed Description

Auxiliary class to store a literal 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.

Constructor & Destructor Documentation

◆ Interface_FileParameter()

Interface_FileParameter::Interface_FileParameter ( )

◆ ~Interface_FileParameter()

Interface_FileParameter::~Interface_FileParameter ( )
inline

Member Function Documentation

◆ Clear()

void Interface_FileParameter::Clear ( )

Clears stored data : frees memory taken for the String Value.

◆ CValue()

Standard_CString Interface_FileParameter::CValue ( ) const

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

◆ Destroy()

void Interface_FileParameter::Destroy ( )

Destructor. Does nothing because Memory is managed by ParamSet.

◆ EntityNumber()

Standard_Integer Interface_FileParameter::EntityNumber ( ) const

Returns value set by SetEntityNumber.

◆ Init() [1/2]

void Interface_FileParameter::Init ( const Standard_CString  val,
const Interface_ParamType  typ 
)

Same as above, but builds the Value from a CString.

◆ Init() [2/2]

void Interface_FileParameter::Init ( const TCollection_AsciiString val,
const Interface_ParamType  typ 
)

Fills fields (with Entity Number set to zero)

◆ ParamType()

Interface_ParamType Interface_FileParameter::ParamType ( ) const

Returns the type of the parameter.

◆ SetEntityNumber()

void Interface_FileParameter::SetEntityNumber ( const Standard_Integer  num)

Allows to set a reference to an Entity in a numbered list.


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