VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
makVrv::DtDisplayConfiguration Class Reference

This owns a list of window configurations. More...

Inheritance diagram for makVrv::DtDisplayConfiguration:
Inheritance graph
[legend]

Public Member Functions

 DtDisplayConfiguration (const std::string &name=DefaultDisplayString)
 CTOR.
 DtDisplayConfiguration (const DtDisplayConfiguration &copy)
 Copy CTOR.
DtDisplayConfigurationoperator= (const DtDisplayConfiguration &copy)
 Assignment Operator.
virtual ~DtDisplayConfiguration ()
 DTOR.
DT_DECLARE_ALL_serialize_FUNCTIONS
DtWindowConfigurations
windowConfigurations ()
 Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.
const DtWindowConfigurationswindowConfigurations () const
- Public Member Functions inherited from makVrv::DtConfiguration
 DtConfiguration (const std::string &name="")
 CTOR.
 DtConfiguration (const DtConfiguration &)
 Copy CTOR.
DtConfigurationoperator= (const DtConfiguration &)
 Assignment OP.
virtual ~DtConfiguration ()
 DTOR.
virtual const std::string & name () const
 Get the configuration name.
virtual void setName (const std::string &name)
 Set the configuration name.
virtual const std::string * findOptionalParameter (const std::string &name) const
 Find an optional parameters.
virtual void setOptionalParameter (const std::string &name, const std::string &value)
 Set an optional parameter.
virtual void setOptionalParameters (const ParameterMap &)
 Set an optional parameters.
virtual void removeOptionalParameter (const std::string &name)
 Remove an optional parameter.
const ParameterMapoptionalParameters () const
 Get the optional parameters.

Static Public Attributes

static const charDefaultDisplayString
 A static point to a string which is used as the default name for displays, "Display".

Protected Member Functions

template<class Archive >
void _serialize (Archive &ar, const unsigned int version)
 Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive example: fstream fo("test.xml",std;:ios_base::out); xml_oarchive os(fo); DtConfiguration aConfig; aConfig.serialize(os,0);.

Protected Attributes

DtWindowConfigurations myWindowConfigurations
- Protected Attributes inherited from makVrv::DtConfiguration
std::string myName
ParameterMap myOptionalParameters
DtProxyWP myAttachedInterface

Additional Inherited Members

- Public Types inherited from makVrv::DtConfiguration
typedef std::map< std::string,
std::string > 
ParameterMap

Detailed Description

This owns a list of window configurations.

Examples

You can use the –dispSetting command line argument and pass the .dcx file on the command line.

Or you can create a display configuration programtically (please see exampleConfiguration for how to do that).

If you want to load a .dcx programatically, you can use the following code:

const std::string& filename = "/wherever/myDisplayConfig/.dcx";
DtDisplayConfiguration displayConfig;
bool success = makArchives::DtXmlFileIo::read(filename,displayConfig,"DtDisplayConfiguration");
if(success)
{
appConfig.deConfiguration().displayConfigurations().add(displayConfig);
}
else
{
const std::string fileType = "Display Configuration File";
DtVrvApplication::handleFileError(filename, fileType);
}

Constructor & Destructor Documentation

makVrv::DtDisplayConfiguration::DtDisplayConfiguration ( const std::string &  name = DefaultDisplayString)

CTOR.

makVrv::DtDisplayConfiguration::DtDisplayConfiguration ( const DtDisplayConfiguration copy)

Copy CTOR.

virtual makVrv::DtDisplayConfiguration::~DtDisplayConfiguration ( )
virtual

DTOR.

Member Function Documentation

DtDisplayConfiguration& makVrv::DtDisplayConfiguration::operator= ( const DtDisplayConfiguration copy)

Assignment Operator.

DT_DECLARE_ALL_serialize_FUNCTIONS DtWindowConfigurations& makVrv::DtDisplayConfiguration::windowConfigurations ( )

Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.

Returns myWindowConfigurations.

const DtWindowConfigurations& makVrv::DtDisplayConfiguration::windowConfigurations ( ) const
template<class Archive >
void makVrv::DtDisplayConfiguration::_serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprotected

Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive example: fstream fo("test.xml",std;:ios_base::out); xml_oarchive os(fo); DtConfiguration aConfig; aConfig.serialize(os,0);.

Serialize this class.

Reimplemented from makVrv::DtConfiguration.

References DT_SERIALIZE_BASE, and DT_SERIALIZE_MEMBER.

Member Data Documentation

const char* makVrv::DtDisplayConfiguration::DefaultDisplayString
static

A static point to a string which is used as the default name for displays, "Display".

DtWindowConfigurations makVrv::DtDisplayConfiguration::myWindowConfigurations
protected

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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)